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