diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlsLookup.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs
similarity index 99%
rename from src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlsLookup.g.cs
rename to src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs
index 3969e65f34c..2d68d7927b3 100644
--- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlsLookup.g.cs
+++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs
@@ -15,8 +15,11 @@
//
// ------------------------------------------------
+#nullable restore
+
namespace Elastic.Clients.Elasticsearch.Requests;
-internal static class ApiUrlsLookups
+
+internal static class ApiUrlLookup
{
internal static ApiUrls AsyncSearchStatus = new ApiUrls(new[] { "/_async_search/status/{id}" });
internal static ApiUrls AsyncSearchDelete = new ApiUrls(new[] { "/_async_search/{id}" });
diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs
index eba1ac2d5a5..007f546ab98 100644
--- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs
+++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs
@@ -15,6 +15,8 @@
//
// ------------------------------------------------
+#nullable restore
+
using Elastic.Clients.Elasticsearch.Fluent;
using Elastic.Clients.Elasticsearch.Requests;
using Elastic.Clients.Elasticsearch.Serialization;
@@ -25,26 +27,35 @@
using System.Text.Json;
using System.Text.Json.Serialization;
-#nullable restore
namespace Elastic.Clients.Elasticsearch.AsyncSearch;
+
public sealed class AsyncSearchStatusRequestParameters : RequestParameters
{
}
+///
+/// Retrieves the status of a previously submitted async search request given its ID.
+///
public sealed partial class AsyncSearchStatusRequest : PlainRequest
{
public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
{
}
- internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchStatus;
+ internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchStatus;
+
protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
+
internal override bool SupportsBody => false;
}
+///
+/// Retrieves the status of a previously submitted async search request given its ID.
+///
public sealed partial class AsyncSearchStatusRequestDescriptor : RequestDescriptor, AsyncSearchStatusRequestParameters>
{
internal AsyncSearchStatusRequestDescriptor(Action> configure) => configure.Invoke(this);
+
public AsyncSearchStatusRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
{
}
@@ -53,9 +64,12 @@ internal AsyncSearchStatusRequestDescriptor()
{
}
- internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchStatus;
+ internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchStatus;
+
protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
+
internal override bool SupportsBody => false;
+
public AsyncSearchStatusRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id)
{
RouteValues.Required("id", id);
@@ -67,9 +81,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
}
}
+///
+/// Retrieves the status of a previously submitted async search request given its ID.
+///
public sealed partial class AsyncSearchStatusRequestDescriptor : RequestDescriptor
{
internal AsyncSearchStatusRequestDescriptor(Action configure) => configure.Invoke(this);
+
public AsyncSearchStatusRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
{
}
@@ -78,9 +96,12 @@ internal AsyncSearchStatusRequestDescriptor()
{
}
- internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchStatus;
+ internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchStatus;
+
protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
+
internal override bool SupportsBody => false;
+
public AsyncSearchStatusRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id)
{
RouteValues.Required("id", id);
diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs
index e78764894e5..919368c258a 100644
--- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs
+++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs
@@ -15,6 +15,8 @@
//
// ------------------------------------------------
+#nullable restore
+
using Elastic.Clients.Elasticsearch.Fluent;
using Elastic.Clients.Elasticsearch.Serialization;
using Elastic.Transport.Products.Elasticsearch;
@@ -22,34 +24,26 @@
using System.Collections.Generic;
using System.Text.Json.Serialization;
-#nullable restore
namespace Elastic.Clients.Elasticsearch.AsyncSearch;
+
public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse
{
[JsonInclude, JsonPropertyName("completion_status")]
public int? CompletionStatus { get; init; }
-
[JsonInclude, JsonPropertyName("expiration_time")]
public DateTimeOffset? ExpirationTime { get; init; }
-
[JsonInclude, JsonPropertyName("expiration_time_in_millis")]
public long ExpirationTimeInMillis { get; init; }
-
[JsonInclude, JsonPropertyName("id")]
public string? Id { get; init; }
-
[JsonInclude, JsonPropertyName("is_partial")]
public bool IsPartial { get; init; }
-
[JsonInclude, JsonPropertyName("is_running")]
public bool IsRunning { get; init; }
-
[JsonInclude, JsonPropertyName("_shards")]
public Elastic.Clients.Elasticsearch.ShardStatistics Shards { get; init; }
-
[JsonInclude, JsonPropertyName("start_time")]
public DateTimeOffset? StartTime { get; init; }
-
[JsonInclude, JsonPropertyName("start_time_in_millis")]
public long StartTimeInMillis { get; init; }
}
\ No newline at end of file
diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs
index f57f61ec652..13eda4f39f2 100644
--- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs
+++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs
@@ -15,6 +15,8 @@
//
// ------------------------------------------------
+#nullable restore
+
using Elastic.Clients.Elasticsearch.Fluent;
using Elastic.Clients.Elasticsearch.Requests;
using Elastic.Clients.Elasticsearch.Serialization;
@@ -25,26 +27,35 @@
using System.Text.Json;
using System.Text.Json.Serialization;
-#nullable restore
namespace Elastic.Clients.Elasticsearch.AsyncSearch;
+
public sealed class DeleteAsyncSearchRequestParameters : RequestParameters
{
}
+///
+/// Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.
+///
public sealed partial class DeleteAsyncSearchRequest : PlainRequest
{
public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
{
}
- internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchDelete;
+ internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchDelete;
+
protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE;
+
internal override bool SupportsBody => false;
}
+///
+/// Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.
+///
public sealed partial class DeleteAsyncSearchRequestDescriptor : RequestDescriptor, DeleteAsyncSearchRequestParameters>
{
internal DeleteAsyncSearchRequestDescriptor(Action> configure) => configure.Invoke(this);
+
public DeleteAsyncSearchRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
{
}
@@ -53,9 +64,12 @@ internal DeleteAsyncSearchRequestDescriptor()
{
}
- internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchDelete;
+ internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchDelete;
+
protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE;
+
internal override bool SupportsBody => false;
+
public DeleteAsyncSearchRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id)
{
RouteValues.Required("id", id);
@@ -67,9 +81,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
}
}
+///
+/// Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.
+///
public sealed partial class DeleteAsyncSearchRequestDescriptor : RequestDescriptor
{
internal DeleteAsyncSearchRequestDescriptor(Action configure) => configure.Invoke(this);
+
public DeleteAsyncSearchRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
{
}
@@ -78,9 +96,12 @@ internal DeleteAsyncSearchRequestDescriptor()
{
}
- internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchDelete;
+ internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchDelete;
+
protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE;
+
internal override bool SupportsBody => false;
+
public DeleteAsyncSearchRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id)
{
RouteValues.Required("id", id);
diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs
index af8976df219..53ede513868 100644
--- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs
+++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs
@@ -15,16 +15,21 @@
//
// ------------------------------------------------
+#nullable restore
+
using Elastic.Clients.Elasticsearch.Fluent;
using Elastic.Clients.Elasticsearch.Serialization;
using Elastic.Transport.Products.Elasticsearch;
using System.Collections.Generic;
using System.Text.Json.Serialization;
-#nullable restore
namespace Elastic.Clients.Elasticsearch.AsyncSearch;
+
public sealed partial class DeleteAsyncSearchResponse : ElasticsearchResponse
{
+ ///
+ /// For a successful response, this value is always true. On failure, an exception is returned instead.
+ ///
[JsonInclude, JsonPropertyName("acknowledged")]
public bool Acknowledged { get; init; }
}
\ No newline at end of file
diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs
index 50839575db4..63882aa0d61 100644
--- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs
+++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs
@@ -15,6 +15,8 @@
//
// ------------------------------------------------
+#nullable restore
+
using Elastic.Clients.Elasticsearch.Fluent;
using Elastic.Clients.Elasticsearch.Requests;
using Elastic.Clients.Elasticsearch.Serialization;
@@ -25,42 +27,67 @@
using System.Text.Json;
using System.Text.Json.Serialization;
-#nullable restore
namespace Elastic.Clients.Elasticsearch.AsyncSearch;
+
public sealed class GetAsyncSearchRequestParameters : RequestParameters
{
- [JsonIgnore]
+ ///
+ /// Specify the time interval in which the results (partial or final) for this search will be available
+ ///
public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); }
- [JsonIgnore]
+ ///
+ /// 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); }
- [JsonIgnore]
+ ///
+ /// Specify the time that the request should block waiting for the final response
+ ///
public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); }
}
+///
+/// Retrieves the results of a previously submitted async search request given its ID.
+///
public sealed partial class GetAsyncSearchRequest : PlainRequest
{
public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
{
}
- internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchGet;
+ internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchGet;
+
protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
+
internal override bool SupportsBody => false;
+
+ ///
+ /// Specify the time interval in which the results (partial or final) for this search will be available
+ ///
[JsonIgnore]
public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); }
+ ///
+ /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response
+ ///
[JsonIgnore]
public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); }
+ ///
+ /// Specify the time that the request should block waiting for the final response
+ ///
[JsonIgnore]
public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); }
}
+///
+/// Retrieves the results of a previously submitted async search request given its ID.
+///
public sealed partial class GetAsyncSearchRequestDescriptor : RequestDescriptor, GetAsyncSearchRequestParameters>
{
internal GetAsyncSearchRequestDescriptor(Action> configure) => configure.Invoke(this);
+
public GetAsyncSearchRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
{
}
@@ -69,12 +96,16 @@ internal GetAsyncSearchRequestDescriptor()
{
}
- internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchGet;
+ internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchGet;
+
protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
+
internal override bool SupportsBody => false;
+
public GetAsyncSearchRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration? keepAlive) => Qs("keep_alive", keepAlive);
public GetAsyncSearchRequestDescriptor TypedKeys(bool? typedKeys = true) => Qs("typed_keys", typedKeys);
public GetAsyncSearchRequestDescriptor WaitForCompletionTimeout(Elastic.Clients.Elasticsearch.Duration? waitForCompletionTimeout) => Qs("wait_for_completion_timeout", waitForCompletionTimeout);
+
public GetAsyncSearchRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id)
{
RouteValues.Required("id", id);
@@ -86,9 +117,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
}
}
+///
+/// Retrieves the results of a previously submitted async search request given its ID.
+///
public sealed partial class GetAsyncSearchRequestDescriptor : RequestDescriptor
{
internal GetAsyncSearchRequestDescriptor(Action configure) => configure.Invoke(this);
+
public GetAsyncSearchRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
{
}
@@ -97,12 +132,16 @@ internal GetAsyncSearchRequestDescriptor()
{
}
- internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchGet;
+ internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchGet;
+
protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
+
internal override bool SupportsBody => false;
+
public GetAsyncSearchRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration? keepAlive) => Qs("keep_alive", keepAlive);
public GetAsyncSearchRequestDescriptor TypedKeys(bool? typedKeys = true) => Qs("typed_keys", typedKeys);
public GetAsyncSearchRequestDescriptor WaitForCompletionTimeout(Elastic.Clients.Elasticsearch.Duration? waitForCompletionTimeout) => Qs("wait_for_completion_timeout", waitForCompletionTimeout);
+
public GetAsyncSearchRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id)
{
RouteValues.Required("id", id);
diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs
index 4b931d8f0c8..92e32556c43 100644
--- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs
+++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs
@@ -15,6 +15,8 @@
//
// ------------------------------------------------
+#nullable restore
+
using Elastic.Clients.Elasticsearch.Fluent;
using Elastic.Clients.Elasticsearch.Serialization;
using Elastic.Transport.Products.Elasticsearch;
@@ -22,31 +24,24 @@
using System.Collections.Generic;
using System.Text.Json.Serialization;
-#nullable restore
namespace Elastic.Clients.Elasticsearch.AsyncSearch;
+
public sealed partial class GetAsyncSearchResponse : ElasticsearchResponse
{
[JsonInclude, JsonPropertyName("expiration_time")]
public DateTimeOffset? ExpirationTime { get; init; }
-
[JsonInclude, JsonPropertyName("expiration_time_in_millis")]
public long ExpirationTimeInMillis { get; init; }
-
[JsonInclude, JsonPropertyName("id")]
public string? Id { get; init; }
-
[JsonInclude, JsonPropertyName("is_partial")]
public bool IsPartial { get; init; }
-
[JsonInclude, JsonPropertyName("is_running")]
public bool IsRunning { get; init; }
-
[JsonInclude, JsonPropertyName("response")]
public Elastic.Clients.Elasticsearch.AsyncSearch.AsyncSearch Response { get; init; }
-
[JsonInclude, JsonPropertyName("start_time")]
public DateTimeOffset? StartTime { get; init; }
-
[JsonInclude, JsonPropertyName("start_time_in_millis")]
public long StartTimeInMillis { get; init; }
}
\ No newline at end of file
diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs
index 466898be79f..466ffc6c9d5 100644
--- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs
+++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs
@@ -15,6 +15,8 @@
//
// ------------------------------------------------
+#nullable restore
+
using Elastic.Clients.Elasticsearch.Fluent;
using Elastic.Clients.Elasticsearch.Requests;
using Elastic.Clients.Elasticsearch.Serialization;
@@ -25,104 +27,148 @@
using System.Text.Json;
using System.Text.Json.Serialization;
-#nullable restore
namespace Elastic.Clients.Elasticsearch.AsyncSearch;
+
public sealed class SubmitAsyncSearchRequestParameters : RequestParameters
{
- [JsonIgnore]
+ ///
+ /// Specify the time that the request should block waiting for the final response
+ ///
public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); }
- [JsonIgnore]
+ ///
+ /// Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)
+ ///
public bool? KeepOnCompletion { get => Q("keep_on_completion"); set => Q("keep_on_completion", value); }
- [JsonIgnore]
+ ///
+ /// Update the time interval in which the results (partial or final) for this search will be available
+ ///
public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); }
- [JsonIgnore]
+ ///
+ /// 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); }
- [JsonIgnore]
+ ///
+ /// 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); }
- [JsonIgnore]
+ ///
+ /// The analyzer to use for the query string
+ ///
public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); }
- [JsonIgnore]
+ ///
+ /// Specify whether wildcard and prefix queries should be analyzed (default: false)
+ ///
public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); }
- [JsonIgnore]
+ ///
+ /// The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.
+ ///
public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", value); }
-
- [JsonIgnore]
public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); }
- [JsonIgnore]
+ ///
+ /// The default operator for query string query (AND or OR)
+ ///
public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); }
- [JsonIgnore]
+ ///
+ /// 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); }
- [JsonIgnore]
+ ///
+ /// 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); }
- [JsonIgnore]
+ ///
+ /// Whether specified concrete, expanded or aliased indices should be ignored when throttled
+ ///
public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); }
- [JsonIgnore]
+ ///
+ /// Whether specified concrete indices should be ignored when unavailable (missing or closed)
+ ///
public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); }
- [JsonIgnore]
+ ///
+ /// 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); }
- [JsonIgnore]
+ ///
+ /// 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); }
-
- [JsonIgnore]
public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); }
- [JsonIgnore]
+ ///
+ /// Specify the node or shard the operation should be performed on (default: random)
+ ///
public string? Preference { get => Q("preference"); set => Q("preference", value); }
-
- [JsonIgnore]
public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); }
- [JsonIgnore]
+ ///
+ /// 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); }
- [JsonIgnore]
+ ///
+ /// A comma-separated list of specific routing values
+ ///
public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); }
-
- [JsonIgnore]
public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); }
- [JsonIgnore]
+ ///
+ /// Search operation type
+ ///
public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); }
- [JsonIgnore]
+ ///
+ /// Specifies which field to use for suggestions.
+ ///
public Elastic.Clients.Elasticsearch.Field? SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); }
- [JsonIgnore]
+ ///
+ /// Specify suggest mode
+ ///
public Elastic.Clients.Elasticsearch.SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); }
- [JsonIgnore]
+ ///
+ /// How many suggestions to return in response
+ ///
public long? SuggestSize { get => Q("suggest_size"); set => Q("suggest_size", value); }
- [JsonIgnore]
+ ///
+ /// The source text for which the suggestions should be returned.
+ ///
public string? SuggestText { get => Q("suggest_text"); set => Q("suggest_text", value); }
- [JsonIgnore]
+ ///
+ /// 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); }
-
- [JsonIgnore]
public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); }
- [JsonIgnore]
+ ///
+ /// A list of fields to exclude from the returned _source field
+ ///
public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); }
- [JsonIgnore]
+ ///
+ /// A list of fields to extract and return from the _source field
+ ///
public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); }
- [JsonIgnore]
+ ///
+ /// Query in the Lucene query string syntax
+ ///
public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); }
}
@@ -535,6 +581,9 @@ public override void Write(Utf8JsonWriter writer, SubmitAsyncSearchRequest value
}
[JsonConverter(typeof(SubmitAsyncSearchRequestConverter))]
+///
+/// Executes a search request asynchronously.
+///
public sealed partial class SubmitAsyncSearchRequest : PlainRequest
{
public SubmitAsyncSearchRequest()
@@ -545,212 +594,354 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices)
{
}
- internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchSubmit;
+ internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchSubmit;
+
protected override HttpMethod StaticHttpMethod => HttpMethod.POST;
+
internal override bool SupportsBody => true;
+
+ ///
+ /// Specify the time that the request should block waiting for the final response
+ ///
[JsonIgnore]
public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); }
+ ///
+ /// Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)
+ ///
[JsonIgnore]
public bool? KeepOnCompletion { get => Q("keep_on_completion"); set => Q("keep_on_completion", value); }
+ ///
+ /// Update the time interval in which the results (partial or final) for this search will be available
+ ///
[JsonIgnore]
public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); }
+ ///
+ /// 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
+ ///
[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
+ ///
[JsonIgnore]
public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); }
+ ///
+ /// Specify whether wildcard and prefix queries should be analyzed (default: false)
+ ///
[JsonIgnore]
public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); }
+ ///
+ /// The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.
+ ///
[JsonIgnore]
public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", 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)
+ ///
[JsonIgnore]
public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); }
+ ///
+ /// The field to use as default where no field prefix is given in the query string
+ ///
[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.
+ ///
[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
+ ///
[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)
+ ///
[JsonIgnore]
public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); }
+ ///
+ /// 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
+ ///
[JsonIgnore]
public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); }
-
[JsonIgnore]
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)
+ ///
[JsonIgnore]
public string? Preference { get => Q("preference"); set => Q("preference", value); }
-
[JsonIgnore]
public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); }
+ ///
+ /// 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); }
+ ///
+ /// A comma-separated list of specific routing values
+ ///
[JsonIgnore]
public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); }
-
[JsonIgnore]
public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); }
+ ///
+ /// Search operation type
+ ///
[JsonIgnore]
public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); }
+ ///
+ /// Specifies which field to use for suggestions.
+ ///
[JsonIgnore]
public Elastic.Clients.Elasticsearch.Field? SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); }
+ ///
+ /// Specify suggest mode
+ ///
[JsonIgnore]
public Elastic.Clients.Elasticsearch.SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); }
+ ///
+ /// 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.
+ ///
[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
+ ///
[JsonIgnore]
public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); }
-
[JsonIgnore]
public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); }
+ ///
+ /// A list of fields to exclude from the returned _source field
+ ///
[JsonIgnore]
public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); }
+ ///
+ /// A list of fields to extract and return from the _source field
+ ///
[JsonIgnore]
public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); }
+ ///
+ /// Query in the Lucene query string syntax
+ ///
[JsonIgnore]
public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); }
-
[JsonInclude, JsonPropertyName("aggregations")]
public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; }
-
[JsonInclude, JsonPropertyName("collapse")]
public Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? Collapse { get; set; }
+ ///
+ /// 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.
+ ///
[JsonInclude, JsonPropertyName("ext")]
public IDictionary? Ext { 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.
+ ///
[JsonInclude, JsonPropertyName("from")]
public int? From { get; set; }
-
[JsonInclude, JsonPropertyName("highlight")]
public Elastic.Clients.Elasticsearch.Core.Search.Highlight? Highlight { 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.
+ ///
[JsonInclude, JsonPropertyName("track_total_hits")]
public Elastic.Clients.Elasticsearch.Core.Search.TrackHits? TrackTotalHits { get; set; }
+ ///
+ /// Boosts the _score of documents from specified indices.
+ ///
[JsonInclude, JsonPropertyName("indices_boost")]
public ICollection>? IndicesBoost { 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.
+ ///
[JsonInclude, JsonPropertyName("docvalue_fields")]
public ICollection? DocvalueFields { get; set; }
+ ///
+ /// Defines the approximate kNN search to run.
+ ///
[JsonInclude, JsonPropertyName("knn")]
public Elastic.Clients.Elasticsearch.KnnQuery? Knn { get; set; }
+ ///
+ /// 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; }
-
[JsonInclude, JsonPropertyName("post_filter")]
public Elastic.Clients.Elasticsearch.QueryDsl.Query? PostFilter { get; set; }
-
[JsonInclude, JsonPropertyName("profile")]
public bool? Profile { get; set; }
+ ///
+ /// Defines the search definition using the Query DSL.
+ ///
[JsonInclude, JsonPropertyName("query")]
public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; }
-
[JsonInclude, JsonPropertyName("rescore"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Core.Search.Rescore))]
public ICollection? Rescore { get; set; }
+ ///
+ /// Retrieve a script evaluation (based on different fields) for each hit.
+ ///
[JsonInclude, JsonPropertyName("script_fields")]
public IDictionary? ScriptFields { get; set; }
-
[JsonInclude, JsonPropertyName("search_after")]
public ICollection? SearchAfter { 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.
+ ///
[JsonInclude, JsonPropertyName("size")]
public int? Size { get; set; }
-
[JsonInclude, JsonPropertyName("slice")]
public Elastic.Clients.Elasticsearch.SlicedScroll? Slice { get; set; }
-
[JsonInclude, JsonPropertyName("sort"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.SortOptions))]
public ICollection? Sort { get; set; }
+ ///
+ /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response.
+ ///
[JsonInclude, JsonPropertyName("_source")]
public Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? Source { get; set; }
+ ///
+ /// 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; }
-
[JsonInclude, JsonPropertyName("suggest")]
public Elastic.Clients.Elasticsearch.Core.Search.Suggester? Suggest { get; set; }
+ ///
+ /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. 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.
+ ///
[JsonInclude, JsonPropertyName("timeout")]
public string? Timeout { get; set; }
+ ///
+ /// 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; }
+ ///
+ /// If true, returns document version as part of a hit.
+ ///
[JsonInclude, JsonPropertyName("version")]
public bool? Version { get; set; }
+ ///
+ /// 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; }
+ ///
+ /// 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")]
public Elastic.Clients.Elasticsearch.Fields? StoredFields { get; set; }
+ ///
+ /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path.
+ ///
[JsonInclude, JsonPropertyName("pit")]
public Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? Pit { get; set; }
+ ///
+ /// 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; }
+ ///
+ /// 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; }
}
+///
+/// Executes a search request asynchronously.
+///
public sealed partial class SubmitAsyncSearchRequestDescriptor : RequestDescriptor, SubmitAsyncSearchRequestParameters>
{
internal SubmitAsyncSearchRequestDescriptor(Action> configure) => configure.Invoke(this);
+
public SubmitAsyncSearchRequestDescriptor()
{
}
- internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchSubmit;
+ internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchSubmit;
+
protected override HttpMethod StaticHttpMethod => HttpMethod.POST;
+
internal override bool SupportsBody => true;
+
public SubmitAsyncSearchRequestDescriptor SourceExcludes(Elastic.Clients.Elasticsearch.Fields? sourceExcludes) => Qs("_source_excludes", sourceExcludes);
public SubmitAsyncSearchRequestDescriptor SourceIncludes(Elastic.Clients.Elasticsearch.Fields? sourceIncludes) => Qs("_source_includes", sourceIncludes);
public SubmitAsyncSearchRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices);
@@ -783,6 +974,7 @@ public SubmitAsyncSearchRequestDescriptor()
public SubmitAsyncSearchRequestDescriptor SuggestText(string? suggestText) => Qs("suggest_text", suggestText);
public SubmitAsyncSearchRequestDescriptor TypedKeys(bool? typedKeys = true) => Qs("typed_keys", typedKeys);
public SubmitAsyncSearchRequestDescriptor WaitForCompletionTimeout(Elastic.Clients.Elasticsearch.Duration? waitForCompletionTimeout) => Qs("wait_for_completion_timeout", waitForCompletionTimeout);
+
public SubmitAsyncSearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices)
{
RouteValues.Optional("index", indices);
@@ -790,127 +982,66 @@ public SubmitAsyncSearchRequestDescriptor Indices(Elastic.Clients.Ela
}
private Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? AggregationsValue { get; set; }
-
private Elastic.Clients.Elasticsearch.Aggregations.AggregationDescriptor AggregationsDescriptor { get; set; }
-
private Action> AggregationsDescriptorAction { get; set; }
-
private Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? CollapseValue { get; set; }
-
private Core.Search.FieldCollapseDescriptor CollapseDescriptor { get; set; }
-
private Action> CollapseDescriptorAction { get; set; }
-
private ICollection? DocvalueFieldsValue { get; set; }
-
private QueryDsl.FieldAndFormatDescriptor DocvalueFieldsDescriptor { get; set; }
-
private Action> DocvalueFieldsDescriptorAction { get; set; }
-
private Action>[] DocvalueFieldsDescriptorActions { get; set; }
-
private ICollection? FieldsValue { get; set; }
-
private QueryDsl.FieldAndFormatDescriptor FieldsDescriptor { get; set; }
-
private Action> FieldsDescriptorAction { get; set; }
-
private Action>[] FieldsDescriptorActions { get; set; }
-
private Elastic.Clients.Elasticsearch.Core.Search.Highlight? HighlightValue { get; set; }
-
private Core.Search.HighlightDescriptor HighlightDescriptor { get; set; }
-
private Action> HighlightDescriptorAction { get; set; }
-
private Elastic.Clients.Elasticsearch.KnnQuery? KnnValue { get; set; }
-
private KnnQueryDescriptor KnnDescriptor { get; set; }
-
private Action> KnnDescriptorAction { get; set; }
-
private Elastic.Clients.Elasticsearch.QueryDsl.Query? PostFilterValue { get; set; }
-
private QueryDsl.QueryDescriptor PostFilterDescriptor { get; set; }
-
private Action> PostFilterDescriptorAction { get; set; }
-
private Elastic.Clients.Elasticsearch.QueryDsl.Query? QueryValue { get; set; }
-
private QueryDsl.QueryDescriptor QueryDescriptor { get; set; }
-
private Action> QueryDescriptorAction { get; set; }
-
private ICollection? RescoreValue { get; set; }
-
private Core.Search.RescoreDescriptor RescoreDescriptor { get; set; }
-
private Action> RescoreDescriptorAction { get; set; }
-
private Action>[] RescoreDescriptorActions { get; set; }
-
private Elastic.Clients.Elasticsearch.SlicedScroll? SliceValue { get; set; }
-
private SlicedScrollDescriptor SliceDescriptor { get; set; }
-
private Action> SliceDescriptorAction { get; set; }
-
private ICollection? SortValue { get; set; }
-
private SortOptionsDescriptor SortDescriptor { get; set; }
-
private Action> SortDescriptorAction { get; set; }
-
private Action>[] SortDescriptorActions { get; set; }
-
private Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? SourceValue { get; set; }
-
private bool? ExplainValue { get; set; }
-
private IDictionary? ExtValue { get; set; }
-
private int? FromValue { get; set; }
-
private ICollection>? IndicesBoostValue { get; set; }
-
private double? MinScoreValue { get; set; }
-
private Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? PitValue { get; set; }
-
private Core.Search.PointInTimeReferenceDescriptor PitDescriptor { get; set; }
-
private Action PitDescriptorAction { get; set; }
-
private bool? ProfileValue { get; set; }
-
private IDictionary? RuntimeMappingsValue { get; set; }
-
private IDictionary? ScriptFieldsValue { get; set; }
-
private ICollection? SearchAfterValue { get; set; }
-
private bool? SeqNoPrimaryTermValue { get; set; }
-
private int? SizeValue { get; set; }
-
private ICollection? StatsValue { get; set; }
-
private Elastic.Clients.Elasticsearch.Fields? StoredFieldsValue { get; set; }
-
private Elastic.Clients.Elasticsearch.Core.Search.Suggester? SuggestValue { get; set; }
-
private Core.Search.SuggesterDescriptor SuggestDescriptor { get; set; }
-
private Action SuggestDescriptorAction { get; set; }
-
private long? TerminateAfterValue { get; set; }
-
private string? TimeoutValue { get; set; }
-
private bool? TrackScoresValue { get; set; }
-
private Elastic.Clients.Elasticsearch.Core.Search.TrackHits? TrackTotalHitsValue { get; set; }
-
private bool? VersionValue { get; set; }
public SubmitAsyncSearchRequestDescriptor Aggregations(Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? aggregations)
@@ -961,6 +1092,9 @@ 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.
+ ///
public SubmitAsyncSearchRequestDescriptor DocvalueFields(ICollection? docvalueFields)
{
DocvalueFieldsDescriptor = null;
@@ -997,6 +1131,9 @@ public SubmitAsyncSearchRequestDescriptor DocvalueFields(params Actio
return Self;
}
+ ///
+ /// 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)
{
FieldsDescriptor = null;
@@ -1057,6 +1194,9 @@ public SubmitAsyncSearchRequestDescriptor Highlight(Action
+ /// Defines the approximate kNN search to run.
+ ///
public SubmitAsyncSearchRequestDescriptor Knn(Elastic.Clients.Elasticsearch.KnnQuery? knn)
{
KnnDescriptor = null;
@@ -1105,6 +1245,9 @@ public SubmitAsyncSearchRequestDescriptor PostFilter(Action
+ /// Defines the search definition using the Query DSL.
+ ///
public SubmitAsyncSearchRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query)
{
QueryDescriptor = null;
@@ -1225,42 +1368,63 @@ 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.
+ ///
public SubmitAsyncSearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source)
{
SourceValue = source;
return Self;
}
+ ///
+ /// If true, returns detailed information about score computation as part of a hit.
+ ///
public SubmitAsyncSearchRequestDescriptor Explain(bool? explain = true)
{
ExplainValue = explain;
return Self;
}
+ ///
+ /// Configuration of search extensions defined by Elasticsearch plugins.
+ ///
public SubmitAsyncSearchRequestDescriptor Ext(Func, FluentDictionary> selector)
{
ExtValue = selector?.Invoke(new FluentDictionary());
return Self;
}
+ ///
+ /// 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)
{
FromValue = from;
return Self;
}
+ ///
+ /// Boosts the _score of documents from specified indices.
+ ///
public SubmitAsyncSearchRequestDescriptor IndicesBoost(ICollection>? indicesBoost)
{
IndicesBoostValue = indicesBoost;
return Self;
}
+ ///
+ /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results.
+ ///
public SubmitAsyncSearchRequestDescriptor MinScore(double? minScore)
{
MinScoreValue = minScore;
return Self;
}
+ ///
+ /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path.
+ ///
public SubmitAsyncSearchRequestDescriptor Pit(Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? pit)
{
PitDescriptor = null;
@@ -1291,12 +1455,18 @@ public SubmitAsyncSearchRequestDescriptor Profile(bool? profile = tru
return Self;
}
+ ///
+ /// 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, FluentDictionary> selector)
{
RuntimeMappingsValue = selector?.Invoke(new FluentDictionary());
return Self;
}
+ ///
+ /// Retrieve a script evaluation (based on different fields) for each hit.
+ ///
public SubmitAsyncSearchRequestDescriptor ScriptFields(Func, FluentDictionary> selector)
{
ScriptFieldsValue = selector?.Invoke(new FluentDictionary());
@@ -1309,24 +1479,36 @@ public SubmitAsyncSearchRequestDescriptor SearchAfter(ICollection
+ /// 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)
{
SeqNoPrimaryTermValue = seqNoPrimaryTerm;
return Self;
}
+ ///
+ /// 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)
{
SizeValue = size;
return Self;
}
+ ///
+ /// 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)
{
StatsValue = stats;
return Self;
}
+ ///
+ /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response.
+ ///
public SubmitAsyncSearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields)
{
StoredFieldsValue = storedFields;
@@ -1357,30 +1539,45 @@ 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.
+ ///
public SubmitAsyncSearchRequestDescriptor TerminateAfter(long? terminateAfter)
{
TerminateAfterValue = terminateAfter;
return Self;
}
+ ///
+ /// 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)
{
TimeoutValue = timeout;
return Self;
}
+ ///
+ /// If true, calculate and return document scores, even if the scores are not used for sorting.
+ ///
public SubmitAsyncSearchRequestDescriptor TrackScores(bool? trackScores = true)
{
TrackScoresValue = trackScores;
return Self;
}
+ ///
+ /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
Defaults to 10,000 hits.
+ ///
public SubmitAsyncSearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Core.Search.TrackHits? trackTotalHits)
{
TrackTotalHitsValue = trackTotalHits;
return Self;
}
+ ///
+ /// If true, returns document version as part of a hit.
+ ///
public SubmitAsyncSearchRequestDescriptor Version(bool? version = true)
{
VersionValue = version;
@@ -1772,16 +1969,23 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
}
}
+///
+/// Executes a search request asynchronously.
+///
public sealed partial class SubmitAsyncSearchRequestDescriptor : RequestDescriptor
{
internal SubmitAsyncSearchRequestDescriptor(Action configure) => configure.Invoke(this);
+
public SubmitAsyncSearchRequestDescriptor()
{
}
- internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchSubmit;
+ internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchSubmit;
+
protected override HttpMethod StaticHttpMethod => HttpMethod.POST;
+
internal override bool SupportsBody => true;
+
public SubmitAsyncSearchRequestDescriptor SourceExcludes(Elastic.Clients.Elasticsearch.Fields? sourceExcludes) => Qs("_source_excludes", sourceExcludes);
public SubmitAsyncSearchRequestDescriptor SourceIncludes(Elastic.Clients.Elasticsearch.Fields? sourceIncludes) => Qs("_source_includes", sourceIncludes);
public SubmitAsyncSearchRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices);
@@ -1814,6 +2018,7 @@ public SubmitAsyncSearchRequestDescriptor()
public SubmitAsyncSearchRequestDescriptor SuggestText(string? suggestText) => Qs("suggest_text", suggestText);
public SubmitAsyncSearchRequestDescriptor TypedKeys(bool? typedKeys = true) => Qs("typed_keys", typedKeys);
public SubmitAsyncSearchRequestDescriptor WaitForCompletionTimeout(Elastic.Clients.Elasticsearch.Duration? waitForCompletionTimeout) => Qs("wait_for_completion_timeout", waitForCompletionTimeout);
+
public SubmitAsyncSearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices)
{
RouteValues.Optional("index", indices);
@@ -1821,127 +2026,66 @@ public SubmitAsyncSearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.
}
private Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? AggregationsValue { get; set; }
-
private Elastic.Clients.Elasticsearch.Aggregations.AggregationDescriptor AggregationsDescriptor { get; set; }
-
private Action AggregationsDescriptorAction { get; set; }
-
private Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? CollapseValue { get; set; }
-
private Core.Search.FieldCollapseDescriptor CollapseDescriptor { get; set; }
-
private Action CollapseDescriptorAction { get; set; }
-
private ICollection? DocvalueFieldsValue { get; set; }
-
private QueryDsl.FieldAndFormatDescriptor DocvalueFieldsDescriptor { get; set; }
-
private Action DocvalueFieldsDescriptorAction { get; set; }
-
private Action[] DocvalueFieldsDescriptorActions { get; set; }
-
private ICollection? FieldsValue { get; set; }
-
private QueryDsl.FieldAndFormatDescriptor FieldsDescriptor { get; set; }
-
private Action FieldsDescriptorAction { get; set; }
-
private Action[] FieldsDescriptorActions { get; set; }
-
private Elastic.Clients.Elasticsearch.Core.Search.Highlight? HighlightValue { get; set; }
-
private Core.Search.HighlightDescriptor HighlightDescriptor { get; set; }
-
private Action HighlightDescriptorAction { get; set; }
-
private Elastic.Clients.Elasticsearch.KnnQuery? KnnValue { get; set; }
-
private KnnQueryDescriptor KnnDescriptor { get; set; }
-
private Action KnnDescriptorAction { get; set; }
-
private Elastic.Clients.Elasticsearch.QueryDsl.Query? PostFilterValue { get; set; }
-
private QueryDsl.QueryDescriptor PostFilterDescriptor { get; set; }
-
private Action PostFilterDescriptorAction { get; set; }
-
private Elastic.Clients.Elasticsearch.QueryDsl.Query? QueryValue { get; set; }
-
private QueryDsl.QueryDescriptor QueryDescriptor { get; set; }
-
private Action QueryDescriptorAction { get; set; }
-
private ICollection? RescoreValue { get; set; }
-
private Core.Search.RescoreDescriptor RescoreDescriptor { get; set; }
-
private Action RescoreDescriptorAction { get; set; }
-
private Action[] RescoreDescriptorActions { get; set; }
-
private Elastic.Clients.Elasticsearch.SlicedScroll? SliceValue { get; set; }
-
private SlicedScrollDescriptor SliceDescriptor { get; set; }
-
private Action SliceDescriptorAction { get; set; }
-
private ICollection? SortValue { get; set; }
-
private SortOptionsDescriptor SortDescriptor { get; set; }
-
private Action SortDescriptorAction { get; set; }
-
private Action[] SortDescriptorActions { get; set; }
-
private Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? SourceValue { get; set; }
-
private bool? ExplainValue { get; set; }
-
private IDictionary? ExtValue { get; set; }
-
private int? FromValue { get; set; }
-
private ICollection>? IndicesBoostValue { get; set; }
-
private double? MinScoreValue { get; set; }
-
private Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? PitValue { get; set; }
-
private Core.Search.PointInTimeReferenceDescriptor PitDescriptor { get; set; }
-
private Action PitDescriptorAction { get; set; }
-
private bool? ProfileValue { get; set; }
-
private IDictionary? RuntimeMappingsValue { get; set; }
-
private IDictionary? ScriptFieldsValue { get; set; }
-
private ICollection? SearchAfterValue { get; set; }
-
private bool? SeqNoPrimaryTermValue { get; set; }
-
private int? SizeValue { get; set; }
-
private ICollection? StatsValue { get; set; }
-
private Elastic.Clients.Elasticsearch.Fields? StoredFieldsValue { get; set; }
-
private Elastic.Clients.Elasticsearch.Core.Search.Suggester? SuggestValue { get; set; }
-
private Core.Search.SuggesterDescriptor SuggestDescriptor { get; set; }
-
private Action SuggestDescriptorAction { get; set; }
-
private long? TerminateAfterValue { get; set; }
-
private string? TimeoutValue { get; set; }
-
private bool? TrackScoresValue { get; set; }
-
private Elastic.Clients.Elasticsearch.Core.Search.TrackHits? TrackTotalHitsValue { get; set; }
-
private bool? VersionValue { get; set; }
public SubmitAsyncSearchRequestDescriptor Aggregations(Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? aggregations)
@@ -1992,6 +2136,9 @@ 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.
+ ///
public SubmitAsyncSearchRequestDescriptor DocvalueFields(ICollection? docvalueFields)
{
DocvalueFieldsDescriptor = null;
@@ -2028,6 +2175,9 @@ public SubmitAsyncSearchRequestDescriptor DocvalueFields(params Action
+ /// 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)
{
FieldsDescriptor = null;
@@ -2088,6 +2238,9 @@ public SubmitAsyncSearchRequestDescriptor Highlight(Action
+ /// Defines the approximate kNN search to run.
+ ///
public SubmitAsyncSearchRequestDescriptor Knn(Elastic.Clients.Elasticsearch.KnnQuery? knn)
{
KnnDescriptor = null;
@@ -2136,6 +2289,9 @@ public SubmitAsyncSearchRequestDescriptor PostFilter(Action
+ /// Defines the search definition using the Query DSL.
+ ///
public SubmitAsyncSearchRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query)
{
QueryDescriptor = null;
@@ -2256,42 +2412,63 @@ 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.
+ ///
public SubmitAsyncSearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source)
{
SourceValue = source;
return Self;
}
+ ///
+ /// If true, returns detailed information about score computation as part of a hit.
+ ///
public SubmitAsyncSearchRequestDescriptor Explain(bool? explain = true)
{
ExplainValue = explain;
return Self;
}
+ ///
+ /// Configuration of search extensions defined by Elasticsearch plugins.
+ ///
public SubmitAsyncSearchRequestDescriptor Ext(Func, FluentDictionary> selector)
{
ExtValue = selector?.Invoke(new FluentDictionary());
return Self;
}
+ ///
+ /// 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)
{
FromValue = from;
return Self;
}
+ ///
+ /// Boosts the _score of documents from specified indices.
+ ///
public SubmitAsyncSearchRequestDescriptor IndicesBoost(ICollection>? indicesBoost)
{
IndicesBoostValue = indicesBoost;
return Self;
}
+ ///
+ /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results.
+ ///
public SubmitAsyncSearchRequestDescriptor MinScore(double? minScore)
{
MinScoreValue = minScore;
return Self;
}
+ ///
+ /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path.
+ ///
public SubmitAsyncSearchRequestDescriptor Pit(Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? pit)
{
PitDescriptor = null;
@@ -2322,12 +2499,18 @@ public SubmitAsyncSearchRequestDescriptor Profile(bool? profile = true)
return Self;
}
+ ///
+ /// 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, FluentDictionary> selector)
{
RuntimeMappingsValue = selector?.Invoke(new FluentDictionary());
return Self;
}
+ ///
+ /// Retrieve a script evaluation (based on different fields) for each hit.
+ ///
public SubmitAsyncSearchRequestDescriptor ScriptFields(Func, FluentDictionary> selector)
{
ScriptFieldsValue = selector?.Invoke(new FluentDictionary());
@@ -2340,24 +2523,36 @@ public SubmitAsyncSearchRequestDescriptor SearchAfter(ICollection