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 a23a386c0e4..220a0037511 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs @@ -28,11 +28,21 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch; public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse { + /// + /// Metadata about clusters involved in the cross-cluster search.
Not shown for local-only searches. + /// + [JsonInclude, JsonPropertyName("_clusters")] + public Elastic.Clients.Elasticsearch.ClusterStatistics? Clusters { get; init; } + /// /// If the async search completed, this field shows the status code of the search.
For example, 200 indicates that the async search was successfully completed.
503 indicates that the async search was completed with an error. /// [JsonInclude, JsonPropertyName("completion_status")] public int? CompletionStatus { get; init; } + [JsonInclude, JsonPropertyName("completion_time")] + public DateTimeOffset? CompletionTime { get; init; } + [JsonInclude, JsonPropertyName("completion_time_in_millis")] + public long? CompletionTimeInMillis { get; init; } [JsonInclude, JsonPropertyName("expiration_time")] public DateTimeOffset? ExpirationTime { get; init; } [JsonInclude, JsonPropertyName("expiration_time_in_millis")] 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 92e32556c43..77218e32631 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs @@ -28,6 +28,10 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch; public sealed partial class GetAsyncSearchResponse : ElasticsearchResponse { + [JsonInclude, JsonPropertyName("completion_time")] + public DateTimeOffset? CompletionTime { get; init; } + [JsonInclude, JsonPropertyName("completion_time_in_millis")] + public long? CompletionTimeInMillis { get; init; } [JsonInclude, JsonPropertyName("expiration_time")] public DateTimeOffset? ExpirationTime { get; init; } [JsonInclude, JsonPropertyName("expiration_time_in_millis")] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchResponse.g.cs index a923dc3cfc3..8fff6812e51 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchResponse.g.cs @@ -28,6 +28,10 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch; public sealed partial class SubmitAsyncSearchResponse : ElasticsearchResponse { + [JsonInclude, JsonPropertyName("completion_time")] + public DateTimeOffset? CompletionTime { get; init; } + [JsonInclude, JsonPropertyName("completion_time_in_millis")] + public long? CompletionTimeInMillis { get; init; } [JsonInclude, JsonPropertyName("expiration_time")] public DateTimeOffset? ExpirationTime { get; init; } [JsonInclude, JsonPropertyName("expiration_time_in_millis")] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs index 18ebd7dd97d..0a15479182b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs @@ -32,18 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed class ClusterStatsRequestParameters : RequestParameters { /// - /// Return settings in flat format (default: false) + /// If `true`, returns settings in flat format. /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout. + /// Period to wait for each node to respond.
If a node does not respond before its timeout expires, the response does not include its stats.
However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns high-level overview of cluster statistics. +/// 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 { @@ -62,20 +62,20 @@ public ClusterStatsRequest(Elastic.Clients.Elasticsearch.NodeIds? node_id) : bas internal override bool SupportsBody => false; /// - /// Return settings in flat format (default: false) + /// If `true`, returns settings in flat format. /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout. + /// Period to wait for each node to respond.
If a node does not respond before its timeout expires, the response does not include its stats.
However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns high-level overview of cluster statistics. +/// Returns cluster statistics.
It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// public sealed partial class ClusterStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsResponse.g.cs index 84789344bcc..fa24ebba2aa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsResponse.g.cs @@ -28,7 +28,7 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterStatsResponse : ElasticsearchResponse { /// - /// Name of the cluster, based on the Cluster name setting setting. + /// Name of the cluster, based on the cluster name setting. /// [JsonInclude, JsonPropertyName("cluster_name")] public string ClusterName { get; init; } @@ -60,7 +60,7 @@ public sealed partial class ClusterStatsResponse : ElasticsearchResponse public Elastic.Clients.Elasticsearch.HealthStatus Status { get; init; } /// - /// Unix timestamp, in milliseconds, of the last time the cluster statistics were refreshed. + /// Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. /// [JsonInclude, JsonPropertyName("timestamp")] public long Timestamp { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs index a6fc30853a1..df6a9e56694 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs @@ -32,28 +32,28 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed class GetClusterSettingsRequestParameters : RequestParameters { /// - /// Return settings in flat format (default: false) + /// If `true`, returns settings in flat format. /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Whether to return all default clusters setting. + /// If `true`, returns default cluster settings from the local node. /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Explicit operation timeout for connection to master node + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster settings. +/// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. /// public sealed partial class GetClusterSettingsRequest : PlainRequest { @@ -64,32 +64,32 @@ public sealed partial class GetClusterSettingsRequest : PlainRequest false; /// - /// Return settings in flat format (default: false) + /// If `true`, returns settings in flat format. /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Whether to return all default clusters setting. + /// If `true`, returns default cluster settings from the local node. /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Explicit operation timeout for connection to master node + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Returns cluster settings. +/// Returns cluster-wide settings.
By default, it returns only settings that have been explicitly defined. /// public sealed partial class GetClusterSettingsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs index 38d8634049c..66545b25b16 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs @@ -32,18 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed class PendingTasksRequestParameters : RequestParameters { /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only.
If `false`, information is retrieved from the master node. /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns a list of any cluster-level changes (e.g. create index, update mapping,
allocate or fail shard) which have not yet been executed. +/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
NOTE: This API returns a list of any pending updates to the cluster state.
These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. /// public sealed partial class PendingTasksRequest : PlainRequest { @@ -54,20 +54,20 @@ public sealed partial class PendingTasksRequest : PlainRequest false; /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only.
If `false`, information is retrieved from the master node. /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns a list of any cluster-level changes (e.g. create index, update mapping,
allocate or fail shard) which have not yet been executed. +/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
NOTE: This API returns a list of any pending updates to the cluster state.
These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.
However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. /// public sealed partial class PendingTasksRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsRequest.g.cs index 08ca244e71a..96565a86893 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsRequest.g.cs @@ -34,7 +34,7 @@ public sealed class EnrichStatsRequestParameters : RequestParameters } /// -/// Gets enrich coordinator statistics and information about enrich policies that are currently executing. +/// Returns enrich coordinator statistics and information about enrich policies that are currently executing. /// public sealed partial class EnrichStatsRequest : PlainRequest { @@ -46,7 +46,7 @@ public sealed partial class EnrichStatsRequest : PlainRequest -/// Gets enrich coordinator statistics and information about enrich policies that are currently executing. +/// Returns enrich coordinator statistics and information about enrich policies that are currently executing. /// public sealed partial class EnrichStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsResponse.g.cs index 77a52178f81..ea55ef287fd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsResponse.g.cs @@ -27,10 +27,21 @@ namespace Elastic.Clients.Elasticsearch.Enrich; public sealed partial class EnrichStatsResponse : ElasticsearchResponse { + /// + /// Objects containing information about the enrich cache stats on each ingest node. + /// [JsonInclude, JsonPropertyName("cache_stats")] public IReadOnlyCollection? CacheStats { get; init; } + + /// + /// Objects containing information about each coordinating ingest node for configured enrich processors. + /// [JsonInclude, JsonPropertyName("coordinator_stats")] public IReadOnlyCollection CoordinatorStats { get; init; } + + /// + /// Objects containing information about each enrich policy that is currently executing. + /// [JsonInclude, JsonPropertyName("executing_policies")] public IReadOnlyCollection ExecutingPolicies { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs index 582cbc2ef9f..2f4c97c7537 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs @@ -32,7 +32,7 @@ namespace Elastic.Clients.Elasticsearch.Enrich; public sealed class ExecutePolicyRequestParameters : RequestParameters { /// - /// Should the request should block until the execution is complete. + /// If `true`, the request blocks other enrich policy execution requests until complete. /// public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } @@ -53,7 +53,7 @@ public ExecutePolicyRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => internal override bool SupportsBody => false; /// - /// Should the request should block until the execution is complete. + /// If `true`, the request blocks other enrich policy execution requests until complete. /// [JsonIgnore] public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/GetPolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/GetPolicyRequest.g.cs index d196b9e4761..6c8c9588f8b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/GetPolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/GetPolicyRequest.g.cs @@ -34,7 +34,7 @@ public sealed class GetPolicyRequestParameters : RequestParameters } /// -/// Gets information about an enrich policy. +/// Returns information about an enrich policy. /// public sealed partial class GetPolicyRequest : PlainRequest { @@ -54,7 +54,7 @@ public GetPolicyRequest(Elastic.Clients.Elasticsearch.Names? name) : base(r => r } /// -/// Gets information about an enrich policy. +/// Returns information about an enrich policy. /// public sealed partial class GetPolicyRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyRequest.g.cs index ac7fee98ac6..b4188aa0a34 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyRequest.g.cs @@ -34,7 +34,7 @@ public sealed class PutPolicyRequestParameters : RequestParameters } /// -/// Creates a new enrich policy. +/// Creates an enrich policy. /// public sealed partial class PutPolicyRequest : PlainRequest { @@ -48,16 +48,27 @@ public PutPolicyRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => r.R internal override bool SupportsBody => true; + /// + /// Matches enrich data to incoming documents based on a `geo_shape` query. + /// [JsonInclude, JsonPropertyName("geo_match")] public Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? GeoMatch { get; set; } + + /// + /// Matches enrich data to incoming documents based on a `term` query. + /// [JsonInclude, JsonPropertyName("match")] public Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? Match { get; set; } + + /// + /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query. + /// [JsonInclude, JsonPropertyName("range")] public Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? Range { get; set; } } /// -/// Creates a new enrich policy. +/// Creates an enrich policy. /// public sealed partial class PutPolicyRequestDescriptor : RequestDescriptor, PutPolicyRequestParameters> { @@ -93,6 +104,9 @@ public PutPolicyRequestDescriptor Name(Elastic.Clients.Elasticsearch. private EnrichPolicyDescriptor RangeDescriptor { get; set; } private Action> RangeDescriptorAction { get; set; } + /// + /// Matches enrich data to incoming documents based on a `geo_shape` query. + /// public PutPolicyRequestDescriptor GeoMatch(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? geoMatch) { GeoMatchDescriptor = null; @@ -117,6 +131,9 @@ public PutPolicyRequestDescriptor GeoMatch(Action + /// Matches enrich data to incoming documents based on a `term` query. + /// public PutPolicyRequestDescriptor Match(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? match) { MatchDescriptor = null; @@ -141,6 +158,9 @@ public PutPolicyRequestDescriptor Match(Action + /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query. + /// public PutPolicyRequestDescriptor Range(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? range) { RangeDescriptor = null; @@ -221,7 +241,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Creates a new enrich policy. +/// Creates an enrich policy. /// public sealed partial class PutPolicyRequestDescriptor : RequestDescriptor { @@ -257,6 +277,9 @@ public PutPolicyRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name name) private EnrichPolicyDescriptor RangeDescriptor { get; set; } private Action RangeDescriptorAction { get; set; } + /// + /// Matches enrich data to incoming documents based on a `geo_shape` query. + /// public PutPolicyRequestDescriptor GeoMatch(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? geoMatch) { GeoMatchDescriptor = null; @@ -281,6 +304,9 @@ public PutPolicyRequestDescriptor GeoMatch(Action config return Self; } + /// + /// Matches enrich data to incoming documents based on a `term` query. + /// public PutPolicyRequestDescriptor Match(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? match) { MatchDescriptor = null; @@ -305,6 +331,9 @@ public PutPolicyRequestDescriptor Match(Action configure return Self; } + /// + /// Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query. + /// public PutPolicyRequestDescriptor Range(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? range) { RangeDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteRequest.g.cs index f49c8990354..de9398b42f1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteRequest.g.cs @@ -34,7 +34,7 @@ public sealed class EqlDeleteRequestParameters : RequestParameters } /// -/// Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. +/// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. /// public sealed partial class EqlDeleteRequest : PlainRequest { @@ -50,7 +50,7 @@ public EqlDeleteRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requi } /// -/// Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. +/// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. /// public sealed partial class EqlDeleteRequestDescriptor : RequestDescriptor, EqlDeleteRequestParameters> { @@ -82,7 +82,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. +/// Deletes an async EQL search or a stored synchronous EQL search.
The API also deletes results for the search. /// public sealed partial class EqlDeleteRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetRequest.g.cs index e255a6d5be6..a050cc13e10 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetRequest.g.cs @@ -32,18 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Eql; public sealed class EqlGetRequestParameters : RequestParameters { /// - /// Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request. + /// Period for which the search and its results are stored on the cluster.
Defaults to the keep_alive value set by the search’s EQL search API request. /// public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results. + /// Timeout duration to wait for the request to finish.
Defaults to no timeout, meaning the request waits for complete search results. /// public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Returns async results from previously executed Event Query Language (EQL) search +/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// public sealed partial class EqlGetRequest : PlainRequest { @@ -58,20 +58,20 @@ public EqlGetRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required internal override bool SupportsBody => false; /// - /// Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request. + /// Period for which the search and its results are stored on the cluster.
Defaults to the keep_alive value set by the search’s EQL search API request. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } /// - /// Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results. + /// Timeout duration to wait for the request to finish.
Defaults to no timeout, meaning the request waits for complete search results. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); } } /// -/// Returns async results from previously executed Event Query Language (EQL) search +/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// public sealed partial class EqlGetRequestDescriptor : RequestDescriptor, EqlGetRequestParameters> { @@ -106,7 +106,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns async results from previously executed Event Query Language (EQL) search +/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// public sealed partial class EqlGetRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusRequest.g.cs index b88a3a8b593..dc05f95827f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusRequest.g.cs @@ -34,7 +34,7 @@ public sealed class GetEqlStatusRequestParameters : RequestParameters } /// -/// Returns the status of a previously submitted async or stored Event Query Language (EQL) search +/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// public sealed partial class GetEqlStatusRequest : PlainRequest { @@ -50,7 +50,7 @@ public GetEqlStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Re } /// -/// Returns the status of a previously submitted async or stored Event Query Language (EQL) search +/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// public sealed partial class GetEqlStatusRequestDescriptor : RequestDescriptor, GetEqlStatusRequestParameters> { @@ -82,7 +82,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns the status of a previously submitted async or stored Event Query Language (EQL) search +/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// public sealed partial class GetEqlStatusRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Graph/ExploreRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Graph/ExploreRequest.g.cs index bd2c1160542..56064ecbb9c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Graph/ExploreRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Graph/ExploreRequest.g.cs @@ -32,18 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Graph; public sealed class ExploreRequestParameters : RequestParameters { /// - /// Specific routing value + /// Custom value used to route operations to a specific shard. /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Explicit operation timeout + /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Explore extracted and summarized information about the documents and terms in an index. +/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// public sealed partial class ExploreRequest : PlainRequest { @@ -58,28 +58,44 @@ public ExploreRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r => internal override bool SupportsBody => true; /// - /// Specific routing value + /// Custom value used to route operations to a specific shard. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Explicit operation timeout + /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + + /// + /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// [JsonInclude, JsonPropertyName("connections")] public Elastic.Clients.Elasticsearch.Graph.Hop? Connections { get; set; } + + /// + /// Direct the Graph API how to build the graph. + /// [JsonInclude, JsonPropertyName("controls")] public Elastic.Clients.Elasticsearch.Graph.ExploreControls? Controls { get; set; } + + /// + /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } + + /// + /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// [JsonInclude, JsonPropertyName("vertices")] public ICollection? Vertices { get; set; } } /// -/// Explore extracted and summarized information about the documents and terms in an index. +/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// public sealed partial class ExploreRequestDescriptor : RequestDescriptor, ExploreRequestParameters> { @@ -122,6 +138,9 @@ public ExploreRequestDescriptor Indices(Elastic.Clients.Elasticsearch private Action> VerticesDescriptorAction { get; set; } private Action>[] VerticesDescriptorActions { get; set; } + /// + /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// public ExploreRequestDescriptor Connections(Elastic.Clients.Elasticsearch.Graph.Hop? connections) { ConnectionsDescriptor = null; @@ -146,6 +165,9 @@ public ExploreRequestDescriptor Connections(Action + /// Direct the Graph API how to build the graph. + /// public ExploreRequestDescriptor Controls(Elastic.Clients.Elasticsearch.Graph.ExploreControls? controls) { ControlsDescriptor = null; @@ -170,6 +192,9 @@ public ExploreRequestDescriptor Controls(Action + /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// public ExploreRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { QueryDescriptor = null; @@ -194,6 +219,9 @@ public ExploreRequestDescriptor Query(Action + /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// public ExploreRequestDescriptor Vertices(ICollection? vertices) { VerticesDescriptor = null; @@ -317,7 +345,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Explore extracted and summarized information about the documents and terms in an index. +/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// public sealed partial class ExploreRequestDescriptor : RequestDescriptor { @@ -360,6 +388,9 @@ public ExploreRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices in private Action VerticesDescriptorAction { get; set; } private Action[] VerticesDescriptorActions { get; set; } + /// + /// Specifies or more fields from which you want to extract terms that are associated with the specified vertices. + /// public ExploreRequestDescriptor Connections(Elastic.Clients.Elasticsearch.Graph.Hop? connections) { ConnectionsDescriptor = null; @@ -384,6 +415,9 @@ public ExploreRequestDescriptor Connections(Action configure) return Self; } + /// + /// Direct the Graph API how to build the graph. + /// public ExploreRequestDescriptor Controls(Elastic.Clients.Elasticsearch.Graph.ExploreControls? controls) { ControlsDescriptor = null; @@ -408,6 +442,9 @@ public ExploreRequestDescriptor Controls(Action confi return Self; } + /// + /// A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. + /// public ExploreRequestDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { QueryDescriptor = null; @@ -432,6 +469,9 @@ public ExploreRequestDescriptor Query(Action configure return Self; } + /// + /// Specifies one or more fields that contain the terms you want to include in the graph as vertices. + /// public ExploreRequestDescriptor Vertices(ICollection? vertices) { VerticesDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloneIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloneIndexRequest.g.cs index b5c83cc9559..01bcaec3387 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloneIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloneIndexRequest.g.cs @@ -32,23 +32,23 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class CloneIndexRequestParameters : RequestParameters { /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Set the number of active shards to wait for on the cloned index before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Clones an index +/// Clones an existing index. /// public sealed partial class CloneIndexRequest : PlainRequest { @@ -63,30 +63,38 @@ public CloneIndexRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic. internal override bool SupportsBody => true; /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Set the number of active shards to wait for on the cloned index before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } + + /// + /// Aliases for the resulting index. + /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } + + /// + /// Configuration options for the target index. + /// [JsonInclude, JsonPropertyName("settings")] public IDictionary? Settings { get; set; } } /// -/// Clones an index +/// Clones an existing index. /// public sealed partial class CloneIndexRequestDescriptor : RequestDescriptor, CloneIndexRequestParameters> { @@ -125,12 +133,18 @@ public CloneIndexRequestDescriptor Target(Elastic.Clients.Elasticsear private IDictionary? AliasesValue { get; set; } private IDictionary? SettingsValue { get; set; } + /// + /// Aliases for the resulting index. + /// public CloneIndexRequestDescriptor Aliases(Func, FluentDictionary> selector) { AliasesValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// Configuration options for the target index. + /// public CloneIndexRequestDescriptor Settings(Func, FluentDictionary> selector) { SettingsValue = selector?.Invoke(new FluentDictionary()); @@ -157,7 +171,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Clones an index +/// Clones an existing index. /// public sealed partial class CloneIndexRequestDescriptor : RequestDescriptor { @@ -196,12 +210,18 @@ public CloneIndexRequestDescriptor Target(Elastic.Clients.Elasticsearch.Name tar private IDictionary? AliasesValue { get; set; } private IDictionary? SettingsValue { get; set; } + /// + /// Aliases for the resulting index. + /// public CloneIndexRequestDescriptor Aliases(Func, FluentDictionary> selector) { AliasesValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// Configuration options for the target index. + /// public CloneIndexRequestDescriptor Settings(Func, FluentDictionary> selector) { SettingsValue = selector?.Invoke(new FluentDictionary()); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs index 767c87c0a2d..46f43861244 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs @@ -32,32 +32,32 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class CloseIndexRequestParameters : 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) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Sets the number of active shards to wait for before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } @@ -78,37 +78,37 @@ public CloseIndexRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r internal override bool SupportsBody => false; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Sets the number of active shards to wait for before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateDataStreamRequest.g.cs index db42ce2c76c..63571d47686 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateDataStreamRequest.g.cs @@ -34,7 +34,7 @@ public sealed class CreateDataStreamRequestParameters : RequestParameters } /// -/// Creates a data stream +/// Creates a data stream.
You must have a matching index template with data stream enabled. /// public sealed partial class CreateDataStreamRequest : PlainRequest { @@ -50,7 +50,7 @@ public CreateDataStreamRequest(Elastic.Clients.Elasticsearch.DataStreamName name } /// -/// Creates a data stream +/// Creates a data stream.
You must have a matching index template with data stream enabled. /// public sealed partial class CreateDataStreamRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateIndexRequest.g.cs index d869d5198c9..38ea70951eb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CreateIndexRequest.g.cs @@ -32,23 +32,23 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class CreateIndexRequestParameters : RequestParameters { /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Set the number of active shards to wait for before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Creates an index with optional settings and mappings. +/// Creates a new index. /// public sealed partial class CreateIndexRequest : PlainRequest { @@ -63,22 +63,26 @@ public CreateIndexRequest(Elastic.Clients.Elasticsearch.IndexName index) : base( internal override bool SupportsBody => true; /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Set the number of active shards to wait for before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } + + /// + /// Aliases for the index. + /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } @@ -87,12 +91,16 @@ public CreateIndexRequest(Elastic.Clients.Elasticsearch.IndexName index) : base( /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Mapping.TypeMapping? Mappings { get; set; } + + /// + /// Configuration options for the index. + /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? Settings { get; set; } } /// -/// Creates an index with optional settings and mappings. +/// Creates a new index. /// public sealed partial class CreateIndexRequestDescriptor : RequestDescriptor, CreateIndexRequestParameters> { @@ -161,6 +169,9 @@ public CreateIndexRequestDescriptor Mappings(Action + /// Configuration options for the index. + /// public CreateIndexRequestDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? settings) { SettingsDescriptor = null; @@ -185,6 +196,9 @@ public CreateIndexRequestDescriptor Settings(Action + /// Aliases for the index. + /// public CreateIndexRequestDescriptor Aliases(Func, FluentDictionary> selector) { AliasesValue = selector?.Invoke(new FluentDictionary()); @@ -237,7 +251,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Creates an index with optional settings and mappings. +/// Creates a new index. /// public sealed partial class CreateIndexRequestDescriptor : RequestDescriptor { @@ -302,6 +316,9 @@ public CreateIndexRequestDescriptor Mappings(Action + /// Configuration options for the index. + /// public CreateIndexRequestDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? settings) { SettingsDescriptor = null; @@ -326,6 +343,9 @@ public CreateIndexRequestDescriptor Settings(Action con return Self; } + /// + /// Aliases for the index. + /// public CreateIndexRequestDescriptor Aliases(Func, FluentDictionary> selector) { AliasesValue = selector?.Invoke(new FluentDictionary()); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteAliasRequest.g.cs index ebef10fce5a..cb523e46285 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteAliasRequest.g.cs @@ -32,18 +32,18 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class DeleteAliasRequestParameters : RequestParameters { /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit timestamp for the document + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes an alias. +/// Removes a data stream or index from an alias. /// public sealed partial class DeleteAliasRequest : PlainRequest { @@ -58,20 +58,20 @@ public DeleteAliasRequest(Elastic.Clients.Elasticsearch.Indices indices, Elastic internal override bool SupportsBody => false; /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit timestamp for the document + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes an alias. +/// Removes a data stream or index from an alias. /// public sealed partial class DeleteAliasRequestDescriptor : RequestDescriptor, DeleteAliasRequestParameters> { @@ -112,7 +112,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes an alias. +/// Removes a data stream or index from an alias. /// public sealed partial class DeleteAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataStreamRequest.g.cs index 373cf07edc4..4b4a787c7cb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteDataStreamRequest.g.cs @@ -32,13 +32,13 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class DeleteDataStreamRequestParameters : RequestParameters { /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } } /// -/// Deletes a data stream. +/// Deletes one or more data streams and their backing indices. /// public sealed partial class DeleteDataStreamRequest : PlainRequest { @@ -53,14 +53,14 @@ public DeleteDataStreamRequest(Elastic.Clients.Elasticsearch.DataStreamNames nam internal override bool SupportsBody => false; /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } } /// -/// Deletes a data stream. +/// Deletes one or more data streams and their backing indices. /// public sealed partial class DeleteDataStreamRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexRequest.g.cs index 6b7765cb9a3..c86249cf2f5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteIndexRequest.g.cs @@ -32,33 +32,33 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class DeleteIndexRequestParameters : RequestParameters { /// - /// Ignore if a wildcard expression resolves to no concrete indices (default: false) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether wildcard expressions should get expanded to open, closed, or hidden indices + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Ignore unavailable indexes (default: false) + /// If `false`, the request returns an error if it targets a missing or closed index. /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes an index. +/// Deletes one or more indices. /// public sealed partial class DeleteIndexRequest : PlainRequest { @@ -73,38 +73,38 @@ public DeleteIndexRequest(Elastic.Clients.Elasticsearch.Indices indices) : base( internal override bool SupportsBody => false; /// - /// Ignore if a wildcard expression resolves to no concrete indices (default: false) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether wildcard expressions should get expanded to open, closed, or hidden indices + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Ignore unavailable indexes (default: false) + /// If `false`, the request returns an error if it targets a missing or closed index. /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes an index. +/// Deletes one or more indices. /// public sealed partial class DeleteIndexRequestDescriptor : RequestDescriptor, DeleteIndexRequestParameters> { @@ -142,7 +142,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes an index. +/// Deletes one or more indices. /// public sealed partial class DeleteIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteTemplateRequest.g.cs index 15a7c90c101..832b803f50d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DeleteTemplateRequest.g.cs @@ -32,18 +32,18 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class DeleteTemplateRequestParameters : RequestParameters { /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes an index template. +/// Deletes a legacy index template. /// public sealed partial class DeleteTemplateRequest : PlainRequest { @@ -58,20 +58,20 @@ public DeleteTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : base(r = internal override bool SupportsBody => false; /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes an index template. +/// Deletes a legacy index template. /// public sealed partial class DeleteTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs index 31071e8449f..957d571a869 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs @@ -32,28 +32,28 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class ExistsAliasRequestParameters : 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) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only. /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Returns information about whether a particular alias exists. +/// Checks if an alias exists. /// public sealed partial class ExistsAliasRequest : PlainRequest { @@ -72,32 +72,32 @@ public ExistsAliasRequest(Elastic.Clients.Elasticsearch.Indices? indices, Elasti internal override bool SupportsBody => false; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only. /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Returns information about whether a particular alias exists. +/// Checks if an alias exists. /// public sealed partial class ExistsAliasRequestDescriptor : RequestDescriptor, ExistsAliasRequestParameters> { @@ -144,7 +144,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns information about whether a particular alias exists. +/// Checks if an alias exists. /// public sealed partial class ExistsAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsRequest.g.cs index 839e4a7f3d9..ef23386747e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsRequest.g.cs @@ -32,38 +32,38 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class ExistsRequestParameters : RequestParameters { /// - /// Ignore if a wildcard expression resolves to no concrete indices (default: false) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Return settings in flat format (default: false) + /// If `true`, returns settings in flat format. /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Ignore unavailable indexes (default: false) + /// If `false`, the request returns an error if it targets a missing or closed index. /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Whether to return all default setting for each of the indices. + /// If `true`, return all default settings in the response. /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only. /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Returns information about whether a particular index exists. +/// Checks if a data stream, index, or alias exists. /// public sealed partial class ExistsRequest : PlainRequest { @@ -78,44 +78,44 @@ public ExistsRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r => internal override bool SupportsBody => false; /// - /// Ignore if a wildcard expression resolves to no concrete indices (default: false) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Return settings in flat format (default: false) + /// If `true`, returns settings in flat format. /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Ignore unavailable indexes (default: false) + /// If `false`, the request returns an error if it targets a missing or closed index. /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Whether to return all default setting for each of the indices. + /// If `true`, return all default settings in the response. /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only. /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Returns information about whether a particular index exists. +/// Checks if a data stream, index, or alias exists. /// public sealed partial class ExistsRequestDescriptor : RequestDescriptor, ExistsRequestParameters> { @@ -154,7 +154,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns information about whether a particular index exists. +/// Checks if a data stream, index, or alias exists. /// public sealed partial class ExistsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FlushRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FlushRequest.g.cs index 3ac058236ec..d85e1199c85 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FlushRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FlushRequest.g.cs @@ -32,33 +32,33 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class FlushRequestParameters : 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) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal) + /// If `true`, the request forces a flush even if there are no changes to commit to the index. /// public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running. + /// If `true`, the flush operation blocks until execution when another flush operation is running.
If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. /// public bool? WaitIfOngoing { get => Q("wait_if_ongoing"); set => Q("wait_if_ongoing", value); } } /// -/// Performs the flush operation on one or more indices. +/// Flushes one or more data streams or indices. /// public sealed partial class FlushRequest : PlainRequest { @@ -77,38 +77,38 @@ public FlushRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => internal override bool SupportsBody => false; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal) + /// If `true`, the request forces a flush even if there are no changes to commit to the index. /// [JsonIgnore] public bool? Force { get => Q("force"); set => Q("force", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running. + /// If `true`, the flush operation blocks until execution when another flush operation is running.
If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. /// [JsonIgnore] public bool? WaitIfOngoing { get => Q("wait_if_ongoing"); set => Q("wait_if_ongoing", value); } } /// -/// Performs the flush operation on one or more indices. +/// Flushes one or more data streams or indices. /// public sealed partial class FlushRequestDescriptor : RequestDescriptor, FlushRequestParameters> { @@ -142,7 +142,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Performs the flush operation on one or more indices. +/// Flushes one or more data streams or indices. /// public sealed partial class FlushRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs index 8ea7a5286c8..cf81bc2bb2d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs @@ -32,28 +32,28 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class GetAliasRequestParameters : 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) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only. /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Returns an alias. +/// Retrieves information for one or more aliases. /// public sealed partial class GetAliasRequest : PlainRequest { @@ -80,32 +80,32 @@ public GetAliasRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r internal override bool SupportsBody => false; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only. /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Returns an alias. +/// Retrieves information for one or more aliases. /// public sealed partial class GetAliasRequestDescriptor : RequestDescriptor, GetAliasRequestParameters> { @@ -152,7 +152,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns an alias. +/// Retrieves information for one or more aliases. /// public sealed partial class GetAliasRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataLifecycleRequest.g.cs index d0f72f5abf9..8f7f590ab7b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataLifecycleRequest.g.cs @@ -32,12 +32,12 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class GetDataLifecycleRequestParameters : RequestParameters { /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Return all relevant default configurations for the data stream (default: false) + /// If `true`, return all default settings in the response. /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } } @@ -59,13 +59,13 @@ public GetDataLifecycleRequest(Elastic.Clients.Elasticsearch.DataStreamNames nam internal override bool SupportsBody => false; /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Return all relevant default configurations for the data stream (default: false) + /// If `true`, return all default settings in the response. /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataStreamRequest.g.cs index 9804e6d85a4..f88cbb514c2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetDataStreamRequest.g.cs @@ -32,7 +32,7 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class GetDataStreamRequestParameters : RequestParameters { /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } @@ -43,7 +43,7 @@ public sealed class GetDataStreamRequestParameters : RequestParameters } /// -/// Returns data streams. +/// Retrieves information about one or more data streams. /// public sealed partial class GetDataStreamRequest : PlainRequest { @@ -62,7 +62,7 @@ public GetDataStreamRequest(Elastic.Clients.Elasticsearch.DataStreamNames? name) internal override bool SupportsBody => false; /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } @@ -75,7 +75,7 @@ public GetDataStreamRequest(Elastic.Clients.Elasticsearch.DataStreamNames? name) } /// -/// Returns data streams. +/// Retrieves information about one or more data streams. /// public sealed partial class GetDataStreamRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetFieldMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetFieldMappingRequest.g.cs index fccd183cc5d..5d7d4e7795d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetFieldMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetFieldMappingRequest.g.cs @@ -32,33 +32,33 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class GetFieldMappingRequestParameters : 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) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Whether the default mapping values should be returned as well + /// If `true`, return all default settings in the response. /// public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only. /// public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Returns mapping for one or more fields. +/// Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. /// public sealed partial class GetFieldMappingRequest : PlainRequest { @@ -77,38 +77,38 @@ public GetFieldMappingRequest(Elastic.Clients.Elasticsearch.Indices? indices, El internal override bool SupportsBody => false; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Whether the default mapping values should be returned as well + /// If `true`, return all default settings in the response. /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only. /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } } /// -/// Returns mapping for one or more fields. +/// Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. /// public sealed partial class GetFieldMappingRequestDescriptor : RequestDescriptor, GetFieldMappingRequestParameters> { @@ -156,7 +156,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns mapping for one or more fields. +/// Retrieves mapping definitions for one or more fields.
For data streams, the API retrieves field mappings for the stream’s backing indices. /// public sealed partial class GetFieldMappingRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetMappingRequest.g.cs index e671816e8b8..a11a873a926 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetMappingRequest.g.cs @@ -32,33 +32,33 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class GetMappingRequestParameters : 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) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only. /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns mappings for one or more indices. +/// Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. /// public sealed partial class GetMappingRequest : PlainRequest { @@ -77,38 +77,38 @@ public GetMappingRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base( internal override bool SupportsBody => false; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only. /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns mappings for one or more indices. +/// Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. /// public sealed partial class GetMappingRequestDescriptor : RequestDescriptor, GetMappingRequestParameters> { @@ -142,7 +142,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns mappings for one or more indices. +/// Retrieves mapping definitions for one or more indices.
For data streams, the API retrieves mappings for the stream’s backing indices. /// public sealed partial class GetMappingRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetTemplateRequest.g.cs index e5c4a1d0c36..62dec15f8e4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetTemplateRequest.g.cs @@ -32,23 +32,23 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class GetTemplateRequestParameters : RequestParameters { /// - /// Return settings in flat format (default: false) + /// If `true`, returns settings in flat format. /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only. /// public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Explicit operation timeout for connection to master node + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns an index template. +/// Retrieves information about one or more index templates. /// public sealed partial class GetTemplateRequest : PlainRequest { @@ -67,26 +67,26 @@ public GetTemplateRequest(Elastic.Clients.Elasticsearch.Names? name) : base(r => internal override bool SupportsBody => false; /// - /// Return settings in flat format (default: false) + /// If `true`, returns settings in flat format. /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// - /// Return local information, do not retrieve the state from master node (default: false) + /// If `true`, the request retrieves information from the local node only. /// [JsonIgnore] public bool? Local { get => Q("local"); set => Q("local", value); } /// - /// Explicit operation timeout for connection to master node + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// -/// Returns an index template. +/// Retrieves information about one or more index templates. /// public sealed partial class GetTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs index c2d79216f7a..b82262b2eba 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs @@ -78,7 +78,7 @@ public sealed class IndicesStatsRequestParameters : RequestParameters } /// -/// Provides statistics on operations happening in an index. +/// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. /// public sealed partial class IndicesStatsRequest : PlainRequest { @@ -160,7 +160,7 @@ public IndicesStatsRequest(Elastic.Clients.Elasticsearch.Indices? indices, Elast } /// -/// Provides statistics on operations happening in an index. +/// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. /// public sealed partial class IndicesStatsRequestDescriptor : RequestDescriptor, IndicesStatsRequestParameters> { @@ -212,7 +212,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Provides statistics on operations happening in an index. +/// Returns statistics for one or more indices.
For data streams, the API retrieves statistics for the stream’s backing indices. /// public sealed partial class IndicesStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/MigrateToDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/MigrateToDataStreamRequest.g.cs index 6f27477cc11..34596fd279a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/MigrateToDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/MigrateToDataStreamRequest.g.cs @@ -34,7 +34,7 @@ public sealed class MigrateToDataStreamRequestParameters : RequestParameters } /// -/// Migrates an alias to a data stream +/// Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. /// public sealed partial class MigrateToDataStreamRequest : PlainRequest { @@ -50,7 +50,7 @@ public MigrateToDataStreamRequest(Elastic.Clients.Elasticsearch.IndexName name) } /// -/// Migrates an alias to a data stream +/// Converts an index alias to a data stream.
You must have a matching index template that is data stream enabled.
The alias must meet the following criteria:
The alias must have a write index;
All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;
The alias must not have any filters;
The alias must not use custom routing.
If successful, the request removes the alias and creates a data stream with the same name.
The indices for the alias become hidden backing indices for the stream.
The write index for the alias becomes the write index for the stream. /// public sealed partial class MigrateToDataStreamRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/OpenIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/OpenIndexRequest.g.cs index 99fc4abef26..8ec9e8a8821 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/OpenIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/OpenIndexRequest.g.cs @@ -32,38 +32,38 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class OpenIndexRequestParameters : 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) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Sets the number of active shards to wait for before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Opens an index. +/// Opens a closed index.
For data streams, the API opens any closed backing indices. /// public sealed partial class OpenIndexRequest : PlainRequest { @@ -78,44 +78,44 @@ public OpenIndexRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r internal override bool SupportsBody => false; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Sets the number of active shards to wait for before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Opens an index. +/// Opens a closed index.
For data streams, the API opens any closed backing indices. /// public sealed partial class OpenIndexRequestDescriptor : RequestDescriptor, OpenIndexRequestParameters> { @@ -154,7 +154,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Opens an index. +/// Opens a closed index.
For data streams, the API opens any closed backing indices. /// public sealed partial class OpenIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutAliasRequest.g.cs index 5133598b1ef..e0f49c525e3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutAliasRequest.g.cs @@ -32,18 +32,18 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class PutAliasRequestParameters : RequestParameters { /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit timestamp for the document + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Creates or updates an alias. +/// Adds a data stream or index to an alias. /// public sealed partial class PutAliasRequest : PlainRequest { @@ -58,30 +58,50 @@ public PutAliasRequest(Elastic.Clients.Elasticsearch.Indices indices, Elastic.Cl internal override bool SupportsBody => true; /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit timestamp for the document + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + + /// + /// Query used to limit documents the alias can access. + /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; set; } + + /// + /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// [JsonInclude, JsonPropertyName("index_routing")] public Elastic.Clients.Elasticsearch.Routing? IndexRouting { get; set; } + + /// + /// If `true`, sets the write index or data stream for the alias.
If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.
If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.
Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// [JsonInclude, JsonPropertyName("is_write_index")] public bool? IsWriteIndex { get; set; } + + /// + /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } + + /// + /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// [JsonInclude, JsonPropertyName("search_routing")] public Elastic.Clients.Elasticsearch.Routing? SearchRouting { get; set; } } /// -/// Creates or updates an alias. +/// Adds a data stream or index to an alias. /// public sealed partial class PutAliasRequestDescriptor : RequestDescriptor, PutAliasRequestParameters> { @@ -124,6 +144,9 @@ public PutAliasRequestDescriptor Name(Elastic.Clients.Elasticsearch.N private Elastic.Clients.Elasticsearch.Routing? RoutingValue { get; set; } private Elastic.Clients.Elasticsearch.Routing? SearchRoutingValue { get; set; } + /// + /// Query used to limit documents the alias can access. + /// public PutAliasRequestDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { FilterDescriptor = null; @@ -148,24 +171,36 @@ public PutAliasRequestDescriptor Filter(Action + /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// public PutAliasRequestDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? indexRouting) { IndexRoutingValue = indexRouting; return Self; } + /// + /// If `true`, sets the write index or data stream for the alias.
If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.
If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.
Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// public PutAliasRequestDescriptor IsWriteIndex(bool? isWriteIndex = true) { IsWriteIndexValue = isWriteIndex; return Self; } + /// + /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// public PutAliasRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { RoutingValue = routing; return Self; } + /// + /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// public PutAliasRequestDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Routing? searchRouting) { SearchRoutingValue = searchRouting; @@ -220,7 +255,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Creates or updates an alias. +/// Adds a data stream or index to an alias. /// public sealed partial class PutAliasRequestDescriptor : RequestDescriptor { @@ -263,6 +298,9 @@ public PutAliasRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name name) private Elastic.Clients.Elasticsearch.Routing? RoutingValue { get; set; } private Elastic.Clients.Elasticsearch.Routing? SearchRoutingValue { get; set; } + /// + /// Query used to limit documents the alias can access. + /// public PutAliasRequestDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { FilterDescriptor = null; @@ -287,24 +325,36 @@ public PutAliasRequestDescriptor Filter(Action configu return Self; } + /// + /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// public PutAliasRequestDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? indexRouting) { IndexRoutingValue = indexRouting; return Self; } + /// + /// If `true`, sets the write index or data stream for the alias.
If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.
If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.
Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + /// public PutAliasRequestDescriptor IsWriteIndex(bool? isWriteIndex = true) { IsWriteIndexValue = isWriteIndex; return Self; } + /// + /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// public PutAliasRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { RoutingValue = routing; return Self; } + /// + /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// public PutAliasRequestDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Routing? searchRouting) { SearchRoutingValue = searchRouting; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs index 70c49aa4543..04ad7010267 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs @@ -32,17 +32,17 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class PutDataLifecycleRequestParameters : RequestParameters { /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `hidden`, `open`, `closed`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit timestamp for the document + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } @@ -64,22 +64,26 @@ public PutDataLifecycleRequest(Elastic.Clients.Elasticsearch.DataStreamNames nam internal override bool SupportsBody => true; /// - /// Whether wildcard expressions should get expanded to open or closed indices (default: open) + /// Type of data stream that wildcard patterns can match.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `hidden`, `open`, `closed`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit timestamp for the document + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + + /// + /// If defined, every document added to this data stream will be stored at least for this time frame.
Any time after this duration the document could be deleted.
When empty, every document in this data stream will be stored indefinitely. + /// [JsonInclude, JsonPropertyName("data_retention")] public Elastic.Clients.Elasticsearch.Duration? DataRetention { get; set; } } @@ -118,6 +122,9 @@ public PutDataLifecycleRequestDescriptor Name(Elastic.Clients.Elasticsearch.Data private Elastic.Clients.Elasticsearch.Duration? DataRetentionValue { get; set; } + /// + /// If defined, every document added to this data stream will be stored at least for this time frame.
Any time after this duration the document could be deleted.
When empty, every document in this data stream will be stored indefinitely. + /// public PutDataLifecycleRequestDescriptor DataRetention(Elastic.Clients.Elasticsearch.Duration? dataRetention) { DataRetentionValue = dataRetention; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndexTemplateRequest.g.cs index 837658f61d4..8e8f98fc074 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutIndexTemplateRequest.g.cs @@ -32,13 +32,13 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class PutIndexTemplateRequestParameters : RequestParameters { /// - /// Whether the index template should only be added if new or can also replace an existing one + /// If `true`, this request cannot replace or update existing index templates. /// public bool? Create { get => Q("create"); set => Q("create", value); } } /// -/// Creates or updates an index template. +/// Creates or updates an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. /// public sealed partial class PutIndexTemplateRequest : PlainRequest { @@ -53,28 +53,56 @@ public PutIndexTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : base(r internal override bool SupportsBody => true; /// - /// Whether the index template should only be added if new or can also replace an existing one + /// If `true`, this request cannot replace or update existing index templates. /// [JsonIgnore] public bool? Create { get => Q("create"); set => Q("create", value); } + + /// + /// Name of the index template to create. + /// [JsonInclude, JsonPropertyName("index_patterns")] public Elastic.Clients.Elasticsearch.Indices? IndexPatterns { get; set; } + + /// + /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// [JsonInclude, JsonPropertyName("composed_of")] public ICollection? ComposedOf { get; set; } + + /// + /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateMapping? Template { get; set; } + + /// + /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamVisibility? DataStream { get; set; } + + /// + /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// [JsonInclude, JsonPropertyName("priority")] public int? Priority { get; set; } + + /// + /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } + + /// + /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } } /// -/// Creates or updates an index template. +/// Creates or updates an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. /// public sealed partial class PutIndexTemplateRequestDescriptor : RequestDescriptor, PutIndexTemplateRequestParameters> { @@ -114,6 +142,9 @@ public PutIndexTemplateRequestDescriptor Name(Elastic.Clients.Elastic private int? PriorityValue { get; set; } private long? VersionValue { get; set; } + /// + /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// public PutIndexTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateMapping? template) { TemplateDescriptor = null; @@ -138,18 +169,27 @@ public PutIndexTemplateRequestDescriptor Template(Action + /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// public PutIndexTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { MetaValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// public PutIndexTemplateRequestDescriptor ComposedOf(ICollection? composedOf) { ComposedOfValue = composedOf; return Self; } + /// + /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// public PutIndexTemplateRequestDescriptor DataStream(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamVisibility? dataStream) { DataStreamDescriptor = null; @@ -174,18 +214,27 @@ public PutIndexTemplateRequestDescriptor DataStream(Action + /// Name of the index template to create. + /// public PutIndexTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticsearch.Indices? indexPatterns) { IndexPatternsValue = indexPatterns; return Self; } + /// + /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// public PutIndexTemplateRequestDescriptor Priority(int? priority) { PriorityValue = priority; return Self; } + /// + /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// public PutIndexTemplateRequestDescriptor Version(long? version) { VersionValue = version; @@ -262,7 +311,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Creates or updates an index template. +/// Creates or updates an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. /// public sealed partial class PutIndexTemplateRequestDescriptor : RequestDescriptor { @@ -302,6 +351,9 @@ public PutIndexTemplateRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name private int? PriorityValue { get; set; } private long? VersionValue { get; set; } + /// + /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// public PutIndexTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateMapping? template) { TemplateDescriptor = null; @@ -326,18 +378,27 @@ public PutIndexTemplateRequestDescriptor Template(Action + /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// public PutIndexTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { MetaValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// public PutIndexTemplateRequestDescriptor ComposedOf(ICollection? composedOf) { ComposedOfValue = composedOf; return Self; } + /// + /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// public PutIndexTemplateRequestDescriptor DataStream(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamVisibility? dataStream) { DataStreamDescriptor = null; @@ -362,18 +423,27 @@ public PutIndexTemplateRequestDescriptor DataStream(Action + /// Name of the index template to create. + /// public PutIndexTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticsearch.Indices? indexPatterns) { IndexPatternsValue = indexPatterns; return Self; } + /// + /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// public PutIndexTemplateRequestDescriptor Priority(int? priority) { PriorityValue = priority; return Self; } + /// + /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// public PutIndexTemplateRequestDescriptor Version(long? version) { VersionValue = version; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutMappingRequest.g.cs index 5cf2967ddd6..3258a1637c5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutMappingRequest.g.cs @@ -32,38 +32,38 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class PutMappingRequestParameters : 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) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// When true, applies mappings only to the write index of an alias or data stream + /// If `true`, the mappings are applied only to the current write index for the target. /// public bool? WriteIndexOnly { get => Q("write_index_only"); set => Q("write_index_only", value); } } /// -/// Updates the index mappings. +/// Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. /// public sealed partial class PutMappingRequest : PlainRequest { @@ -78,37 +78,37 @@ public PutMappingRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r internal override bool SupportsBody => true; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// When true, applies mappings only to the write index of an alias or data stream + /// If `true`, the mappings are applied only to the current write index for the target. /// [JsonIgnore] public bool? WriteIndexOnly { get => Q("write_index_only"); set => Q("write_index_only", value); } @@ -182,7 +182,7 @@ public PutMappingRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r } /// -/// Updates the index mappings. +/// Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. /// public sealed partial class PutMappingRequestDescriptor : RequestDescriptor, PutMappingRequestParameters> { @@ -513,7 +513,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Updates the index mappings. +/// Adds new fields to an existing data stream or index.
You can also use this API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default. /// public sealed partial class PutMappingRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs index f76a2c9810c..d0d1228d003 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs @@ -35,17 +35,25 @@ public sealed class PutTemplateRequestParameters : RequestParameters /// If true, this request cannot replace or update existing index templates. /// public bool? Create { get => Q("create"); set => Q("create", value); } + + /// + /// If `true`, returns settings in flat format. + /// public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } /// /// Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Creates or updates an index template. +/// Creates or updates an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. /// public sealed partial class PutTemplateRequest : PlainRequest { @@ -64,6 +72,10 @@ public PutTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => r /// [JsonIgnore] public bool? Create { get => Q("create"); set => Q("create", value); } + + /// + /// If `true`, returns settings in flat format. + /// [JsonIgnore] public bool? FlatSettings { get => Q("flat_settings"); set => Q("flat_settings", value); } @@ -72,6 +84,10 @@ public PutTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => r /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. + /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } @@ -114,7 +130,7 @@ public PutTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => r } /// -/// Creates or updates an index template. +/// Creates or updates an index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. /// public sealed partial class PutTemplateRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RefreshRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RefreshRequest.g.cs index a36c5e85f75..34c12c183ab 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RefreshRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RefreshRequest.g.cs @@ -32,23 +32,23 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class RefreshRequestParameters : 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) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Performs the refresh operation in one or more indices. +/// A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. /// public sealed partial class RefreshRequest : PlainRequest { @@ -67,26 +67,26 @@ public RefreshRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r = internal override bool SupportsBody => false; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices. /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`.
Valid values are: `all`, `open`, `closed`, `hidden`, `none`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// -/// Performs the refresh operation in one or more indices. +/// A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. /// public sealed partial class RefreshRequestDescriptor : RequestDescriptor, RefreshRequestParameters> { @@ -118,7 +118,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Performs the refresh operation in one or more indices. +/// A refresh makes recent operations performed on one or more indices available for search.
For data streams, the API runs the refresh operation on the stream’s backing indices. /// public sealed partial class RefreshRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RolloverRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RolloverRequest.g.cs index 97b9341f7c0..09217180380 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RolloverRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RolloverRequest.g.cs @@ -32,28 +32,28 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class RolloverRequestParameters : RequestParameters { /// - /// If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false + /// If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. /// public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Set the number of active shards to wait for on the newly created rollover index before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Updates an alias to point to a new index when the existing index
is considered to be too large or too old. +/// Creates a new index for a data stream or index alias. /// public sealed partial class RolloverRequest : PlainRequest { @@ -72,40 +72,56 @@ public RolloverRequest(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.C internal override bool SupportsBody => true; /// - /// If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false + /// If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. /// [JsonIgnore] public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Set the number of active shards to wait for on the newly created rollover index before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } + + /// + /// Aliases for the target index.
Data streams do not support this parameter. + /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } + + /// + /// Conditions for the rollover.
If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.
If this parameter is not specified, Elasticsearch performs the rollover unconditionally.
If conditions are specified, at least one of them must be a `max_*` condition.
The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied. + /// [JsonInclude, JsonPropertyName("conditions")] public Elastic.Clients.Elasticsearch.IndexManagement.RolloverConditions? Conditions { get; set; } + + /// + /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping paramaters. + /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Mapping.TypeMapping? Mappings { get; set; } + + /// + /// Configuration options for the index.
Data streams do not support this parameter. + /// [JsonInclude, JsonPropertyName("settings")] public IDictionary? Settings { get; set; } } /// -/// Updates an alias to point to a new index when the existing index
is considered to be too large or too old. +/// Creates a new index for a data stream or index alias. /// public sealed partial class RolloverRequestDescriptor : RequestDescriptor { @@ -155,12 +171,18 @@ public RolloverRequestDescriptor NewIndex(Elastic.Clients.Elasticsearch.IndexNam private Action MappingsDescriptorAction { get; set; } private IDictionary? SettingsValue { get; set; } + /// + /// Aliases for the target index.
Data streams do not support this parameter. + /// public RolloverRequestDescriptor Aliases(Func, FluentDictionary> selector) { AliasesValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// Conditions for the rollover.
If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.
If this parameter is not specified, Elasticsearch performs the rollover unconditionally.
If conditions are specified, at least one of them must be a `max_*` condition.
The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied. + /// public RolloverRequestDescriptor Conditions(Elastic.Clients.Elasticsearch.IndexManagement.RolloverConditions? conditions) { ConditionsDescriptor = null; @@ -185,6 +207,9 @@ public RolloverRequestDescriptor Conditions(Action return Self; } + /// + /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping paramaters. + /// public RolloverRequestDescriptor Mappings(Elastic.Clients.Elasticsearch.Mapping.TypeMapping? mappings) { MappingsDescriptor = null; @@ -209,6 +234,9 @@ public RolloverRequestDescriptor Mappings(Action return Self; } + /// + /// Configuration options for the index.
Data streams do not support this parameter. + /// public RolloverRequestDescriptor Settings(Func, FluentDictionary> selector) { SettingsValue = selector?.Invoke(new FluentDictionary()); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShrinkIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShrinkIndexRequest.g.cs index 9d723e43b27..05b6ab29b24 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShrinkIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShrinkIndexRequest.g.cs @@ -32,23 +32,23 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class ShrinkIndexRequestParameters : RequestParameters { /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Set the number of active shards to wait for on the shrunken index before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Allow to shrink an existing index into a new index with fewer primary shards. +/// Shrinks an existing index into a new index with fewer primary shards. /// public sealed partial class ShrinkIndexRequest : PlainRequest { @@ -63,30 +63,38 @@ public ShrinkIndexRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic internal override bool SupportsBody => true; /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Set the number of active shards to wait for on the shrunken index before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } + + /// + /// The key is the alias name.
Index alias names support date math. + /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } + + /// + /// Configuration options for the target index. + /// [JsonInclude, JsonPropertyName("settings")] public IDictionary? Settings { get; set; } } /// -/// Allow to shrink an existing index into a new index with fewer primary shards. +/// Shrinks an existing index into a new index with fewer primary shards. /// public sealed partial class ShrinkIndexRequestDescriptor : RequestDescriptor, ShrinkIndexRequestParameters> { @@ -125,12 +133,18 @@ public ShrinkIndexRequestDescriptor Target(Elastic.Clients.Elasticsea private IDictionary? AliasesValue { get; set; } private IDictionary? SettingsValue { get; set; } + /// + /// The key is the alias name.
Index alias names support date math. + /// public ShrinkIndexRequestDescriptor Aliases(Func, FluentDictionary> selector) { AliasesValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// Configuration options for the target index. + /// public ShrinkIndexRequestDescriptor Settings(Func, FluentDictionary> selector) { SettingsValue = selector?.Invoke(new FluentDictionary()); @@ -157,7 +171,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Allow to shrink an existing index into a new index with fewer primary shards. +/// Shrinks an existing index into a new index with fewer primary shards. /// public sealed partial class ShrinkIndexRequestDescriptor : RequestDescriptor { @@ -196,12 +210,18 @@ public ShrinkIndexRequestDescriptor Target(Elastic.Clients.Elasticsearch.IndexNa private IDictionary? AliasesValue { get; set; } private IDictionary? SettingsValue { get; set; } + /// + /// The key is the alias name.
Index alias names support date math. + /// public ShrinkIndexRequestDescriptor Aliases(Func, FluentDictionary> selector) { AliasesValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// Configuration options for the target index. + /// public ShrinkIndexRequestDescriptor Settings(Func, FluentDictionary> selector) { SettingsValue = selector?.Invoke(new FluentDictionary()); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SimulateIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SimulateIndexTemplateRequest.g.cs index c19573c80f8..6e09577e657 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SimulateIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SimulateIndexTemplateRequest.g.cs @@ -47,9 +47,6 @@ public sealed class SimulateIndexTemplateRequestParameters : RequestParameters public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } } -/// -/// Simulate matching the given index name against the index templates in the system -/// public sealed partial class SimulateIndexTemplateRequest : PlainRequest { public SimulateIndexTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => r.Required("name", name)) @@ -79,27 +76,56 @@ public SimulateIndexTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : b /// [JsonIgnore] public bool? IncludeDefaults { get => Q("include_defaults"); set => Q("include_defaults", value); } + + /// + /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// [JsonInclude, JsonPropertyName("allow_auto_create")] public bool? AllowAutoCreate { get; set; } + + /// + /// Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. + /// [JsonInclude, JsonPropertyName("index_patterns")] public Elastic.Clients.Elasticsearch.Indices? IndexPatterns { get; set; } + + /// + /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// [JsonInclude, JsonPropertyName("composed_of")] public ICollection? ComposedOf { get; set; } + + /// + /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateMapping? Template { get; set; } + + /// + /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamVisibility? DataStream { get; set; } + + /// + /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// [JsonInclude, JsonPropertyName("priority")] public int? Priority { get; set; } + + /// + /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } + + /// + /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// [JsonInclude, JsonPropertyName("_meta")] public IDictionary? Meta { get; set; } } -/// -/// Simulate matching the given index name against the index templates in the system -/// public sealed partial class SimulateIndexTemplateRequestDescriptor : RequestDescriptor, SimulateIndexTemplateRequestParameters> { internal SimulateIndexTemplateRequestDescriptor(Action> configure) => configure.Invoke(this); @@ -141,6 +167,9 @@ public SimulateIndexTemplateRequestDescriptor Name(Elastic.Clients.El private int? PriorityValue { get; set; } private long? VersionValue { get; set; } + /// + /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// public SimulateIndexTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateMapping? template) { TemplateDescriptor = null; @@ -165,24 +194,36 @@ public SimulateIndexTemplateRequestDescriptor Template(Action + /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// public SimulateIndexTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { MetaValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// public SimulateIndexTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = true) { AllowAutoCreateValue = allowAutoCreate; return Self; } + /// + /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// public SimulateIndexTemplateRequestDescriptor ComposedOf(ICollection? composedOf) { ComposedOfValue = composedOf; return Self; } + /// + /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// public SimulateIndexTemplateRequestDescriptor DataStream(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamVisibility? dataStream) { DataStreamDescriptor = null; @@ -207,18 +248,27 @@ public SimulateIndexTemplateRequestDescriptor DataStream(Action + /// Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. + /// public SimulateIndexTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticsearch.Indices? indexPatterns) { IndexPatternsValue = indexPatterns; return Self; } + /// + /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// public SimulateIndexTemplateRequestDescriptor Priority(int? priority) { PriorityValue = priority; return Self; } + /// + /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// public SimulateIndexTemplateRequestDescriptor Version(long? version) { VersionValue = version; @@ -300,9 +350,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } } -/// -/// Simulate matching the given index name against the index templates in the system -/// public sealed partial class SimulateIndexTemplateRequestDescriptor : RequestDescriptor { internal SimulateIndexTemplateRequestDescriptor(Action configure) => configure.Invoke(this); @@ -344,6 +391,9 @@ public SimulateIndexTemplateRequestDescriptor Name(Elastic.Clients.Elasticsearch private int? PriorityValue { get; set; } private long? VersionValue { get; set; } + /// + /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// public SimulateIndexTemplateRequestDescriptor Template(Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateMapping? template) { TemplateDescriptor = null; @@ -368,24 +418,36 @@ public SimulateIndexTemplateRequestDescriptor Template(Action + /// Optional user metadata about the index template.
May have any contents.
This map is not automatically generated by Elasticsearch. + /// public SimulateIndexTemplateRequestDescriptor Meta(Func, FluentDictionary> selector) { MetaValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// This setting overrides the value of the `action.auto_create_index` cluster setting.
If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.
If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + /// public SimulateIndexTemplateRequestDescriptor AllowAutoCreate(bool? allowAutoCreate = true) { AllowAutoCreateValue = allowAutoCreate; return Self; } + /// + /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// public SimulateIndexTemplateRequestDescriptor ComposedOf(ICollection? composedOf) { ComposedOfValue = composedOf; return Self; } + /// + /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// public SimulateIndexTemplateRequestDescriptor DataStream(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamVisibility? dataStream) { DataStreamDescriptor = null; @@ -410,18 +472,27 @@ public SimulateIndexTemplateRequestDescriptor DataStream(Action + /// Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. + /// public SimulateIndexTemplateRequestDescriptor IndexPatterns(Elastic.Clients.Elasticsearch.Indices? indexPatterns) { IndexPatternsValue = indexPatterns; return Self; } + /// + /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// public SimulateIndexTemplateRequestDescriptor Priority(int? priority) { PriorityValue = priority; return Self; } + /// + /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// public SimulateIndexTemplateRequestDescriptor Version(long? version) { VersionValue = version; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SplitIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SplitIndexRequest.g.cs index f2a0a471509..d7b95446aaf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SplitIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SplitIndexRequest.g.cs @@ -32,23 +32,23 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class SplitIndexRequestParameters : RequestParameters { /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Set the number of active shards to wait for on the shrunken index before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } /// -/// Allows you to split an existing index into a new index with more primary shards. +/// Splits an existing index into a new index with more primary shards. /// public sealed partial class SplitIndexRequest : PlainRequest { @@ -63,30 +63,38 @@ public SplitIndexRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic. internal override bool SupportsBody => true; /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } /// - /// Set the number of active shards to wait for on the shrunken index before the operation returns. + /// The number of shard copies that must be active before proceeding with the operation.
Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } + + /// + /// Aliases for the resulting index. + /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } + + /// + /// Configuration options for the target index. + /// [JsonInclude, JsonPropertyName("settings")] public IDictionary? Settings { get; set; } } /// -/// Allows you to split an existing index into a new index with more primary shards. +/// Splits an existing index into a new index with more primary shards. /// public sealed partial class SplitIndexRequestDescriptor : RequestDescriptor, SplitIndexRequestParameters> { @@ -125,12 +133,18 @@ public SplitIndexRequestDescriptor Target(Elastic.Clients.Elasticsear private IDictionary? AliasesValue { get; set; } private IDictionary? SettingsValue { get; set; } + /// + /// Aliases for the resulting index. + /// public SplitIndexRequestDescriptor Aliases(Func, FluentDictionary> selector) { AliasesValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// Configuration options for the target index. + /// public SplitIndexRequestDescriptor Settings(Func, FluentDictionary> selector) { SettingsValue = selector?.Invoke(new FluentDictionary()); @@ -157,7 +171,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Allows you to split an existing index into a new index with more primary shards. +/// Splits an existing index into a new index with more primary shards. /// public sealed partial class SplitIndexRequestDescriptor : RequestDescriptor { @@ -196,12 +210,18 @@ public SplitIndexRequestDescriptor Target(Elastic.Clients.Elasticsearch.IndexNam private IDictionary? AliasesValue { get; set; } private IDictionary? SettingsValue { get; set; } + /// + /// Aliases for the resulting index. + /// public SplitIndexRequestDescriptor Aliases(Func, FluentDictionary> selector) { AliasesValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// Configuration options for the target index. + /// public SplitIndexRequestDescriptor Settings(Func, FluentDictionary> selector) { SettingsValue = selector?.Invoke(new FluentDictionary()); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/UpdateAliasesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/UpdateAliasesRequest.g.cs index ca7a803c217..4b5fb352a90 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/UpdateAliasesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/UpdateAliasesRequest.g.cs @@ -32,18 +32,18 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed class UpdateAliasesRequestParameters : RequestParameters { /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Request timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Updates index aliases. +/// Adds a data stream or index to an alias. /// public sealed partial class UpdateAliasesRequest : PlainRequest { @@ -54,22 +54,26 @@ public sealed partial class UpdateAliasesRequest : PlainRequest true; /// - /// Specify timeout for connection to master + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Request timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + + /// + /// Actions to perform. + /// [JsonInclude, JsonPropertyName("actions")] public ICollection? Actions { get; set; } } /// -/// Updates index aliases. +/// Adds a data stream or index to an alias. /// public sealed partial class UpdateAliasesRequestDescriptor : RequestDescriptor, UpdateAliasesRequestParameters> { @@ -93,6 +97,9 @@ public UpdateAliasesRequestDescriptor() private Action ActionsDescriptorAction { get; set; } private Action[] ActionsDescriptorActions { get; set; } + /// + /// Actions to perform. + /// public UpdateAliasesRequestDescriptor Actions(ICollection? actions) { ActionsDescriptor = null; @@ -168,7 +175,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Updates index aliases. +/// Adds a data stream or index to an alias. /// public sealed partial class UpdateAliasesRequestDescriptor : RequestDescriptor { @@ -192,6 +199,9 @@ public UpdateAliasesRequestDescriptor() private Action ActionsDescriptorAction { get; set; } private Action[] ActionsDescriptorActions { get; set; } + /// + /// Actions to perform. + /// public UpdateAliasesRequestDescriptor Actions(ICollection? actions) { ActionsDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineRequest.g.cs index a1840516015..49a5f57b3f3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineRequest.g.cs @@ -32,18 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed class DeletePipelineRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes a pipeline. +/// Deletes one or more existing ingest pipeline. /// public sealed partial class DeletePipelineRequest : PlainRequest { @@ -58,20 +58,20 @@ public DeletePipelineRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r. internal override bool SupportsBody => false; /// - /// Explicit operation timeout for connection to master node + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } /// - /// Explicit operation timeout + /// Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } } /// -/// Deletes a pipeline. +/// Deletes one or more existing ingest pipeline. /// public sealed partial class DeletePipelineRequestDescriptor : RequestDescriptor, DeletePipelineRequestParameters> { @@ -106,7 +106,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Deletes a pipeline. +/// Deletes one or more existing ingest pipeline. /// public sealed partial class DeletePipelineRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs index e291d2add5e..0872d69a36a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs @@ -34,7 +34,7 @@ public sealed class GeoIpStatsRequestParameters : RequestParameters } /// -/// Returns statistical information about geoip databases +/// Gets download statistics for GeoIP2 databases used with the geoip processor. /// public sealed partial class GeoIpStatsRequest : PlainRequest { @@ -46,7 +46,7 @@ public sealed partial class GeoIpStatsRequest : PlainRequest -/// Returns statistical information about geoip databases +/// Gets download statistics for GeoIP2 databases used with the geoip processor. /// public sealed partial class GeoIpStatsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetPipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetPipelineRequest.g.cs index 7397ee8c5cc..ad14953bbbd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetPipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetPipelineRequest.g.cs @@ -32,7 +32,7 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed class GetPipelineRequestParameters : RequestParameters { /// - /// Explicit operation timeout for connection to master node + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } @@ -43,7 +43,7 @@ public sealed class GetPipelineRequestParameters : RequestParameters } /// -/// Returns a pipeline. +/// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. /// public sealed partial class GetPipelineRequest : PlainRequest { @@ -62,7 +62,7 @@ public GetPipelineRequest(Elastic.Clients.Elasticsearch.Id? id) : base(r => r.Op internal override bool SupportsBody => false; /// - /// Explicit operation timeout for connection to master node + /// Period to wait for a connection to the master node.
If no response is received before the timeout expires, the request fails and returns an error. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } @@ -75,7 +75,7 @@ public GetPipelineRequest(Elastic.Clients.Elasticsearch.Id? id) : base(r => r.Op } /// -/// Returns a pipeline. +/// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. /// public sealed partial class GetPipelineRequestDescriptor : RequestDescriptor, GetPipelineRequestParameters> { @@ -106,7 +106,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns a pipeline. +/// Returns information about one or more ingest pipelines.
This API returns a local reference of the pipeline. /// public sealed partial class GetPipelineRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs index 80cef112a30..ddd9e240b3f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs @@ -34,7 +34,7 @@ public sealed class ProcessorGrokRequestParameters : RequestParameters } /// -/// Returns a list of the built-in patterns. +/// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. /// public sealed partial class ProcessorGrokRequest : PlainRequest { @@ -46,7 +46,7 @@ public sealed partial class ProcessorGrokRequest : PlainRequest -/// Returns a list of the built-in patterns. +/// Extracts structured fields out of a single text field within a document.
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
A grok pattern is like a regular expression that supports aliased expressions that can be reused. /// public sealed partial class ProcessorGrokRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineRequest.g.cs index cc91d3081c5..dc472adf40e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineRequest.g.cs @@ -48,7 +48,7 @@ public sealed class PutPipelineRequestParameters : RequestParameters } /// -/// Creates or updates a pipeline. +/// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. /// public sealed partial class PutPipelineRequest : PlainRequest { @@ -112,7 +112,7 @@ public PutPipelineRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Req } /// -/// Creates or updates a pipeline. +/// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. /// public sealed partial class PutPipelineRequestDescriptor : RequestDescriptor, PutPipelineRequestParameters> { @@ -347,7 +347,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Creates or updates a pipeline. +/// Creates or updates an ingest pipeline.
Changes made using this API take effect immediately. /// public sealed partial class PutPipelineRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/SimulateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/SimulateRequest.g.cs index 5732254e160..b59696b8682 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/SimulateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/SimulateRequest.g.cs @@ -32,13 +32,13 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed class SimulateRequestParameters : RequestParameters { /// - /// Verbose mode. Display data output for each processor in executed pipeline + /// If `true`, the response includes output data for each processor in the executed pipeline. /// public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// -/// Allows to simulate a pipeline with example documents. +/// Executes an ingest pipeline against a set of provided documents. /// public sealed partial class SimulateRequest : PlainRequest { @@ -57,18 +57,26 @@ public SimulateRequest(Elastic.Clients.Elasticsearch.Id? id) : base(r => r.Optio internal override bool SupportsBody => true; /// - /// Verbose mode. Display data output for each processor in executed pipeline + /// If `true`, the response includes output data for each processor in the executed pipeline. /// [JsonIgnore] public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } + + /// + /// Sample documents to test in the pipeline. + /// [JsonInclude, JsonPropertyName("docs")] public ICollection? Docs { get; set; } + + /// + /// Pipeline to test.
If you don’t specify the `pipeline` request path parameter, this parameter is required.
If you specify both this and the request path parameter, the API only uses the request path parameter. + /// [JsonInclude, JsonPropertyName("pipeline")] public Elastic.Clients.Elasticsearch.Ingest.Pipeline? Pipeline { get; set; } } /// -/// Allows to simulate a pipeline with example documents. +/// Executes an ingest pipeline against a set of provided documents. /// public sealed partial class SimulateRequestDescriptor : RequestDescriptor, SimulateRequestParameters> { @@ -100,6 +108,9 @@ public SimulateRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id? private Action DocsDescriptorAction { get; set; } private Action[] DocsDescriptorActions { get; set; } + /// + /// Pipeline to test.
If you don’t specify the `pipeline` request path parameter, this parameter is required.
If you specify both this and the request path parameter, the API only uses the request path parameter. + /// public SimulateRequestDescriptor Pipeline(Elastic.Clients.Elasticsearch.Ingest.Pipeline? pipeline) { PipelineDescriptor = null; @@ -124,6 +135,9 @@ public SimulateRequestDescriptor Pipeline(Action + /// Sample documents to test in the pipeline. + /// public SimulateRequestDescriptor Docs(ICollection? docs) { DocsDescriptor = null; @@ -215,7 +229,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Allows to simulate a pipeline with example documents. +/// Executes an ingest pipeline against a set of provided documents. /// public sealed partial class SimulateRequestDescriptor : RequestDescriptor { @@ -247,6 +261,9 @@ public SimulateRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) private Action DocsDescriptorAction { get; set; } private Action[] DocsDescriptorActions { get; set; } + /// + /// Pipeline to test.
If you don’t specify the `pipeline` request path parameter, this parameter is required.
If you specify both this and the request path parameter, the API only uses the request path parameter. + /// public SimulateRequestDescriptor Pipeline(Elastic.Clients.Elasticsearch.Ingest.Pipeline? pipeline) { PipelineDescriptor = null; @@ -271,6 +288,9 @@ public SimulateRequestDescriptor Pipeline(Action configure) return Self; } + /// + /// Sample documents to test in the pipeline. + /// public SimulateRequestDescriptor Docs(ICollection? docs) { DocsDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchRequest.g.cs index 94580d24a97..fcfbd5dd268 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchRequest.g.cs @@ -32,102 +32,102 @@ namespace Elastic.Clients.Elasticsearch; public sealed class SearchRequestParameters : 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) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Indicate if an error should be returned if there is a partial search failure or timeout + /// If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. /// public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } /// - /// The analyzer to use for the query string + /// Analyzer to use for the query string.
This parameter can only be used when the q query string parameter is specified. /// public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// Specify whether wildcard and prefix queries should be analyzed (default: false) + /// If true, wildcard and prefix queries are analyzed.
This parameter can only be used when the q query string parameter is specified. /// public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. + /// The number of shard results that should be reduced at once on the coordinating node.
This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. /// public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", value); } /// - /// Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + /// If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. /// public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// The default operator for query string query (AND or OR) + /// The default operator for query string query: AND or OR.
This parameter can only be used when the `q` query string parameter is specified. /// public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// The field to use as default where no field prefix is given in the query string + /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the q query string parameter is specified. /// public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. /// public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete, expanded or aliased indices should be ignored when throttled + /// If `true`, concrete, expanded or aliased indices will be ignored when frozen. /// public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specify whether format-based query failures (such as providing text to a numeric field) should be ignored + /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
This parameter can only be used when the `q` query string parameter is specified. /// public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + /// Defines the number of concurrent shard requests per node this search executes concurrently.
This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } /// - /// The minimum compatible version that all shards involved in search should have for this request to be successful + /// The minimum version of the node that can handle the request
Any handling node with a lower version will fail the request. /// public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// - /// Specify the node or shard the operation should be performed on (default: random) + /// Nodes and shards used for the search.
By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:
`_only_local` to run the search only on shards on the local node;
`_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method;
`_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method;
`_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method;
`_shards:,` to run the search only on the specified shards;
`` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. /// public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.
This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).
When unspecified, the pre-filter phase is executed if any of these conditions is met:
the request targets more than 128 shards;
the request targets one or more read-only index;
the primary sort of the query targets an indexed field. /// public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// Specify if request cache should be used for this request or not, defaults to index level setting + /// If `true`, the caching of search results is enabled for requests where `size` is `0`.
Defaults to index level settings. /// public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// A comma-separated list of specific routing values + /// Custom value used to route operations to a specific shard. /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specify how long a consistent view of the index should be maintained for scrolled search + /// Period to retain the search context for scrolling. See Scroll search results.
By default, this value cannot exceed `1d` (24 hours).
You can change this limit using the `search.max_keep_alive` cluster-level setting. /// public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Search operation type + /// How distributed term frequencies are calculated for relevance scoring. /// public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } @@ -137,42 +137,42 @@ public sealed class SearchRequestParameters : RequestParameters public Elastic.Clients.Elasticsearch.Field? SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); } /// - /// Specify suggest mode + /// Specifies the suggest mode.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. /// public Elastic.Clients.Elasticsearch.SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); } /// - /// How many suggestions to return in response + /// Number of suggestions to return.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. /// public long? SuggestSize { get => Q("suggest_size"); set => Q("suggest_size", value); } /// - /// The source text for which the suggestions should be returned. + /// The source text for which the suggestions should be returned.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. /// public string? SuggestText { get => Q("suggest_text"); set => Q("suggest_text", value); } /// - /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// If `true`, aggregation and suggester names are be prefixed by their respective types in the response. /// public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response + /// Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. /// public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// A list of fields to exclude from the returned _source field + /// A comma-separated list of source fields to exclude from the response.
You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. /// public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A list of fields to extract and return from the _source field + /// A comma-separated list of source fields to include in the response.
If this parameter is specified, only these source fields are returned.
You can exclude fields from this subset using the `_source_excludes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. /// public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Query in the Lucene query string syntax + /// Query in the Lucene query string syntax using query parameter search.
Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. /// public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } } @@ -599,7 +599,7 @@ public override void Write(Utf8JsonWriter writer, SearchRequest value, JsonSeria [JsonConverter(typeof(SearchRequestConverter))] /// -/// Returns results matching a query. +/// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. /// public partial class SearchRequest : PlainRequest { @@ -618,121 +618,121 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => internal override bool SupportsBody => true; /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
This behavior applies even if the request targets other open indices.
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. /// [JsonIgnore] public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } /// - /// Indicate if an error should be returned if there is a partial search failure or timeout + /// If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. /// [JsonIgnore] public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } /// - /// The analyzer to use for the query string + /// Analyzer to use for the query string.
This parameter can only be used when the q query string parameter is specified. /// [JsonIgnore] public string? Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// - /// Specify whether wildcard and prefix queries should be analyzed (default: false) + /// If true, wildcard and prefix queries are analyzed.
This parameter can only be used when the q query string parameter is specified. /// [JsonIgnore] public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } /// - /// The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. + /// The number of shard results that should be reduced at once on the coordinating node.
This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. /// [JsonIgnore] public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", value); } /// - /// Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + /// If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. /// [JsonIgnore] public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } /// - /// The default operator for query string query (AND or OR) + /// The default operator for query string query: AND or OR.
This parameter can only be used when the `q` query string parameter is specified. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } /// - /// The field to use as default where no field prefix is given in the query string + /// Field to use as default where no field prefix is given in the query string.
This parameter can only be used when the q query string parameter is specified. /// [JsonIgnore] public string? Df { get => Q("df"); set => Q("df", value); } /// - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Type of index that wildcard patterns can match.
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
Supports comma-separated values, such as `open,hidden`. /// [JsonIgnore] public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } /// - /// Whether specified concrete, expanded or aliased indices should be ignored when throttled + /// If `true`, concrete, expanded or aliased indices will be ignored when frozen. /// [JsonIgnore] public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } /// - /// Whether specified concrete indices should be ignored when unavailable (missing or closed) + /// If `false`, the request returns an error if it targets a missing or closed index. /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } /// - /// Specify whether format-based query failures (such as providing text to a numeric field) should be ignored + /// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
This parameter can only be used when the `q` query string parameter is specified. /// [JsonIgnore] public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// - /// The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + /// Defines the number of concurrent shard requests per node this search executes concurrently.
This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. /// [JsonIgnore] public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } /// - /// The minimum compatible version that all shards involved in search should have for this request to be successful + /// The minimum version of the node that can handle the request
Any handling node with a lower version will fail the request. /// [JsonIgnore] public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// - /// Specify the node or shard the operation should be performed on (default: random) + /// Nodes and shards used for the search.
By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are:
`_only_local` to run the search only on shards on the local node;
`_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method;
`_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method;
`_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method;
`_shards:,` to run the search only on the specified shards;
`` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. /// [JsonIgnore] public string? Preference { get => Q("preference"); set => Q("preference", value); } /// - /// A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + /// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold.
This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint).
When unspecified, the pre-filter phase is executed if any of these conditions is met:
the request targets more than 128 shards;
the request targets one or more read-only index;
the primary sort of the query targets an indexed field. /// [JsonIgnore] public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } /// - /// Specify if request cache should be used for this request or not, defaults to index level setting + /// If `true`, the caching of search results is enabled for requests where `size` is `0`.
Defaults to index level settings. /// [JsonIgnore] public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// - /// A comma-separated list of specific routing values + /// Custom value used to route operations to a specific shard. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } /// - /// Specify how long a consistent view of the index should be maintained for scrolled search + /// Period to retain the search context for scrolling. See Scroll search results.
By default, this value cannot exceed `1d` (24 hours).
You can change this limit using the `search.max_keep_alive` cluster-level setting. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// - /// Search operation type + /// How distributed term frequencies are calculated for relevance scoring. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } @@ -744,54 +744,62 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => public Elastic.Clients.Elasticsearch.Field? SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); } /// - /// Specify suggest mode + /// Specifies the suggest mode.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); } /// - /// How many suggestions to return in response + /// Number of suggestions to return.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. /// [JsonIgnore] public long? SuggestSize { get => Q("suggest_size"); set => Q("suggest_size", value); } /// - /// The source text for which the suggestions should be returned. + /// The source text for which the suggestions should be returned.
This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. /// [JsonIgnore] public string? SuggestText { get => Q("suggest_text"); set => Q("suggest_text", value); } /// - /// Specify whether aggregation and suggester names should be prefixed by their respective types in the response + /// If `true`, aggregation and suggester names are be prefixed by their respective types in the response. /// [JsonIgnore] public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } /// - /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response + /// Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. /// [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// - /// A list of fields to exclude from the returned _source field + /// A comma-separated list of source fields to exclude from the response.
You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } /// - /// A list of fields to extract and return from the _source field + /// A comma-separated list of source fields to include in the response.
If this parameter is specified, only these source fields are returned.
You can exclude fields from this subset using the `_source_excludes` query parameter.
If the `_source` parameter is `false`, this parameter is ignored. /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Fields? SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } /// - /// Query in the Lucene query string syntax + /// Query in the Lucene query string syntax using query parameter search.
Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. /// [JsonIgnore] public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } + + /// + /// Defines the aggregations that are run as part of the search request. + /// [JsonInclude, JsonPropertyName("aggregations")] public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// Collapses search results the values of the specified field. + /// [JsonInclude, JsonPropertyName("collapse")] public Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? Collapse { get; set; } @@ -808,15 +816,19 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => 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. + /// Starting document offset.
Needs to be non-negative.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } + + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// [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. + /// Number of hits matching the query to count accurately.
If `true`, the exact number of hits is returned at the cost of some performance.
If `false`, the response does not include the total number of hits matching the query. /// [JsonInclude, JsonPropertyName("track_total_hits")] public Elastic.Clients.Elasticsearch.Core.Search.TrackHits? TrackTotalHits { get; set; } @@ -828,7 +840,7 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => 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. + /// 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; } @@ -840,18 +852,26 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => public ICollection? Knn { get; set; } /// - /// Defines the Reciprocal Rank Fusion (RRF) to use + /// Defines the Reciprocal Rank Fusion (RRF) to use. /// [JsonInclude, JsonPropertyName("rank")] public Elastic.Clients.Elasticsearch.Rank? Rank { get; set; } /// - /// 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; } + + /// + /// Use the `post_filter` parameter to filter search results.
The search hits are filtered after the aggregations are calculated.
A post filter has no impact on the aggregation results. + /// [JsonInclude, JsonPropertyName("post_filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? PostFilter { get; set; } + + /// + /// Set to `true` to return detailed timing information about the execution of individual components in a search request.
NOTE: This is a debugging tool and adds significant overhead to search execution. + /// [JsonInclude, JsonPropertyName("profile")] public bool? Profile { get; set; } @@ -860,6 +880,10 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } + + /// + /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + /// [JsonInclude, JsonPropertyName("rescore"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Core.Search.Rescore))] public ICollection? Rescore { get; set; } @@ -868,41 +892,57 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => /// [JsonInclude, JsonPropertyName("script_fields")] public IDictionary? ScriptFields { get; set; } + + /// + /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// [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. + /// The number of hits to return.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } + + /// + /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// [JsonInclude, JsonPropertyName("slice")] public Elastic.Clients.Elasticsearch.SlicedScroll? Slice { get; set; } + + /// + /// A comma-separated list of : pairs. + /// [JsonInclude, JsonPropertyName("sort"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.SortOptions))] public ICollection? Sort { get; set; } /// - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// Indicates which source fields are returned for matching documents.
These fields are returned in the hits._source property of the search response. /// [JsonInclude, JsonPropertyName("_source")] public Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? Source { get; set; } /// - /// 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; } + + /// + /// Defines a suggester that provides similar looking terms based on a provided text. + /// [JsonInclude, JsonPropertyName("suggest")] public Elastic.Clients.Elasticsearch.Core.Search.Suggester? Suggest { get; set; } /// - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. 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.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
If set to `0` (default), the query does not terminate early. /// [JsonInclude, JsonPropertyName("terminate_after")] public long? TerminateAfter { get; set; } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. /// [JsonInclude, JsonPropertyName("timeout")] public string? Timeout { get; set; } @@ -920,38 +960,38 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => public bool? Version { 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. /// [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. + /// 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. + /// 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. + /// 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. + /// 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; } } /// -/// Returns results matching a query. +/// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. /// public partial class SearchRequest : SearchRequest { @@ -961,7 +1001,7 @@ public SearchRequest() : base(typeof(TInferDocument)) } /// -/// Returns results matching a query. +/// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. /// public sealed partial class SearchRequestDescriptor : RequestDescriptor, SearchRequestParameters> { @@ -1084,6 +1124,9 @@ public SearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch. private Elastic.Clients.Elasticsearch.Core.Search.TrackHits? TrackTotalHitsValue { get; set; } private bool? VersionValue { get; set; } + /// + /// Defines the aggregations that are run as part of the search request. + /// public SearchRequestDescriptor Aggregations(Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? aggregations) { AggregationsDescriptor = null; @@ -1108,6 +1151,9 @@ public SearchRequestDescriptor Aggregations(Action + /// Collapses search results the values of the specified field. + /// public SearchRequestDescriptor Collapse(Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? collapse) { CollapseDescriptor = null; @@ -1133,7 +1179,7 @@ public SearchRequestDescriptor Collapse(Action - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// Array of wildcard (`*`) patterns.
The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. /// public SearchRequestDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -1172,7 +1218,7 @@ public SearchRequestDescriptor 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. + /// Array of wildcard (`*`) patterns.
The request returns values for field names matching these patterns in the `hits.fields` property of the response. /// public SearchRequestDescriptor Fields(ICollection? fields) { @@ -1210,6 +1256,9 @@ public SearchRequestDescriptor Fields(params Action + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// public SearchRequestDescriptor Highlight(Elastic.Clients.Elasticsearch.Core.Search.Highlight? highlight) { HighlightDescriptor = null; @@ -1273,6 +1322,9 @@ public SearchRequestDescriptor Knn(params Action + /// Use the `post_filter` parameter to filter search results.
The search hits are filtered after the aggregations are calculated.
A post filter has no impact on the aggregation results. + /// public SearchRequestDescriptor PostFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? postFilter) { PostFilterDescriptor = null; @@ -1324,6 +1376,9 @@ public SearchRequestDescriptor Query(Action + /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + /// public SearchRequestDescriptor Rescore(ICollection? rescore) { RescoreDescriptor = null; @@ -1360,6 +1415,9 @@ public SearchRequestDescriptor Rescore(params Action + /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// public SearchRequestDescriptor Slice(Elastic.Clients.Elasticsearch.SlicedScroll? slice) { SliceDescriptor = null; @@ -1384,6 +1442,9 @@ public SearchRequestDescriptor Slice(Action + /// A comma-separated list of : pairs. + /// public SearchRequestDescriptor Sort(ICollection? sort) { SortDescriptor = null; @@ -1421,7 +1482,7 @@ public SearchRequestDescriptor Sort(params Action - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// Indicates which source fields are returned for matching documents.
These fields are returned in the hits._source property of the search response. /// public SearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -1448,7 +1509,7 @@ public SearchRequestDescriptor Ext(Func - /// 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.
Needs to be non-negative.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. /// public SearchRequestDescriptor From(int? from) { @@ -1466,7 +1527,7 @@ public SearchRequestDescriptor IndicesBoost(ICollection - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// Minimum `_score` for matching documents.
Documents with a lower `_score` are not included in the search results. /// public SearchRequestDescriptor MinScore(double? minScore) { @@ -1475,7 +1536,7 @@ public SearchRequestDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// Limits the search to a point in time (PIT).
If you provide a PIT, you cannot specify an `` in the request path. /// public SearchRequestDescriptor Pit(Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? pit) { @@ -1501,6 +1562,9 @@ public SearchRequestDescriptor Pit(Action + /// Set to `true` to return detailed timing information about the execution of individual components in a search request.
NOTE: This is a debugging tool and adds significant overhead to search execution. + /// public SearchRequestDescriptor Profile(bool? profile = true) { ProfileValue = profile; @@ -1508,7 +1572,7 @@ public SearchRequestDescriptor Profile(bool? profile = true) } /// - /// Defines the Reciprocal Rank Fusion (RRF) to use + /// Defines the Reciprocal Rank Fusion (RRF) to use. /// public SearchRequestDescriptor Rank(Elastic.Clients.Elasticsearch.Rank? rank) { @@ -1535,7 +1599,7 @@ public SearchRequestDescriptor Rank(Action configure) } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// Defines one or more runtime fields in the search request.
These fields take precedence over mapped fields with the same name. /// public SearchRequestDescriptor RuntimeMappings(Func, FluentDictionary> selector) { @@ -1552,6 +1616,9 @@ public SearchRequestDescriptor ScriptFields(Func + /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// public SearchRequestDescriptor SearchAfter(ICollection? searchAfter) { SearchAfterValue = searchAfter; @@ -1559,7 +1626,7 @@ public SearchRequestDescriptor 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. /// public SearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -1568,7 +1635,7 @@ public SearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTer } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// The number of hits to return.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. /// public SearchRequestDescriptor Size(int? size) { @@ -1577,7 +1644,7 @@ public SearchRequestDescriptor Size(int? size) } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// Stats groups to associate with the search.
Each group maintains a statistics aggregation for its associated searches.
You can retrieve these stats using the indices stats API. /// public SearchRequestDescriptor Stats(ICollection? stats) { @@ -1586,7 +1653,7 @@ public SearchRequestDescriptor Stats(ICollection? stats) } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to `false`.
You can pass `_source: true` to return both source fields and stored fields in the search response. /// public SearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { @@ -1594,6 +1661,9 @@ public SearchRequestDescriptor StoredFields(Elastic.Clients.Elasticse return Self; } + /// + /// Defines a suggester that provides similar looking terms based on a provided text. + /// public SearchRequestDescriptor Suggest(Elastic.Clients.Elasticsearch.Core.Search.Suggester? suggest) { SuggestDescriptor = null; @@ -1619,7 +1689,7 @@ public SearchRequestDescriptor Suggest(Action - /// Maximum number of documents to collect for each shard. If a query reaches this
limit, Elasticsearch terminates the query early. Elasticsearch collects documents
before sorting. 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.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
If set to `0` (default), the query does not terminate early. /// public SearchRequestDescriptor TerminateAfter(long? terminateAfter) { @@ -1628,7 +1698,7 @@ public SearchRequestDescriptor TerminateAfter(long? terminateAfter) } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. /// public SearchRequestDescriptor Timeout(string? timeout) { @@ -1646,7 +1716,7 @@ public SearchRequestDescriptor TrackScores(bool? trackScores = true) } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
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. /// public SearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Core.Search.TrackHits? trackTotalHits) { @@ -2078,7 +2148,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Returns results matching a query. +/// Returns search hits that match the query defined in the request.
You can provide search queries using the `q` query string parameter or the request body.
If both are specified, only the query parameter is used. /// public sealed partial class SearchRequestDescriptor : RequestDescriptor { @@ -2201,6 +2271,9 @@ public SearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? in private Elastic.Clients.Elasticsearch.Core.Search.TrackHits? TrackTotalHitsValue { get; set; } private bool? VersionValue { get; set; } + /// + /// Defines the aggregations that are run as part of the search request. + /// public SearchRequestDescriptor Aggregations(Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? aggregations) { AggregationsDescriptor = null; @@ -2225,6 +2298,9 @@ public SearchRequestDescriptor Aggregations(Action + /// Collapses search results the values of the specified field. + /// public SearchRequestDescriptor Collapse(Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? collapse) { CollapseDescriptor = null; @@ -2250,7 +2326,7 @@ public SearchRequestDescriptor Collapse(Action - /// Array of wildcard (*) patterns. The request returns doc values for field
names matching these patterns in the hits.fields property of the response. + /// Array of wildcard (`*`) patterns.
The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. /// public SearchRequestDescriptor DocvalueFields(ICollection? docvalueFields) { @@ -2289,7 +2365,7 @@ public SearchRequestDescriptor 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. + /// Array of wildcard (`*`) patterns.
The request returns values for field names matching these patterns in the `hits.fields` property of the response. /// public SearchRequestDescriptor Fields(ICollection? fields) { @@ -2327,6 +2403,9 @@ public SearchRequestDescriptor Fields(params Action + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. + /// public SearchRequestDescriptor Highlight(Elastic.Clients.Elasticsearch.Core.Search.Highlight? highlight) { HighlightDescriptor = null; @@ -2390,6 +2469,9 @@ public SearchRequestDescriptor Knn(params Action[] configure return Self; } + /// + /// Use the `post_filter` parameter to filter search results.
The search hits are filtered after the aggregations are calculated.
A post filter has no impact on the aggregation results. + /// public SearchRequestDescriptor PostFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? postFilter) { PostFilterDescriptor = null; @@ -2441,6 +2523,9 @@ public SearchRequestDescriptor Query(Action configure) return Self; } + /// + /// Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + /// public SearchRequestDescriptor Rescore(ICollection? rescore) { RescoreDescriptor = null; @@ -2477,6 +2562,9 @@ public SearchRequestDescriptor Rescore(params Action + /// Can be used to split a scrolled search into multiple slices that can be consumed independently. + /// public SearchRequestDescriptor Slice(Elastic.Clients.Elasticsearch.SlicedScroll? slice) { SliceDescriptor = null; @@ -2501,6 +2589,9 @@ public SearchRequestDescriptor Slice(Action configure) return Self; } + /// + /// A comma-separated list of : pairs. + /// public SearchRequestDescriptor Sort(ICollection? sort) { SortDescriptor = null; @@ -2538,7 +2629,7 @@ public SearchRequestDescriptor Sort(params Action[] confi } /// - /// Indicates which source fields are returned for matching documents. These
fields are returned in the hits._source property of the search response. + /// Indicates which source fields are returned for matching documents.
These fields are returned in the hits._source property of the search response. /// public SearchRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { @@ -2565,7 +2656,7 @@ public SearchRequestDescriptor Ext(Func, Fluent } /// - /// 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.
Needs to be non-negative.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. /// public SearchRequestDescriptor From(int? from) { @@ -2583,7 +2674,7 @@ public SearchRequestDescriptor IndicesBoost(ICollection - /// Minimum _score for matching documents. Documents with a lower _score are
not included in the search results. + /// Minimum `_score` for matching documents.
Documents with a lower `_score` are not included in the search results. /// public SearchRequestDescriptor MinScore(double? minScore) { @@ -2592,7 +2683,7 @@ public SearchRequestDescriptor MinScore(double? minScore) } /// - /// Limits the search to a point in time (PIT). If you provide a PIT, you
cannot specify an in the request path. + /// Limits the search to a point in time (PIT).
If you provide a PIT, you cannot specify an `` in the request path. /// public SearchRequestDescriptor Pit(Elastic.Clients.Elasticsearch.Core.Search.PointInTimeReference? pit) { @@ -2618,6 +2709,9 @@ public SearchRequestDescriptor Pit(Action + /// Set to `true` to return detailed timing information about the execution of individual components in a search request.
NOTE: This is a debugging tool and adds significant overhead to search execution. + /// public SearchRequestDescriptor Profile(bool? profile = true) { ProfileValue = profile; @@ -2625,7 +2719,7 @@ public SearchRequestDescriptor Profile(bool? profile = true) } /// - /// Defines the Reciprocal Rank Fusion (RRF) to use + /// Defines the Reciprocal Rank Fusion (RRF) to use. /// public SearchRequestDescriptor Rank(Elastic.Clients.Elasticsearch.Rank? rank) { @@ -2652,7 +2746,7 @@ public SearchRequestDescriptor Rank(Action configure) } /// - /// Defines one or more runtime fields in the search request. These fields take
precedence over mapped fields with the same name. + /// Defines one or more runtime fields in the search request.
These fields take precedence over mapped fields with the same name. /// public SearchRequestDescriptor RuntimeMappings(Func, FluentDictionary> selector) { @@ -2669,6 +2763,9 @@ public SearchRequestDescriptor ScriptFields(Func + /// Used to retrieve the next page of hits using a set of sort values from the previous page. + /// public SearchRequestDescriptor SearchAfter(ICollection? searchAfter) { SearchAfterValue = searchAfter; @@ -2676,7 +2773,7 @@ public SearchRequestDescriptor 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. /// public SearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { @@ -2685,7 +2782,7 @@ public SearchRequestDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) } /// - /// The number of hits to return. By default, you cannot page through more
than 10,000 hits using the from and size parameters. To page through more
hits, use the search_after parameter. + /// The number of hits to return.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter. /// public SearchRequestDescriptor Size(int? size) { @@ -2694,7 +2791,7 @@ public SearchRequestDescriptor Size(int? size) } /// - /// Stats groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these stats using
the indices stats API. + /// Stats groups to associate with the search.
Each group maintains a statistics aggregation for its associated searches.
You can retrieve these stats using the indices stats API. /// public SearchRequestDescriptor Stats(ICollection? stats) { @@ -2703,7 +2800,7 @@ public SearchRequestDescriptor Stats(ICollection? stats) } /// - /// List of stored fields to return as part of a hit. If no fields are specified,
no stored fields are included in the response. If this field is specified, the _source
parameter defaults to false. You can pass _source: true to return both source fields
and stored fields in the search response. + /// List of stored fields to return as part of a hit.
If no fields are specified, no stored fields are included in the response.
If this field is specified, the `_source` parameter defaults to `false`.
You can pass `_source: true` to return both source fields and stored fields in the search response. /// public SearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { @@ -2711,6 +2808,9 @@ public SearchRequestDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields return Self; } + /// + /// Defines a suggester that provides similar looking terms based on a provided text. + /// public SearchRequestDescriptor Suggest(Elastic.Clients.Elasticsearch.Core.Search.Suggester? suggest) { SuggestDescriptor = null; @@ -2736,7 +2836,7 @@ public SearchRequestDescriptor Suggest(Action c } /// - /// 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.
Use with caution.
Elasticsearch applies this parameter to each shard handling the request.
When possible, let Elasticsearch perform early termination automatically.
Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
If set to `0` (default), the query does not terminate early. /// public SearchRequestDescriptor TerminateAfter(long? terminateAfter) { @@ -2745,7 +2845,7 @@ public SearchRequestDescriptor TerminateAfter(long? terminateAfter) } /// - /// Specifies the period of time to wait for a response from each shard. If no response
is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. + /// Specifies the period of time to wait for a response from each shard.
If no response is received before the timeout expires, the request fails and returns an error.
Defaults to no timeout. /// public SearchRequestDescriptor Timeout(string? timeout) { @@ -2763,7 +2863,7 @@ public SearchRequestDescriptor TrackScores(bool? trackScores = true) } /// - /// Number of hits matching the query to count accurately. If true, the exact
number of hits is returned at the cost of some performance. If false, the
response does not include the total number of hits matching the query.
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. /// public SearchRequestDescriptor TrackTotalHits(Elastic.Clients.Elasticsearch.Core.Search.TrackHits? trackTotalHits) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/GetTasksResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/GetTasksResponse.g.cs index 88d094b7a97..07238c18312 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/GetTasksResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/GetTasksResponse.g.cs @@ -33,7 +33,7 @@ public sealed partial class GetTasksResponse : ElasticsearchResponse [JsonInclude, JsonPropertyName("completed")] public bool Completed { get; init; } [JsonInclude, JsonPropertyName("response")] - public Elastic.Clients.Elasticsearch.Tasks.TaskStatus? Response { get; init; } + public object? Response { get; init; } [JsonInclude, JsonPropertyName("task")] public Elastic.Clients.Elasticsearch.Tasks.TaskInfo Task { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Enrich.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Enrich.g.cs index 00cee89e569..c8c7f00bf54 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Enrich.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Enrich.g.cs @@ -210,7 +210,7 @@ public virtual Task StatsAsync(Action /// Creates the enrich index for an existing enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ExecutePolicyResponse ExecutePolicy(ExecutePolicyRequest request) { @@ -220,7 +220,7 @@ public virtual ExecutePolicyResponse ExecutePolicy(ExecutePolicyRequest request) /// /// Creates the enrich index for an existing enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecutePolicyAsync(ExecutePolicyRequest request, CancellationToken cancellationToken = default) { @@ -230,7 +230,7 @@ public virtual Task ExecutePolicyAsync(ExecutePolicyReque /// /// Creates the enrich index for an existing enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ExecutePolicyResponse ExecutePolicy(Elastic.Clients.Elasticsearch.Name name) { @@ -241,7 +241,7 @@ public virtual ExecutePolicyResponse ExecutePolicy(Elastic.Clients.Elasticsearch /// /// Creates the enrich index for an existing enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ExecutePolicyResponse ExecutePolicy(ExecutePolicyRequestDescriptor descriptor) { @@ -251,7 +251,7 @@ public virtual ExecutePolicyResponse ExecutePolicy(ExecutePolicyRequestDescripto /// /// Creates the enrich index for an existing enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ExecutePolicyResponse ExecutePolicy(Elastic.Clients.Elasticsearch.Name name, Action configureRequest) { @@ -263,7 +263,7 @@ public virtual ExecutePolicyResponse ExecutePolicy(Elastic.Clients.Elasticsearch /// /// Creates the enrich index for an existing enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecutePolicyAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) { @@ -274,7 +274,7 @@ public virtual Task ExecutePolicyAsync(Elastic.Clients.El /// /// Creates the enrich index for an existing enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecutePolicyAsync(ExecutePolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -284,7 +284,7 @@ public virtual Task ExecutePolicyAsync(ExecutePolicyReque /// /// Creates the enrich index for an existing enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExecutePolicyAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -382,7 +382,7 @@ public virtual Task GetPolicyAsync(Action /// Creates a new enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual PutPolicyResponse PutPolicy(PutPolicyRequest request) { @@ -392,7 +392,7 @@ public virtual PutPolicyResponse PutPolicy(PutPolicyRequest request) /// /// Creates a new enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(PutPolicyRequest request, CancellationToken cancellationToken = default) { @@ -402,7 +402,7 @@ public virtual Task PutPolicyAsync(PutPolicyRequest request, /// /// Creates a new enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual PutPolicyResponse PutPolicy(PutPolicyRequestDescriptor descriptor) { @@ -412,7 +412,7 @@ public virtual PutPolicyResponse PutPolicy(PutPolicyRequestDescriptor descriptor /// /// Creates a new enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsearch.Name name, Action configureRequest) { @@ -424,7 +424,7 @@ public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsearch.Name na /// /// Creates a new enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual PutPolicyResponse PutPolicy(PutPolicyRequestDescriptor descriptor) { @@ -434,7 +434,7 @@ public virtual PutPolicyResponse PutPolicy(PutPolicyRequestDescriptor /// /// Creates a new enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsearch.Name name, Action> configureRequest) { @@ -446,7 +446,7 @@ public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsea /// /// Creates a new enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(PutPolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -456,7 +456,7 @@ public virtual Task PutPolicyAsync(PutPolicyRequestDescriptor /// /// Creates a new enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -468,7 +468,7 @@ public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsea /// /// Creates a new enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(PutPolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -478,7 +478,7 @@ public virtual Task PutPolicyAsync(PutPolicyReques /// /// Creates a new enrich policy. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsearch.Name name, Action> configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Eql.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Eql.g.cs index 8a7ef264b1f..bcdacac136b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Eql.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Eql.g.cs @@ -168,7 +168,7 @@ public virtual Task DeleteAsync(Elastic.Clients.El /// /// Returns async results from previously executed Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual EqlGetResponse Get(EqlGetRequest request) { @@ -178,7 +178,7 @@ public virtual EqlGetResponse Get(EqlGetRequest request) /// /// Returns async results from previously executed Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(EqlGetRequest request, CancellationToken cancellationToken = default) { @@ -188,7 +188,7 @@ public virtual Task> GetAsync(EqlGetRequest reque /// /// Returns async results from previously executed Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual EqlGetResponse Get(Elastic.Clients.Elasticsearch.Id id) { @@ -199,7 +199,7 @@ public virtual EqlGetResponse Get(Elastic.Clients.Elasticsearch. /// /// Returns async results from previously executed Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual EqlGetResponse Get(EqlGetRequestDescriptor descriptor) { @@ -209,7 +209,7 @@ public virtual EqlGetResponse Get(EqlGetRequestDescriptor descri /// /// Returns async results from previously executed Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual EqlGetResponse Get(Elastic.Clients.Elasticsearch.Id id, Action configureRequest) { @@ -221,7 +221,7 @@ public virtual EqlGetResponse Get(Elastic.Clients.Elasticsearch. /// /// Returns async results from previously executed Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -232,7 +232,7 @@ public virtual Task> GetAsync(Elastic.Clients.Ela /// /// Returns async results from previously executed Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(EqlGetRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -242,7 +242,7 @@ public virtual Task> GetAsync(EqlGetRequestDescri /// /// Returns async results from previously executed Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) { @@ -340,7 +340,7 @@ public virtual Task> SearchAsync(Elastic.Clien /// /// Returns the status of a previously submitted async or stored Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequest request) { @@ -350,7 +350,7 @@ public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequest request) /// /// Returns the status of a previously submitted async or stored Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequest request, CancellationToken cancellationToken = default) { @@ -360,7 +360,7 @@ public virtual Task GetStatusAsync(GetEqlStatusRequest req /// /// Returns the status of a previously submitted async or stored Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id id) { @@ -371,7 +371,7 @@ public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id i /// /// Returns the status of a previously submitted async or stored Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequestDescriptor descriptor) { @@ -381,7 +381,7 @@ public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequestDescriptor desc /// /// Returns the status of a previously submitted async or stored Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id id, Action configureRequest) { @@ -393,7 +393,7 @@ public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id i /// /// Returns the status of a previously submitted async or stored Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequestDescriptor descriptor) { @@ -403,7 +403,7 @@ public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequestDesc /// /// Returns the status of a previously submitted async or stored Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest) { @@ -415,7 +415,7 @@ public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elastic /// /// Returns the status of a previously submitted async or stored Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -426,7 +426,7 @@ public virtual Task GetStatusAsync(Elastic.Clients.Elastic /// /// Returns the status of a previously submitted async or stored Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -436,7 +436,7 @@ public virtual Task GetStatusAsync(GetEqlStatusRequestDesc /// /// Returns the status of a previously submitted async or stored Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) { @@ -448,7 +448,7 @@ public virtual Task GetStatusAsync(Elastic.Clients.Elastic /// /// Returns the status of a previously submitted async or stored Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -458,7 +458,7 @@ public virtual Task GetStatusAsync(GetEqlStatus /// /// Returns the status of a previously submitted async or stored Event Query Language (EQL) search - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs index c3e9f07c2e9..59ce7000e2f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs @@ -38,7 +38,7 @@ internal GraphNamespacedClient(ElasticsearchClient client) : base(client) /// /// Explore extracted and summarized information about the documents and terms in an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ExploreResponse Explore(ExploreRequest request) { @@ -48,7 +48,7 @@ public virtual ExploreResponse Explore(ExploreRequest request) /// /// Explore extracted and summarized information about the documents and terms in an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequest request, CancellationToken cancellationToken = default) { @@ -58,7 +58,7 @@ public virtual Task ExploreAsync(ExploreRequest request, Cancel /// /// Explore extracted and summarized information about the documents and terms in an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices indices) { @@ -69,7 +69,7 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices ind /// /// Explore extracted and summarized information about the documents and terms in an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ExploreResponse Explore(ExploreRequestDescriptor descriptor) { @@ -79,7 +79,7 @@ public virtual ExploreResponse Explore(ExploreRequestDescriptor descriptor) /// /// Explore extracted and summarized information about the documents and terms in an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest) { @@ -91,7 +91,7 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices ind /// /// Explore extracted and summarized information about the documents and terms in an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ExploreResponse Explore(ExploreRequestDescriptor descriptor) { @@ -101,7 +101,7 @@ public virtual ExploreResponse Explore(ExploreRequestDescriptor /// Explore extracted and summarized information about the documents and terms in an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest) { @@ -113,7 +113,7 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch. /// /// Explore extracted and summarized information about the documents and terms in an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -124,7 +124,7 @@ public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch. /// /// Explore extracted and summarized information about the documents and terms in an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -134,7 +134,7 @@ public virtual Task ExploreAsync(ExploreRequestDescriptor descr /// /// Explore extracted and summarized information about the documents and terms in an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -146,7 +146,7 @@ public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch. /// /// Explore extracted and summarized information about the documents and terms in an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -156,7 +156,7 @@ public virtual Task ExploreAsync(ExploreRequestDescr /// /// Explore extracted and summarized information about the documents and terms in an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Indices.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Indices.g.cs index 1fdf2ffdb8d..e89cf8966fd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Indices.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Indices.g.cs @@ -214,7 +214,7 @@ public virtual Task CloneAsync(Elastic.Clients.El /// /// Closes an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CloseIndexResponse Close(CloseIndexRequest request) { @@ -224,7 +224,7 @@ public virtual CloseIndexResponse Close(CloseIndexRequest request) /// /// Closes an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequest request, CancellationToken cancellationToken = default) { @@ -234,7 +234,7 @@ public virtual Task CloseAsync(CloseIndexRequest request, Ca /// /// Closes an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices indices) { @@ -245,7 +245,7 @@ public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices in /// /// Closes an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CloseIndexResponse Close(CloseIndexRequestDescriptor descriptor) { @@ -255,7 +255,7 @@ public virtual CloseIndexResponse Close(CloseIndexRequestDescriptor descriptor) /// /// Closes an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest) { @@ -267,7 +267,7 @@ public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices in /// /// Closes an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CloseIndexResponse Close(CloseIndexRequestDescriptor descriptor) { @@ -277,7 +277,7 @@ public virtual CloseIndexResponse Close(CloseIndexRequestDescriptor /// Closes an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest) { @@ -289,7 +289,7 @@ public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch /// /// Closes an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -300,7 +300,7 @@ public virtual Task CloseAsync(Elastic.Clients.Elasticsearch /// /// Closes an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -310,7 +310,7 @@ public virtual Task CloseAsync(CloseIndexRequestDescriptor d /// /// Closes an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -322,7 +322,7 @@ public virtual Task CloseAsync(Elastic.Clients.Elasticsearch /// /// Closes an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -332,7 +332,7 @@ public virtual Task CloseAsync(CloseIndexRequestD /// /// Closes an index. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -430,7 +430,7 @@ public virtual Task CreateDataStreamAsync(Elastic.Clie /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CreateIndexResponse Create(CreateIndexRequest request) { @@ -440,7 +440,7 @@ public virtual CreateIndexResponse Create(CreateIndexRequest request) /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateIndexRequest request, CancellationToken cancellationToken = default) { @@ -450,7 +450,7 @@ public virtual Task CreateAsync(CreateIndexRequest request, /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexName index) { @@ -461,7 +461,7 @@ public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexNam /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CreateIndexResponse Create(CreateIndexRequestDescriptor descriptor) { @@ -471,7 +471,7 @@ public virtual CreateIndexResponse Create(CreateIndexRequestDescriptor descripto /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest) { @@ -483,7 +483,7 @@ public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexNam /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CreateIndexResponse Create() { @@ -494,7 +494,7 @@ public virtual CreateIndexResponse Create() /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CreateIndexResponse Create(Action> configureRequest) { @@ -506,7 +506,7 @@ public virtual CreateIndexResponse Create(Action /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CreateIndexResponse Create(CreateIndexRequestDescriptor descriptor) { @@ -516,7 +516,7 @@ public virtual CreateIndexResponse Create(CreateIndexRequestDescripto /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest) { @@ -528,7 +528,7 @@ public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsear /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -539,7 +539,7 @@ public virtual Task CreateAsync(Elastic.Clients.Elasticsear /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -549,7 +549,7 @@ public virtual Task CreateAsync(CreateIndexRequestDescripto /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) { @@ -561,7 +561,7 @@ public virtual Task CreateAsync(Elastic.Clients.Elasticsear /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CancellationToken cancellationToken = default) { @@ -572,7 +572,7 @@ public virtual Task CreateAsync(CancellationToke /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -584,7 +584,7 @@ public virtual Task CreateAsync(Action /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(CreateIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -594,7 +594,7 @@ public virtual Task CreateAsync(CreateIndexReque /// /// Creates an index with optional settings and mappings. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CreateAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1792,7 +1792,7 @@ public virtual Task ExplainDataLifecycleAsync /// Performs the flush operation on one or more indices. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual FlushResponse Flush(FlushRequest request) { @@ -1802,7 +1802,7 @@ public virtual FlushResponse Flush(FlushRequest request) /// /// Performs the flush operation on one or more indices. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequest request, CancellationToken cancellationToken = default) { @@ -1812,7 +1812,7 @@ public virtual Task FlushAsync(FlushRequest request, Cancellation /// /// Performs the flush operation on one or more indices. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual FlushResponse Flush() { @@ -1823,7 +1823,7 @@ public virtual FlushResponse Flush() /// /// Performs the flush operation on one or more indices. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual FlushResponse Flush(FlushRequestDescriptor descriptor) { @@ -1833,7 +1833,7 @@ public virtual FlushResponse Flush(FlushRequestDescriptor descriptor) /// /// Performs the flush operation on one or more indices. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual FlushResponse Flush(Action configureRequest) { @@ -1845,7 +1845,7 @@ public virtual FlushResponse Flush(Action configureReque /// /// Performs the flush operation on one or more indices. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual FlushResponse Flush(FlushRequestDescriptor descriptor) { @@ -1855,7 +1855,7 @@ public virtual FlushResponse Flush(FlushRequestDescriptor /// /// Performs the flush operation on one or more indices. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual FlushResponse Flush(Action> configureRequest) { @@ -1867,7 +1867,7 @@ public virtual FlushResponse Flush(Action /// Performs the flush operation on one or more indices. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(CancellationToken cancellationToken = default) { @@ -1878,7 +1878,7 @@ public virtual Task FlushAsync(CancellationToken cancellationToke /// /// Performs the flush operation on one or more indices. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1888,7 +1888,7 @@ public virtual Task FlushAsync(FlushRequestDescriptor descriptor, /// /// Performs the flush operation on one or more indices. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -1900,7 +1900,7 @@ public virtual Task FlushAsync(Action con /// /// Performs the flush operation on one or more indices. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1910,7 +1910,7 @@ public virtual Task FlushAsync(FlushRequestDescriptor< /// /// Performs the flush operation on one or more indices. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -3904,7 +3904,7 @@ public virtual Task RefreshAsync(Action /// Updates an alias to point to a new index when the existing index
is considered to be too large or too old. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual RolloverResponse Rollover(RolloverRequest request) { @@ -3914,7 +3914,7 @@ public virtual RolloverResponse Rollover(RolloverRequest request) /// /// Updates an alias to point to a new index when the existing index
is considered to be too large or too old. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequest request, CancellationToken cancellationToken = default) { @@ -3924,7 +3924,7 @@ public virtual Task RolloverAsync(RolloverRequest request, Can /// /// Updates an alias to point to a new index when the existing index
is considered to be too large or too old. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlias alias) { @@ -3935,7 +3935,7 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlia /// /// Updates an alias to point to a new index when the existing index
is considered to be too large or too old. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual RolloverResponse Rollover(RolloverRequestDescriptor descriptor) { @@ -3945,7 +3945,7 @@ public virtual RolloverResponse Rollover(RolloverRequestDescriptor descriptor) /// /// Updates an alias to point to a new index when the existing index
is considered to be too large or too old. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlias alias, Action configureRequest) { @@ -3957,7 +3957,7 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlia /// /// Updates an alias to point to a new index when the existing index
is considered to be too large or too old. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, CancellationToken cancellationToken = default) { @@ -3968,7 +3968,7 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc /// /// Updates an alias to point to a new index when the existing index
is considered to be too large or too old. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -3978,7 +3978,7 @@ public virtual Task RolloverAsync(RolloverRequestDescriptor de /// /// Updates an alias to point to a new index when the existing index
is considered to be too large or too old. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Action configureRequest, CancellationToken cancellationToken = default) { @@ -3990,7 +3990,7 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequest request) { @@ -4000,7 +4000,7 @@ public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequest request) /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(ShrinkIndexRequest request, CancellationToken cancellationToken = default) { @@ -4010,7 +4010,7 @@ public virtual Task ShrinkAsync(ShrinkIndexRequest request, /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target) { @@ -4021,7 +4021,7 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexNam /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequestDescriptor descriptor) { @@ -4031,7 +4031,7 @@ public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequestDescriptor descripto /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action configureRequest) { @@ -4043,7 +4043,7 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexNam /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexName target) { @@ -4054,7 +4054,7 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsear /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexName target, Action> configureRequest) { @@ -4066,7 +4066,7 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsear /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequestDescriptor descriptor) { @@ -4076,7 +4076,7 @@ public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequestDescripto /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action> configureRequest) { @@ -4088,7 +4088,7 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsear /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, CancellationToken cancellationToken = default) { @@ -4099,7 +4099,7 @@ public virtual Task ShrinkAsync(Elastic.Clients.Elasticsear /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(ShrinkIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -4109,7 +4109,7 @@ public virtual Task ShrinkAsync(ShrinkIndexRequestDescripto /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action configureRequest, CancellationToken cancellationToken = default) { @@ -4121,7 +4121,7 @@ public virtual Task ShrinkAsync(Elastic.Clients.Elasticsear /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(Elastic.Clients.Elasticsearch.IndexName target, CancellationToken cancellationToken = default) { @@ -4132,7 +4132,7 @@ public virtual Task ShrinkAsync(Elastic.Clients. /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(Elastic.Clients.Elasticsearch.IndexName target, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -4144,7 +4144,7 @@ public virtual Task ShrinkAsync(Elastic.Clients. /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(ShrinkIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -4154,7 +4154,7 @@ public virtual Task ShrinkAsync(ShrinkIndexReque /// /// Allow to shrink an existing index into a new index with fewer primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -4382,7 +4382,7 @@ public virtual Task SimulateTemplateAsync(Action /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual SplitIndexResponse Split(SplitIndexRequest request) { @@ -4392,7 +4392,7 @@ public virtual SplitIndexResponse Split(SplitIndexRequest request) /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(SplitIndexRequest request, CancellationToken cancellationToken = default) { @@ -4402,7 +4402,7 @@ public virtual Task SplitAsync(SplitIndexRequest request, Ca /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target) { @@ -4413,7 +4413,7 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual SplitIndexResponse Split(SplitIndexRequestDescriptor descriptor) { @@ -4423,7 +4423,7 @@ public virtual SplitIndexResponse Split(SplitIndexRequestDescriptor descriptor) /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action configureRequest) { @@ -4435,7 +4435,7 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName target) { @@ -4446,7 +4446,7 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName target, Action> configureRequest) { @@ -4458,7 +4458,7 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual SplitIndexResponse Split(SplitIndexRequestDescriptor descriptor) { @@ -4468,7 +4468,7 @@ public virtual SplitIndexResponse Split(SplitIndexRequestDescriptor /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action> configureRequest) { @@ -4480,7 +4480,7 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, CancellationToken cancellationToken = default) { @@ -4491,7 +4491,7 @@ public virtual Task SplitAsync(Elastic.Clients.Elasticsearch /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(SplitIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -4501,7 +4501,7 @@ public virtual Task SplitAsync(SplitIndexRequestDescriptor d /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action configureRequest, CancellationToken cancellationToken = default) { @@ -4513,7 +4513,7 @@ public virtual Task SplitAsync(Elastic.Clients.Elasticsearch /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(Elastic.Clients.Elasticsearch.IndexName target, CancellationToken cancellationToken = default) { @@ -4524,7 +4524,7 @@ public virtual Task SplitAsync(Elastic.Clients.El /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(Elastic.Clients.Elasticsearch.IndexName target, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -4536,7 +4536,7 @@ public virtual Task SplitAsync(Elastic.Clients.El /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(SplitIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -4546,7 +4546,7 @@ public virtual Task SplitAsync(SplitIndexRequestD /// /// Allows you to split an existing index into a new index with more primary shards. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action> configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ingest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ingest.g.cs index 71bc082424e..da837c55f3a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ingest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ingest.g.cs @@ -168,7 +168,7 @@ public virtual Task DeletePipelineAsync(Elast /// /// Returns statistical information about geoip databases - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual GeoIpStatsResponse GeoIpStats(GeoIpStatsRequest request) { @@ -178,7 +178,7 @@ public virtual GeoIpStatsResponse GeoIpStats(GeoIpStatsRequest request) /// /// Returns statistical information about geoip databases - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GeoIpStatsAsync(GeoIpStatsRequest request, CancellationToken cancellationToken = default) { @@ -188,7 +188,7 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequest reques /// /// Returns statistical information about geoip databases - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual GeoIpStatsResponse GeoIpStats() { @@ -199,7 +199,7 @@ public virtual GeoIpStatsResponse GeoIpStats() /// /// Returns statistical information about geoip databases - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual GeoIpStatsResponse GeoIpStats(GeoIpStatsRequestDescriptor descriptor) { @@ -209,7 +209,7 @@ public virtual GeoIpStatsResponse GeoIpStats(GeoIpStatsRequestDescriptor descrip /// /// Returns statistical information about geoip databases - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual GeoIpStatsResponse GeoIpStats(Action configureRequest) { @@ -221,7 +221,7 @@ public virtual GeoIpStatsResponse GeoIpStats(Action /// /// Returns statistical information about geoip databases - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GeoIpStatsAsync(CancellationToken cancellationToken = default) { @@ -232,7 +232,7 @@ public virtual Task GeoIpStatsAsync(CancellationToken cancel /// /// Returns statistical information about geoip databases - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GeoIpStatsAsync(GeoIpStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -242,7 +242,7 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequestDescrip /// /// Returns statistical information about geoip databases - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GeoIpStatsAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -384,7 +384,7 @@ public virtual Task GetPipelineAsync(Action /// Returns a list of the built-in patterns. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ProcessorGrokResponse ProcessorGrok(ProcessorGrokRequest request) { @@ -394,7 +394,7 @@ public virtual ProcessorGrokResponse ProcessorGrok(ProcessorGrokRequest request) /// /// Returns a list of the built-in patterns. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(ProcessorGrokRequest request, CancellationToken cancellationToken = default) { @@ -404,7 +404,7 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque /// /// Returns a list of the built-in patterns. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ProcessorGrokResponse ProcessorGrok() { @@ -415,7 +415,7 @@ public virtual ProcessorGrokResponse ProcessorGrok() /// /// Returns a list of the built-in patterns. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ProcessorGrokResponse ProcessorGrok(ProcessorGrokRequestDescriptor descriptor) { @@ -425,7 +425,7 @@ public virtual ProcessorGrokResponse ProcessorGrok(ProcessorGrokRequestDescripto /// /// Returns a list of the built-in patterns. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual ProcessorGrokResponse ProcessorGrok(Action configureRequest) { @@ -437,7 +437,7 @@ public virtual ProcessorGrokResponse ProcessorGrok(Action /// Returns a list of the built-in patterns. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(CancellationToken cancellationToken = default) { @@ -448,7 +448,7 @@ public virtual Task ProcessorGrokAsync(CancellationToken /// /// Returns a list of the built-in patterns. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(ProcessorGrokRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -458,7 +458,7 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque /// /// Returns a list of the built-in patterns. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -470,7 +470,7 @@ public virtual Task ProcessorGrokAsync(Action /// Creates or updates a pipeline. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual PutPipelineResponse PutPipeline(PutPipelineRequest request) { @@ -480,7 +480,7 @@ public virtual PutPipelineResponse PutPipeline(PutPipelineRequest request) /// /// Creates or updates a pipeline. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(PutPipelineRequest request, CancellationToken cancellationToken = default) { @@ -490,7 +490,7 @@ public virtual Task PutPipelineAsync(PutPipelineRequest req /// /// Creates or updates a pipeline. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual PutPipelineResponse PutPipeline(PutPipelineRequestDescriptor descriptor) { @@ -500,7 +500,7 @@ public virtual PutPipelineResponse PutPipeline(PutPipelineRequestDescriptor desc /// /// Creates or updates a pipeline. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id id, Action configureRequest) { @@ -512,7 +512,7 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id /// /// Creates or updates a pipeline. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual PutPipelineResponse PutPipeline(PutPipelineRequestDescriptor descriptor) { @@ -522,7 +522,7 @@ public virtual PutPipelineResponse PutPipeline(PutPipelineRequestDesc /// /// Creates or updates a pipeline. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest) { @@ -534,7 +534,7 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasti /// /// Creates or updates a pipeline. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(PutPipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -544,7 +544,7 @@ public virtual Task PutPipelineAsync(PutPipelineRequestDesc /// /// Creates or updates a pipeline. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) { @@ -556,7 +556,7 @@ public virtual Task PutPipelineAsync(Elastic.Clients.Elasti /// /// Creates or updates a pipeline. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(PutPipelineRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -566,7 +566,7 @@ public virtual Task PutPipelineAsync(PutPipeline /// /// Creates or updates a pipeline. - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutPipelineAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AdjacencyMatrixAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AdjacencyMatrixAggregation.g.cs index 0c5b34bc63b..1ed74ae8652 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AdjacencyMatrixAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AdjacencyMatrixAggregation.g.cs @@ -125,6 +125,10 @@ internal AdjacencyMatrixAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// Filters used to create buckets.
At least one filter is required. + /// public IDictionary? Filters { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } @@ -168,6 +172,9 @@ public AdjacencyMatrixAggregationDescriptor Aggregations(Action + /// Filters used to create buckets.
At least one filter is required. + /// public AdjacencyMatrixAggregationDescriptor Filters(Func, FluentDictionary> selector) { FiltersValue = selector?.Invoke(new FluentDictionary()); @@ -256,6 +263,9 @@ public AdjacencyMatrixAggregationDescriptor Aggregations(Action + /// Filters used to create buckets.
At least one filter is required. + /// public AdjacencyMatrixAggregationDescriptor Filters(Func, FluentDictionary> selector) { FiltersValue = selector?.Invoke(new FluentDictionary()); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/Aggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/Aggregation.g.cs index 5cd895bce0b..80370a8dd10 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/Aggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/Aggregation.g.cs @@ -232,6 +232,16 @@ public override Aggregation Read(ref Utf8JsonReader reader, Type typeToConvert, return AggregationSerializationHelper.ReadContainer("parent", ref reader, options); } + if (propertyName == "percentile_ranks") + { + return AggregationSerializationHelper.ReadContainer("percentile_ranks", ref reader, options); + } + + if (propertyName == "percentiles") + { + return AggregationSerializationHelper.ReadContainer("percentiles", ref reader, options); + } + if (propertyName == "percentiles_bucket") { return AggregationSerializationHelper.ReadContainer("percentiles_bucket", ref reader, options); @@ -545,6 +555,16 @@ public AggregationDescriptor Parent(string name, Action PercentileRanks(string name, Action> configure) + { + return SetContainer(name, Aggregation.CreateWithAction("percentile_ranks", configure)); + } + + public AggregationDescriptor Percentiles(string name, Action> configure) + { + return SetContainer(name, Aggregation.CreateWithAction("percentiles", configure)); + } + public AggregationDescriptor PercentilesBucket(string name, Action configure) { return SetContainer(name, Aggregation.CreateWithAction("percentiles_bucket", configure)); @@ -999,6 +1019,26 @@ public AggregationDescriptor Parent(string name, Action configure) + { + return SetContainer(name, Aggregation.CreateWithAction("percentile_ranks", configure)); + } + + public AggregationDescriptor PercentileRanks(string name, Action> configure) + { + return SetContainer(name, Aggregation.CreateWithAction("percentile_ranks", configure)); + } + + public AggregationDescriptor Percentiles(string name, Action configure) + { + return SetContainer(name, Aggregation.CreateWithAction("percentiles", configure)); + } + + public AggregationDescriptor Percentiles(string name, Action> configure) + { + return SetContainer(name, Aggregation.CreateWithAction("percentiles", configure)); + } + public AggregationDescriptor PercentilesBucket(string name, Action configure) { return SetContainer(name, Aggregation.CreateWithAction("percentiles_bucket", configure)); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AggregationRange.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AggregationRange.g.cs index 5279c9e2cf2..688c3cce035 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AggregationRange.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AggregationRange.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class AggregationRange { + /// + /// Start of the range (inclusive). + /// [JsonInclude, JsonPropertyName("from")] public object? From { get; set; } + + /// + /// Custom key to return the range with. + /// [JsonInclude, JsonPropertyName("key")] public string? Key { get; set; } + + /// + /// End of the range (exclusive). + /// [JsonInclude, JsonPropertyName("to")] public object? To { get; set; } } @@ -49,18 +60,27 @@ public AggregationRangeDescriptor() : base() private string? KeyValue { get; set; } private object? ToValue { get; set; } + /// + /// Start of the range (inclusive). + /// public AggregationRangeDescriptor From(object? from) { FromValue = from; return Self; } + /// + /// Custom key to return the range with. + /// public AggregationRangeDescriptor Key(string? key) { KeyValue = key; return Self; } + /// + /// End of the range (exclusive). + /// public AggregationRangeDescriptor To(object? to) { ToValue = to; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AutoDateHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AutoDateHistogramAggregation.g.cs index 305de99b9a9..872fba91b48 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AutoDateHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/AutoDateHistogramAggregation.g.cs @@ -269,16 +269,44 @@ internal AutoDateHistogramAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// The target number of buckets. + /// public int? Buckets { get; set; } + + /// + /// The field on which to run the aggregation. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } + + /// + /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// public string? Format { get; set; } public IDictionary? Meta { get; set; } + + /// + /// The minimum rounding interval.
This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`. + /// public Elastic.Clients.Elasticsearch.Aggregations.MinimumInterval? MinimumInterval { get; set; } + + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public DateTimeOffset? Missing { get; set; } override public string? Name { get; internal set; } + + /// + /// Time zone specified as a ISO 8601 UTC offset. + /// public string? Offset { get; set; } public IDictionary? Params { get; set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } + + /// + /// Time zone ID. + /// public string? TimeZone { get; set; } } @@ -328,24 +356,36 @@ public AutoDateHistogramAggregationDescriptor Aggregations(Action + /// The target number of buckets. + /// public AutoDateHistogramAggregationDescriptor Buckets(int? buckets) { BucketsValue = buckets; return Self; } + /// + /// The field on which to run the aggregation. + /// public AutoDateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The field on which to run the aggregation. + /// public AutoDateHistogramAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// public AutoDateHistogramAggregationDescriptor Format(string? format) { FormatValue = format; @@ -358,18 +398,27 @@ public AutoDateHistogramAggregationDescriptor Meta(Func + /// The minimum rounding interval.
This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`. + /// public AutoDateHistogramAggregationDescriptor MinimumInterval(Elastic.Clients.Elasticsearch.Aggregations.MinimumInterval? minimumInterval) { MinimumIntervalValue = minimumInterval; return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public AutoDateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) { MissingValue = missing; return Self; } + /// + /// Time zone specified as a ISO 8601 UTC offset. + /// public AutoDateHistogramAggregationDescriptor Offset(string? offset) { OffsetValue = offset; @@ -388,6 +437,9 @@ public AutoDateHistogramAggregationDescriptor Script(Elastic.Clients. return Self; } + /// + /// Time zone ID. + /// public AutoDateHistogramAggregationDescriptor TimeZone(string? timeZone) { TimeZoneValue = timeZone; @@ -526,30 +578,45 @@ public AutoDateHistogramAggregationDescriptor Aggregations(Action + /// The target number of buckets. + /// public AutoDateHistogramAggregationDescriptor Buckets(int? buckets) { BucketsValue = buckets; return Self; } + /// + /// The field on which to run the aggregation. + /// public AutoDateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The field on which to run the aggregation. + /// public AutoDateHistogramAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field on which to run the aggregation. + /// public AutoDateHistogramAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// public AutoDateHistogramAggregationDescriptor Format(string? format) { FormatValue = format; @@ -562,18 +629,27 @@ public AutoDateHistogramAggregationDescriptor Meta(Func + /// The minimum rounding interval.
This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`. + /// public AutoDateHistogramAggregationDescriptor MinimumInterval(Elastic.Clients.Elasticsearch.Aggregations.MinimumInterval? minimumInterval) { MinimumIntervalValue = minimumInterval; return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public AutoDateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) { MissingValue = missing; return Self; } + /// + /// Time zone specified as a ISO 8601 UTC offset. + /// public AutoDateHistogramAggregationDescriptor Offset(string? offset) { OffsetValue = offset; @@ -592,6 +668,9 @@ public AutoDateHistogramAggregationDescriptor Script(Elastic.Clients.Elasticsear return Self; } + /// + /// Time zone ID. + /// public AutoDateHistogramAggregationDescriptor TimeZone(string? timeZone) { TimeZoneValue = timeZone; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BoxplotAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BoxplotAggregation.g.cs index 69df28c2b2e..4c1013a01a1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BoxplotAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BoxplotAggregation.g.cs @@ -162,6 +162,9 @@ internal BoxplotAggregation() { } + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// public double? Compression { get; set; } public Elastic.Clients.Elasticsearch.Field? Field { get; set; } public IDictionary? Meta { get; set; } @@ -184,6 +187,9 @@ public BoxplotAggregationDescriptor() : base() private FieldValue? MissingValue { get; set; } private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// public BoxplotAggregationDescriptor Compression(double? compression) { CompressionValue = compression; @@ -274,6 +280,9 @@ public BoxplotAggregationDescriptor() : base() private FieldValue? MissingValue { get; set; } private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// public BoxplotAggregationDescriptor Compression(double? compression) { CompressionValue = compression; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketSortAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketSortAggregation.g.cs index de16fd7dea7..d69fc78cda7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketSortAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/BucketSortAggregation.g.cs @@ -161,11 +161,26 @@ internal BucketSortAggregation() { } + /// + /// Buckets in positions prior to `from` will be truncated. + /// public int? From { get; set; } + + /// + /// The policy to apply when gaps are found in the data. + /// public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// The number of buckets to return.
Defaults to all buckets of the parent aggregation. + /// public int? Size { get; set; } + + /// + /// The list of fields to sort on. + /// public ICollection? Sort { get; set; } } @@ -186,6 +201,9 @@ public BucketSortAggregationDescriptor() : base() private IDictionary? MetaValue { get; set; } private int? SizeValue { get; set; } + /// + /// The list of fields to sort on. + /// public BucketSortAggregationDescriptor Sort(ICollection? sort) { SortDescriptor = null; @@ -222,12 +240,18 @@ public BucketSortAggregationDescriptor Sort(params Action + /// Buckets in positions prior to `from` will be truncated. + /// public BucketSortAggregationDescriptor From(int? from) { FromValue = from; return Self; } + /// + /// The policy to apply when gaps are found in the data. + /// public BucketSortAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { GapPolicyValue = gapPolicy; @@ -240,6 +264,9 @@ public BucketSortAggregationDescriptor Meta(Func + /// The number of buckets to return.
Defaults to all buckets of the parent aggregation. + /// public BucketSortAggregationDescriptor Size(int? size) { SizeValue = size; @@ -326,6 +353,9 @@ public BucketSortAggregationDescriptor() : base() private IDictionary? MetaValue { get; set; } private int? SizeValue { get; set; } + /// + /// The list of fields to sort on. + /// public BucketSortAggregationDescriptor Sort(ICollection? sort) { SortDescriptor = null; @@ -362,12 +392,18 @@ public BucketSortAggregationDescriptor Sort(params Action return Self; } + /// + /// Buckets in positions prior to `from` will be truncated. + /// public BucketSortAggregationDescriptor From(int? from) { FromValue = from; return Self; } + /// + /// The policy to apply when gaps are found in the data. + /// public BucketSortAggregationDescriptor GapPolicy(Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? gapPolicy) { GapPolicyValue = gapPolicy; @@ -380,6 +416,9 @@ public BucketSortAggregationDescriptor Meta(Func + /// The number of buckets to return.
Defaults to all buckets of the parent aggregation. + /// public BucketSortAggregationDescriptor Size(int? size) { SizeValue = size; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CardinalityAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CardinalityAggregation.g.cs index f8eca1823b5..828ff151d55 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CardinalityAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CardinalityAggregation.g.cs @@ -198,11 +198,18 @@ internal CardinalityAggregation() { } + /// + /// Mechanism by which cardinality aggregations is run. + /// public Elastic.Clients.Elasticsearch.Aggregations.CardinalityExecutionMode? ExecutionHint { get; set; } public Elastic.Clients.Elasticsearch.Field? Field { get; set; } public IDictionary? Meta { get; set; } public FieldValue? Missing { get; set; } override public string? Name { get; internal set; } + + /// + /// A unique count below which counts are expected to be close to accurate.
This allows to trade memory for accuracy. + /// public int? PrecisionThreshold { get; set; } public bool? Rehash { get; set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } @@ -224,6 +231,9 @@ public CardinalityAggregationDescriptor() : base() private bool? RehashValue { get; set; } private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + /// + /// Mechanism by which cardinality aggregations is run. + /// public CardinalityAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.CardinalityExecutionMode? executionHint) { ExecutionHintValue = executionHint; @@ -254,6 +264,9 @@ public CardinalityAggregationDescriptor Missing(FieldValue? missing) return Self; } + /// + /// A unique count below which counts are expected to be close to accurate.
This allows to trade memory for accuracy. + /// public CardinalityAggregationDescriptor PrecisionThreshold(int? precisionThreshold) { PrecisionThresholdValue = precisionThreshold; @@ -340,6 +353,9 @@ public CardinalityAggregationDescriptor() : base() private bool? RehashValue { get; set; } private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + /// + /// Mechanism by which cardinality aggregations is run. + /// public CardinalityAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.CardinalityExecutionMode? executionHint) { ExecutionHintValue = executionHint; @@ -376,6 +392,9 @@ public CardinalityAggregationDescriptor Missing(FieldValue? missing) return Self; } + /// + /// A unique count below which counts are expected to be close to accurate.
This allows to trade memory for accuracy. + /// public CardinalityAggregationDescriptor PrecisionThreshold(int? precisionThreshold) { PrecisionThresholdValue = precisionThreshold; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChiSquareHeuristic.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChiSquareHeuristic.g.cs index 51f0599ac49..dabf5f57d95 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChiSquareHeuristic.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChiSquareHeuristic.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class ChiSquareHeuristic { + /// + /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// [JsonInclude, JsonPropertyName("background_is_superset")] public bool BackgroundIsSuperset { get; set; } + + /// + /// Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + /// [JsonInclude, JsonPropertyName("include_negatives")] public bool IncludeNegatives { get; set; } } @@ -46,12 +53,18 @@ public ChiSquareHeuristicDescriptor() : base() private bool BackgroundIsSupersetValue { get; set; } private bool IncludeNegativesValue { get; set; } + /// + /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// public ChiSquareHeuristicDescriptor BackgroundIsSuperset(bool backgroundIsSuperset = true) { BackgroundIsSupersetValue = backgroundIsSuperset; return Self; } + /// + /// Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + /// public ChiSquareHeuristicDescriptor IncludeNegatives(bool includeNegatives = true) { IncludeNegativesValue = includeNegatives; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChildrenAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChildrenAggregation.g.cs index 5e2ec39b0f8..2041499dc27 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChildrenAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ChildrenAggregation.g.cs @@ -127,6 +127,10 @@ internal ChildrenAggregation() public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// The child type that should be selected. + /// public string? Type { get; set; } } @@ -174,6 +178,9 @@ public ChildrenAggregationDescriptor Meta(Func + /// The child type that should be selected. + /// public ChildrenAggregationDescriptor Type(string? type) { TypeValue = type; @@ -262,6 +269,9 @@ public ChildrenAggregationDescriptor Meta(Func, return Self; } + /// + /// The child type that should be selected. + /// public ChildrenAggregationDescriptor Type(string? type) { TypeValue = type; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregation.g.cs index d6cd1a2c223..02ef55a791b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregation.g.cs @@ -160,11 +160,22 @@ internal CompositeAggregation() { } + /// + /// When paginating, use the `after_key` value returned in the previous response to retrieve the next page. + /// public IDictionary? After { get; set; } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// The number of composite buckets that should be returned. + /// public int? Size { get; set; } + + /// + /// The value sources used to build composite buckets.
Keys are returned in the order of the `sources` definition. + /// public ICollection>? Sources { get; set; } } @@ -208,6 +219,9 @@ public CompositeAggregationDescriptor Aggregations(Action + /// When paginating, use the `after_key` value returned in the previous response to retrieve the next page. + /// public CompositeAggregationDescriptor After(Func, FluentDictionary> selector) { AfterValue = selector?.Invoke(new FluentDictionary()); @@ -220,12 +234,18 @@ public CompositeAggregationDescriptor Meta(Func + /// The number of composite buckets that should be returned. + /// public CompositeAggregationDescriptor Size(int? size) { SizeValue = size; return Self; } + /// + /// The value sources used to build composite buckets.
Keys are returned in the order of the `sources` definition. + /// public CompositeAggregationDescriptor Sources(ICollection>? sources) { SourcesValue = sources; @@ -322,6 +342,9 @@ public CompositeAggregationDescriptor Aggregations(Action + /// When paginating, use the `after_key` value returned in the previous response to retrieve the next page. + /// public CompositeAggregationDescriptor After(Func, FluentDictionary> selector) { AfterValue = selector?.Invoke(new FluentDictionary()); @@ -334,12 +357,18 @@ public CompositeAggregationDescriptor Meta(Func return Self; } + /// + /// The number of composite buckets that should be returned. + /// public CompositeAggregationDescriptor Size(int? size) { SizeValue = size; return Self; } + /// + /// The value sources used to build composite buckets.
Keys are returned in the order of the `sources` definition. + /// public CompositeAggregationDescriptor Sources(ICollection>? sources) { SourcesValue = sources; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregationSource.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregationSource.g.cs index 7e1ab0f7ce8..71a7f5627fb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregationSource.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/CompositeAggregationSource.g.cs @@ -29,202 +29,6 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class CompositeAggregationSource { - [JsonInclude, JsonPropertyName("date_histogram")] - public Elastic.Clients.Elasticsearch.Aggregations.DateHistogramAggregation? DateHistogram { get; set; } - [JsonInclude, JsonPropertyName("geotile_grid")] - public Elastic.Clients.Elasticsearch.Aggregations.GeotileGridAggregation? GeotileGrid { get; set; } - [JsonInclude, JsonPropertyName("histogram")] - public Elastic.Clients.Elasticsearch.Aggregations.HistogramAggregation? Histogram { get; set; } - [JsonInclude, JsonPropertyName("terms")] - public Elastic.Clients.Elasticsearch.Aggregations.TermsAggregation? Terms { get; set; } -} - -public sealed partial class CompositeAggregationSourceDescriptor : SerializableDescriptor> -{ - internal CompositeAggregationSourceDescriptor(Action> configure) => configure.Invoke(this); - - public CompositeAggregationSourceDescriptor() : base() - { - } - - private Elastic.Clients.Elasticsearch.Aggregations.DateHistogramAggregation? DateHistogramValue { get; set; } - private DateHistogramAggregationDescriptor DateHistogramDescriptor { get; set; } - private Action> DateHistogramDescriptorAction { get; set; } - private Elastic.Clients.Elasticsearch.Aggregations.GeotileGridAggregation? GeotileGridValue { get; set; } - private GeotileGridAggregationDescriptor GeotileGridDescriptor { get; set; } - private Action> GeotileGridDescriptorAction { get; set; } - private Elastic.Clients.Elasticsearch.Aggregations.HistogramAggregation? HistogramValue { get; set; } - private HistogramAggregationDescriptor HistogramDescriptor { get; set; } - private Action> HistogramDescriptorAction { get; set; } - private Elastic.Clients.Elasticsearch.Aggregations.TermsAggregation? TermsValue { get; set; } - private TermsAggregationDescriptor TermsDescriptor { get; set; } - private Action> TermsDescriptorAction { get; set; } - - public CompositeAggregationSourceDescriptor DateHistogram(Elastic.Clients.Elasticsearch.Aggregations.DateHistogramAggregation? dateHistogram) - { - DateHistogramDescriptor = null; - DateHistogramDescriptorAction = null; - DateHistogramValue = dateHistogram; - return Self; - } - - public CompositeAggregationSourceDescriptor DateHistogram(DateHistogramAggregationDescriptor descriptor) - { - DateHistogramValue = null; - DateHistogramDescriptorAction = null; - DateHistogramDescriptor = descriptor; - return Self; - } - - public CompositeAggregationSourceDescriptor DateHistogram(Action> configure) - { - DateHistogramValue = null; - DateHistogramDescriptor = null; - DateHistogramDescriptorAction = configure; - return Self; - } - - public CompositeAggregationSourceDescriptor GeotileGrid(Elastic.Clients.Elasticsearch.Aggregations.GeotileGridAggregation? geotileGrid) - { - GeotileGridDescriptor = null; - GeotileGridDescriptorAction = null; - GeotileGridValue = geotileGrid; - return Self; - } - - public CompositeAggregationSourceDescriptor GeotileGrid(GeotileGridAggregationDescriptor descriptor) - { - GeotileGridValue = null; - GeotileGridDescriptorAction = null; - GeotileGridDescriptor = descriptor; - return Self; - } - - public CompositeAggregationSourceDescriptor GeotileGrid(Action> configure) - { - GeotileGridValue = null; - GeotileGridDescriptor = null; - GeotileGridDescriptorAction = configure; - return Self; - } - - public CompositeAggregationSourceDescriptor Histogram(Elastic.Clients.Elasticsearch.Aggregations.HistogramAggregation? histogram) - { - HistogramDescriptor = null; - HistogramDescriptorAction = null; - HistogramValue = histogram; - return Self; - } - - public CompositeAggregationSourceDescriptor Histogram(HistogramAggregationDescriptor descriptor) - { - HistogramValue = null; - HistogramDescriptorAction = null; - HistogramDescriptor = descriptor; - return Self; - } - - public CompositeAggregationSourceDescriptor Histogram(Action> configure) - { - HistogramValue = null; - HistogramDescriptor = null; - HistogramDescriptorAction = configure; - return Self; - } - - public CompositeAggregationSourceDescriptor Terms(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregation? terms) - { - TermsDescriptor = null; - TermsDescriptorAction = null; - TermsValue = terms; - return Self; - } - - public CompositeAggregationSourceDescriptor Terms(TermsAggregationDescriptor descriptor) - { - TermsValue = null; - TermsDescriptorAction = null; - TermsDescriptor = descriptor; - return Self; - } - - public CompositeAggregationSourceDescriptor Terms(Action> configure) - { - TermsValue = null; - TermsDescriptor = null; - TermsDescriptorAction = configure; - return Self; - } - - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) - { - writer.WriteStartObject(); - if (DateHistogramDescriptor is not null) - { - writer.WritePropertyName("date_histogram"); - JsonSerializer.Serialize(writer, DateHistogramDescriptor, options); - } - else if (DateHistogramDescriptorAction is not null) - { - writer.WritePropertyName("date_histogram"); - JsonSerializer.Serialize(writer, new DateHistogramAggregationDescriptor(DateHistogramDescriptorAction), options); - } - else if (DateHistogramValue is not null) - { - writer.WritePropertyName("date_histogram"); - JsonSerializer.Serialize(writer, DateHistogramValue, options); - } - - if (GeotileGridDescriptor is not null) - { - writer.WritePropertyName("geotile_grid"); - JsonSerializer.Serialize(writer, GeotileGridDescriptor, options); - } - else if (GeotileGridDescriptorAction is not null) - { - writer.WritePropertyName("geotile_grid"); - JsonSerializer.Serialize(writer, new GeotileGridAggregationDescriptor(GeotileGridDescriptorAction), options); - } - else if (GeotileGridValue is not null) - { - writer.WritePropertyName("geotile_grid"); - JsonSerializer.Serialize(writer, GeotileGridValue, options); - } - - if (HistogramDescriptor is not null) - { - writer.WritePropertyName("histogram"); - JsonSerializer.Serialize(writer, HistogramDescriptor, options); - } - else if (HistogramDescriptorAction is not null) - { - writer.WritePropertyName("histogram"); - JsonSerializer.Serialize(writer, new HistogramAggregationDescriptor(HistogramDescriptorAction), options); - } - else if (HistogramValue is not null) - { - writer.WritePropertyName("histogram"); - JsonSerializer.Serialize(writer, HistogramValue, options); - } - - if (TermsDescriptor is not null) - { - writer.WritePropertyName("terms"); - JsonSerializer.Serialize(writer, TermsDescriptor, options); - } - else if (TermsDescriptorAction is not null) - { - writer.WritePropertyName("terms"); - JsonSerializer.Serialize(writer, new TermsAggregationDescriptor(TermsDescriptorAction), options); - } - else if (TermsValue is not null) - { - writer.WritePropertyName("terms"); - JsonSerializer.Serialize(writer, TermsValue, options); - } - - writer.WriteEndObject(); - } } public sealed partial class CompositeAggregationSourceDescriptor : SerializableDescriptor @@ -235,182 +39,7 @@ public CompositeAggregationSourceDescriptor() : base() { } - private Elastic.Clients.Elasticsearch.Aggregations.DateHistogramAggregation? DateHistogramValue { get; set; } - private DateHistogramAggregationDescriptor DateHistogramDescriptor { get; set; } - private Action DateHistogramDescriptorAction { get; set; } - private Elastic.Clients.Elasticsearch.Aggregations.GeotileGridAggregation? GeotileGridValue { get; set; } - private GeotileGridAggregationDescriptor GeotileGridDescriptor { get; set; } - private Action GeotileGridDescriptorAction { get; set; } - private Elastic.Clients.Elasticsearch.Aggregations.HistogramAggregation? HistogramValue { get; set; } - private HistogramAggregationDescriptor HistogramDescriptor { get; set; } - private Action HistogramDescriptorAction { get; set; } - private Elastic.Clients.Elasticsearch.Aggregations.TermsAggregation? TermsValue { get; set; } - private TermsAggregationDescriptor TermsDescriptor { get; set; } - private Action TermsDescriptorAction { get; set; } - - public CompositeAggregationSourceDescriptor DateHistogram(Elastic.Clients.Elasticsearch.Aggregations.DateHistogramAggregation? dateHistogram) - { - DateHistogramDescriptor = null; - DateHistogramDescriptorAction = null; - DateHistogramValue = dateHistogram; - return Self; - } - - public CompositeAggregationSourceDescriptor DateHistogram(DateHistogramAggregationDescriptor descriptor) - { - DateHistogramValue = null; - DateHistogramDescriptorAction = null; - DateHistogramDescriptor = descriptor; - return Self; - } - - public CompositeAggregationSourceDescriptor DateHistogram(Action configure) - { - DateHistogramValue = null; - DateHistogramDescriptor = null; - DateHistogramDescriptorAction = configure; - return Self; - } - - public CompositeAggregationSourceDescriptor GeotileGrid(Elastic.Clients.Elasticsearch.Aggregations.GeotileGridAggregation? geotileGrid) - { - GeotileGridDescriptor = null; - GeotileGridDescriptorAction = null; - GeotileGridValue = geotileGrid; - return Self; - } - - public CompositeAggregationSourceDescriptor GeotileGrid(GeotileGridAggregationDescriptor descriptor) - { - GeotileGridValue = null; - GeotileGridDescriptorAction = null; - GeotileGridDescriptor = descriptor; - return Self; - } - - public CompositeAggregationSourceDescriptor GeotileGrid(Action configure) - { - GeotileGridValue = null; - GeotileGridDescriptor = null; - GeotileGridDescriptorAction = configure; - return Self; - } - - public CompositeAggregationSourceDescriptor Histogram(Elastic.Clients.Elasticsearch.Aggregations.HistogramAggregation? histogram) - { - HistogramDescriptor = null; - HistogramDescriptorAction = null; - HistogramValue = histogram; - return Self; - } - - public CompositeAggregationSourceDescriptor Histogram(HistogramAggregationDescriptor descriptor) - { - HistogramValue = null; - HistogramDescriptorAction = null; - HistogramDescriptor = descriptor; - return Self; - } - - public CompositeAggregationSourceDescriptor Histogram(Action configure) - { - HistogramValue = null; - HistogramDescriptor = null; - HistogramDescriptorAction = configure; - return Self; - } - - public CompositeAggregationSourceDescriptor Terms(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregation? terms) - { - TermsDescriptor = null; - TermsDescriptorAction = null; - TermsValue = terms; - return Self; - } - - public CompositeAggregationSourceDescriptor Terms(TermsAggregationDescriptor descriptor) - { - TermsValue = null; - TermsDescriptorAction = null; - TermsDescriptor = descriptor; - return Self; - } - - public CompositeAggregationSourceDescriptor Terms(Action configure) - { - TermsValue = null; - TermsDescriptor = null; - TermsDescriptorAction = configure; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { - writer.WriteStartObject(); - if (DateHistogramDescriptor is not null) - { - writer.WritePropertyName("date_histogram"); - JsonSerializer.Serialize(writer, DateHistogramDescriptor, options); - } - else if (DateHistogramDescriptorAction is not null) - { - writer.WritePropertyName("date_histogram"); - JsonSerializer.Serialize(writer, new DateHistogramAggregationDescriptor(DateHistogramDescriptorAction), options); - } - else if (DateHistogramValue is not null) - { - writer.WritePropertyName("date_histogram"); - JsonSerializer.Serialize(writer, DateHistogramValue, options); - } - - if (GeotileGridDescriptor is not null) - { - writer.WritePropertyName("geotile_grid"); - JsonSerializer.Serialize(writer, GeotileGridDescriptor, options); - } - else if (GeotileGridDescriptorAction is not null) - { - writer.WritePropertyName("geotile_grid"); - JsonSerializer.Serialize(writer, new GeotileGridAggregationDescriptor(GeotileGridDescriptorAction), options); - } - else if (GeotileGridValue is not null) - { - writer.WritePropertyName("geotile_grid"); - JsonSerializer.Serialize(writer, GeotileGridValue, options); - } - - if (HistogramDescriptor is not null) - { - writer.WritePropertyName("histogram"); - JsonSerializer.Serialize(writer, HistogramDescriptor, options); - } - else if (HistogramDescriptorAction is not null) - { - writer.WritePropertyName("histogram"); - JsonSerializer.Serialize(writer, new HistogramAggregationDescriptor(HistogramDescriptorAction), options); - } - else if (HistogramValue is not null) - { - writer.WritePropertyName("histogram"); - JsonSerializer.Serialize(writer, HistogramValue, options); - } - - if (TermsDescriptor is not null) - { - writer.WritePropertyName("terms"); - JsonSerializer.Serialize(writer, TermsDescriptor, options); - } - else if (TermsDescriptorAction is not null) - { - writer.WritePropertyName("terms"); - JsonSerializer.Serialize(writer, new TermsAggregationDescriptor(TermsDescriptorAction), options); - } - else if (TermsValue is not null) - { - writer.WritePropertyName("terms"); - JsonSerializer.Serialize(writer, TermsValue, options); - } - - writer.WriteEndObject(); } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateHistogramAggregation.g.cs index aa56f0e844c..cc999940151 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateHistogramAggregation.g.cs @@ -305,19 +305,54 @@ internal DateHistogramAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// Calendar-aware interval.
Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`. + /// public Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? CalendarInterval { get; set; } + + /// + /// The date field whose values are use to build a histogram. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } + + /// + /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// public Elastic.Clients.Elasticsearch.Duration? FixedInterval { get; set; } + + /// + /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// public string? Format { get; set; } public IDictionary? Meta { get; set; } + + /// + /// Only returns buckets that have `min_doc_count` number of documents.
By default, all buckets between the first bucket that matches documents and the last one are returned. + /// public int? MinDocCount { get; set; } + + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public DateTimeOffset? Missing { get; set; } override public string? Name { get; internal set; } + + /// + /// Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration. + /// public Elastic.Clients.Elasticsearch.Duration? Offset { get; set; } [JsonConverter(typeof(AggregateOrderConverter))] + /// + /// The sort order of the returned buckets. + /// public ICollection>? Order { get; set; } public IDictionary? Params { get; set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } + + /// + /// Time zone used for bucketing and rounding.
Defaults to Coordinated Universal Time (UTC). + /// public string? TimeZone { get; set; } } @@ -369,30 +404,45 @@ public DateHistogramAggregationDescriptor Aggregations(Action + /// Calendar-aware interval.
Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`. + /// public DateHistogramAggregationDescriptor CalendarInterval(Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? calendarInterval) { CalendarIntervalValue = calendarInterval; return Self; } + /// + /// The date field whose values are use to build a histogram. + /// public DateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The date field whose values are use to build a histogram. + /// public DateHistogramAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// public DateHistogramAggregationDescriptor FixedInterval(Elastic.Clients.Elasticsearch.Duration? fixedInterval) { FixedIntervalValue = fixedInterval; return Self; } + /// + /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// public DateHistogramAggregationDescriptor Format(string? format) { FormatValue = format; @@ -405,24 +455,36 @@ public DateHistogramAggregationDescriptor Meta(Func + /// Only returns buckets that have `min_doc_count` number of documents.
By default, all buckets between the first bucket that matches documents and the last one are returned. + /// public DateHistogramAggregationDescriptor MinDocCount(int? minDocCount) { MinDocCountValue = minDocCount; return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public DateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) { MissingValue = missing; return Self; } + /// + /// Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration. + /// public DateHistogramAggregationDescriptor Offset(Elastic.Clients.Elasticsearch.Duration? offset) { OffsetValue = offset; return Self; } + /// + /// The sort order of the returned buckets. + /// public DateHistogramAggregationDescriptor Order(ICollection>? order) { OrderValue = order; @@ -441,6 +503,9 @@ public DateHistogramAggregationDescriptor Script(Elastic.Clients.Elas return Self; } + /// + /// Time zone used for bucketing and rounding.
Defaults to Coordinated Universal Time (UTC). + /// public DateHistogramAggregationDescriptor TimeZone(string? timeZone) { TimeZoneValue = timeZone; @@ -593,36 +658,54 @@ public DateHistogramAggregationDescriptor Aggregations(Action + /// Calendar-aware interval.
Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`. + /// public DateHistogramAggregationDescriptor CalendarInterval(Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? calendarInterval) { CalendarIntervalValue = calendarInterval; return Self; } + /// + /// The date field whose values are use to build a histogram. + /// public DateHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The date field whose values are use to build a histogram. + /// public DateHistogramAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The date field whose values are use to build a histogram. + /// public DateHistogramAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. + /// public DateHistogramAggregationDescriptor FixedInterval(Elastic.Clients.Elasticsearch.Duration? fixedInterval) { FixedIntervalValue = fixedInterval; return Self; } + /// + /// The date format used to format `key_as_string` in the response.
If no `format` is specified, the first date format specified in the field mapping is used. + /// public DateHistogramAggregationDescriptor Format(string? format) { FormatValue = format; @@ -635,24 +718,36 @@ public DateHistogramAggregationDescriptor Meta(Func + /// Only returns buckets that have `min_doc_count` number of documents.
By default, all buckets between the first bucket that matches documents and the last one are returned. + /// public DateHistogramAggregationDescriptor MinDocCount(int? minDocCount) { MinDocCountValue = minDocCount; return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public DateHistogramAggregationDescriptor Missing(DateTimeOffset? missing) { MissingValue = missing; return Self; } + /// + /// Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration. + /// public DateHistogramAggregationDescriptor Offset(Elastic.Clients.Elasticsearch.Duration? offset) { OffsetValue = offset; return Self; } + /// + /// The sort order of the returned buckets. + /// public DateHistogramAggregationDescriptor Order(ICollection>? order) { OrderValue = order; @@ -671,6 +766,9 @@ public DateHistogramAggregationDescriptor Script(Elastic.Clients.Elasticsearch.S return Self; } + /// + /// Time zone used for bucketing and rounding.
Defaults to Coordinated Universal Time (UTC). + /// public DateHistogramAggregationDescriptor TimeZone(string? timeZone) { TimeZoneValue = timeZone; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeAggregation.g.cs index a428fe766b0..eb21b95e059 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeAggregation.g.cs @@ -197,12 +197,32 @@ internal DateRangeAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// The date field whose values are use to build ranges. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } + + /// + /// The date format used to format `from` and `to` in the response. + /// public string? Format { get; set; } public IDictionary? Meta { get; set; } + + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public FieldValue? Missing { get; set; } override public string? Name { get; internal set; } + + /// + /// Array of date ranges. + /// public ICollection? Ranges { get; set; } + + /// + /// Time zone used to convert dates from another time zone to UTC. + /// public string? TimeZone { get; set; } } @@ -251,18 +271,27 @@ public DateRangeAggregationDescriptor Aggregations(Action + /// The date field whose values are use to build ranges. + /// public DateRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The date field whose values are use to build ranges. + /// public DateRangeAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The date format used to format `from` and `to` in the response. + /// public DateRangeAggregationDescriptor Format(string? format) { FormatValue = format; @@ -275,12 +304,18 @@ public DateRangeAggregationDescriptor Meta(Func + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public DateRangeAggregationDescriptor Missing(FieldValue? missing) { MissingValue = missing; return Self; } + /// + /// Array of date ranges. + /// public DateRangeAggregationDescriptor Ranges(ICollection? ranges) { RangesDescriptor = null; @@ -317,6 +352,9 @@ public DateRangeAggregationDescriptor Ranges(params Action + /// Time zone used to convert dates from another time zone to UTC. + /// public DateRangeAggregationDescriptor TimeZone(string? timeZone) { TimeZoneValue = timeZone; @@ -455,24 +493,36 @@ public DateRangeAggregationDescriptor Aggregations(Action + /// The date field whose values are use to build ranges. + /// public DateRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The date field whose values are use to build ranges. + /// public DateRangeAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The date field whose values are use to build ranges. + /// public DateRangeAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The date format used to format `from` and `to` in the response. + /// public DateRangeAggregationDescriptor Format(string? format) { FormatValue = format; @@ -485,12 +535,18 @@ public DateRangeAggregationDescriptor Meta(Func return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public DateRangeAggregationDescriptor Missing(FieldValue? missing) { MissingValue = missing; return Self; } + /// + /// Array of date ranges. + /// public DateRangeAggregationDescriptor Ranges(ICollection? ranges) { RangesDescriptor = null; @@ -527,6 +583,9 @@ public DateRangeAggregationDescriptor Ranges(params Action + /// Time zone used to convert dates from another time zone to UTC. + /// public DateRangeAggregationDescriptor TimeZone(string? timeZone) { TimeZoneValue = timeZone; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeExpression.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeExpression.g.cs index 40ece9f1609..419c5bde87f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeExpression.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DateRangeExpression.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class DateRangeExpression { + /// + /// Start of the range (inclusive). + /// [JsonInclude, JsonPropertyName("from")] public Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? From { get; set; } + + /// + /// Custom key to return the range with. + /// [JsonInclude, JsonPropertyName("key")] public string? Key { get; set; } + + /// + /// End of the range (exclusive). + /// [JsonInclude, JsonPropertyName("to")] public Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? To { get; set; } } @@ -49,18 +60,27 @@ public DateRangeExpressionDescriptor() : base() private string? KeyValue { get; set; } private Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? ToValue { get; set; } + /// + /// Start of the range (inclusive). + /// public DateRangeExpressionDescriptor From(Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? from) { FromValue = from; return Self; } + /// + /// Custom key to return the range with. + /// public DateRangeExpressionDescriptor Key(string? key) { KeyValue = key; return Self; } + /// + /// End of the range (exclusive). + /// public DateRangeExpressionDescriptor To(Elastic.Clients.Elasticsearch.Aggregations.FieldDateMath? to) { ToValue = to; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DiversifiedSamplerAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DiversifiedSamplerAggregation.g.cs index 65f216d2f17..5ce2aa4112b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DiversifiedSamplerAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/DiversifiedSamplerAggregation.g.cs @@ -197,12 +197,28 @@ internal DiversifiedSamplerAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// The type of value used for de-duplication. + /// public Elastic.Clients.Elasticsearch.Aggregations.SamplerAggregationExecutionHint? ExecutionHint { get; set; } + + /// + /// The field used to provide values used for de-duplication. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } + + /// + /// Limits how many documents are permitted per choice of de-duplicating value. + /// public int? MaxDocsPerValue { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } + + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// public int? ShardSize { get; set; } } @@ -248,24 +264,36 @@ public DiversifiedSamplerAggregationDescriptor Aggregations(Action + /// The type of value used for de-duplication. + /// public DiversifiedSamplerAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.SamplerAggregationExecutionHint? executionHint) { ExecutionHintValue = executionHint; return Self; } + /// + /// The field used to provide values used for de-duplication. + /// public DiversifiedSamplerAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The field used to provide values used for de-duplication. + /// public DiversifiedSamplerAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Limits how many documents are permitted per choice of de-duplicating value. + /// public DiversifiedSamplerAggregationDescriptor MaxDocsPerValue(int? maxDocsPerValue) { MaxDocsPerValueValue = maxDocsPerValue; @@ -284,6 +312,9 @@ public DiversifiedSamplerAggregationDescriptor Script(Elastic.Clients return Self; } + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// public DiversifiedSamplerAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; @@ -394,30 +425,45 @@ public DiversifiedSamplerAggregationDescriptor Aggregations(Action + /// The type of value used for de-duplication. + /// public DiversifiedSamplerAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.SamplerAggregationExecutionHint? executionHint) { ExecutionHintValue = executionHint; return Self; } + /// + /// The field used to provide values used for de-duplication. + /// public DiversifiedSamplerAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The field used to provide values used for de-duplication. + /// public DiversifiedSamplerAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field used to provide values used for de-duplication. + /// public DiversifiedSamplerAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Limits how many documents are permitted per choice of de-duplicating value. + /// public DiversifiedSamplerAggregationDescriptor MaxDocsPerValue(int? maxDocsPerValue) { MaxDocsPerValueValue = maxDocsPerValue; @@ -436,6 +482,9 @@ public DiversifiedSamplerAggregationDescriptor Script(Elastic.Clients.Elasticsea return Self; } + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// public DiversifiedSamplerAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsAggregation.g.cs index 5e86cf72f1d..e1fe4adfee4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsAggregation.g.cs @@ -186,6 +186,10 @@ internal ExtendedStatsAggregation() public FieldValue? Missing { get; set; } override public string? Name { get; internal set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } + + /// + /// The number of standard deviations above/below the mean to display. + /// public double? Sigma { get; set; } } @@ -240,6 +244,9 @@ public ExtendedStatsAggregationDescriptor Script(Elastic.Clients.Elas return Self; } + /// + /// The number of standard deviations above/below the mean to display. + /// public ExtendedStatsAggregationDescriptor Sigma(double? sigma) { SigmaValue = sigma; @@ -349,6 +356,9 @@ public ExtendedStatsAggregationDescriptor Script(Elastic.Clients.Elasticsearch.S return Self; } + /// + /// The number of standard deviations above/below the mean to display. + /// public ExtendedStatsAggregationDescriptor Sigma(double? sigma) { SigmaValue = sigma; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsBucketAggregation.g.cs index aad64d6ab21..a0cf17dcacb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ExtendedStatsBucketAggregation.g.cs @@ -166,6 +166,10 @@ internal ExtendedStatsBucketAggregation() public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// The number of standard deviations above/below the mean to display. + /// public double? Sigma { get; set; } } @@ -207,6 +211,9 @@ public ExtendedStatsBucketAggregationDescriptor Meta(Func + /// The number of standard deviations above/below the mean to display. + /// public ExtendedStatsBucketAggregationDescriptor Sigma(double? sigma) { SigmaValue = sigma; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FiltersAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FiltersAggregation.g.cs index bd1a5faa5f5..3e550f6e2fc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FiltersAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/FiltersAggregation.g.cs @@ -161,10 +161,22 @@ internal FiltersAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// Collection of queries from which to build buckets. + /// public Elastic.Clients.Elasticsearch.Aggregations.Buckets? Filters { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// public bool? OtherBucket { get; set; } + + /// + /// The key with which the other bucket is returned. + /// public string? OtherBucketKey { get; set; } } @@ -208,6 +220,9 @@ public FiltersAggregationDescriptor Aggregations(Action + /// Collection of queries from which to build buckets. + /// public FiltersAggregationDescriptor Filters(Elastic.Clients.Elasticsearch.Aggregations.Buckets? filters) { FiltersValue = filters; @@ -220,12 +235,18 @@ public FiltersAggregationDescriptor Meta(Func + /// Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// public FiltersAggregationDescriptor OtherBucket(bool? otherBucket = true) { OtherBucketValue = otherBucket; return Self; } + /// + /// The key with which the other bucket is returned. + /// public FiltersAggregationDescriptor OtherBucketKey(string? otherBucketKey) { OtherBucketKeyValue = otherBucketKey; @@ -322,6 +343,9 @@ public FiltersAggregationDescriptor Aggregations(Action + /// Collection of queries from which to build buckets. + /// public FiltersAggregationDescriptor Filters(Elastic.Clients.Elasticsearch.Aggregations.Buckets? filters) { FiltersValue = filters; @@ -334,12 +358,18 @@ public FiltersAggregationDescriptor Meta(Func, return Self; } + /// + /// Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. + /// public FiltersAggregationDescriptor OtherBucket(bool? otherBucket = true) { OtherBucketValue = otherBucket; return Self; } + /// + /// The key with which the other bucket is returned. + /// public FiltersAggregationDescriptor OtherBucketKey(string? otherBucketKey) { OtherBucketKeyValue = otherBucketKey; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoBoundsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoBoundsAggregation.g.cs index 00edbe132fd..f5e9b73a227 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoBoundsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoBoundsAggregation.g.cs @@ -167,6 +167,10 @@ internal GeoBoundsAggregation() public FieldValue? Missing { get; set; } override public string? Name { get; internal set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } + + /// + /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// public bool? WrapLongitude { get; set; } } @@ -214,6 +218,9 @@ public GeoBoundsAggregationDescriptor Script(Elastic.Clients.Elastics return Self; } + /// + /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// public GeoBoundsAggregationDescriptor WrapLongitude(bool? wrapLongitude = true) { WrapLongitudeValue = wrapLongitude; @@ -310,6 +317,9 @@ public GeoBoundsAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Scrip return Self; } + /// + /// Specifies whether the bounding box should be allowed to overlap the international date line. + /// public GeoBoundsAggregationDescriptor WrapLongitude(bool? wrapLongitude = true) { WrapLongitudeValue = wrapLongitude; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoDistanceAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoDistanceAggregation.g.cs index 8d09308c1e0..4dc589e25a4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoDistanceAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoDistanceAggregation.g.cs @@ -197,12 +197,32 @@ internal GeoDistanceAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// The distance calculation type. + /// public Elastic.Clients.Elasticsearch.GeoDistanceType? DistanceType { get; set; } + + /// + /// A field of type `geo_point` used to evaluate the distance. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// The origin used to evaluate the distance. + /// public Elastic.Clients.Elasticsearch.GeoLocation? Origin { get; set; } + + /// + /// An array of ranges used to bucket documents. + /// public ICollection? Ranges { get; set; } + + /// + /// The distance unit. + /// public Elastic.Clients.Elasticsearch.DistanceUnit? Unit { get; set; } } @@ -251,18 +271,27 @@ public GeoDistanceAggregationDescriptor Aggregations(Action + /// The distance calculation type. + /// public GeoDistanceAggregationDescriptor DistanceType(Elastic.Clients.Elasticsearch.GeoDistanceType? distanceType) { DistanceTypeValue = distanceType; return Self; } + /// + /// A field of type `geo_point` used to evaluate the distance. + /// public GeoDistanceAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// A field of type `geo_point` used to evaluate the distance. + /// public GeoDistanceAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -275,12 +304,18 @@ public GeoDistanceAggregationDescriptor Meta(Func + /// The origin used to evaluate the distance. + /// public GeoDistanceAggregationDescriptor Origin(Elastic.Clients.Elasticsearch.GeoLocation? origin) { OriginValue = origin; return Self; } + /// + /// An array of ranges used to bucket documents. + /// public GeoDistanceAggregationDescriptor Ranges(ICollection? ranges) { RangesDescriptor = null; @@ -317,6 +352,9 @@ public GeoDistanceAggregationDescriptor Ranges(params Action + /// The distance unit. + /// public GeoDistanceAggregationDescriptor Unit(Elastic.Clients.Elasticsearch.DistanceUnit? unit) { UnitValue = unit; @@ -455,24 +493,36 @@ public GeoDistanceAggregationDescriptor Aggregations(Action + /// The distance calculation type. + /// public GeoDistanceAggregationDescriptor DistanceType(Elastic.Clients.Elasticsearch.GeoDistanceType? distanceType) { DistanceTypeValue = distanceType; return Self; } + /// + /// A field of type `geo_point` used to evaluate the distance. + /// public GeoDistanceAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// A field of type `geo_point` used to evaluate the distance. + /// public GeoDistanceAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// A field of type `geo_point` used to evaluate the distance. + /// public GeoDistanceAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -485,12 +535,18 @@ public GeoDistanceAggregationDescriptor Meta(Func + /// The origin used to evaluate the distance. + /// public GeoDistanceAggregationDescriptor Origin(Elastic.Clients.Elasticsearch.GeoLocation? origin) { OriginValue = origin; return Self; } + /// + /// An array of ranges used to bucket documents. + /// public GeoDistanceAggregationDescriptor Ranges(ICollection? ranges) { RangesDescriptor = null; @@ -527,6 +583,9 @@ public GeoDistanceAggregationDescriptor Ranges(params Action + /// The distance unit. + /// public GeoDistanceAggregationDescriptor Unit(Elastic.Clients.Elasticsearch.DistanceUnit? unit) { UnitValue = unit; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineAggregation.g.cs index 9b0358db46a..2a23bc3ef3c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineAggregation.g.cs @@ -163,12 +163,31 @@ internal GeoLineAggregation() { } + /// + /// When `true`, returns an additional array of the sort values in the feature properties. + /// public bool? IncludeSort { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// The name of the geo_point field. + /// public Elastic.Clients.Elasticsearch.Aggregations.GeoLinePoint Point { get; set; } + + /// + /// The maximum length of the line represented in the aggregation.
Valid sizes are between 1 and 10000. + /// public int? Size { get; set; } + + /// + /// The name of the numeric field to use as the sort key for ordering the points.
When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error. + /// public Elastic.Clients.Elasticsearch.Aggregations.GeoLineSort Sort { get; set; } + + /// + /// The order in which the line is sorted (ascending or descending). + /// public Elastic.Clients.Elasticsearch.SortOrder? SortOrder { get; set; } } @@ -191,6 +210,9 @@ public GeoLineAggregationDescriptor() : base() private int? SizeValue { get; set; } private Elastic.Clients.Elasticsearch.SortOrder? SortOrderValue { get; set; } + /// + /// The name of the geo_point field. + /// public GeoLineAggregationDescriptor Point(Elastic.Clients.Elasticsearch.Aggregations.GeoLinePoint point) { PointDescriptor = null; @@ -215,6 +237,9 @@ public GeoLineAggregationDescriptor Point(Action + /// The name of the numeric field to use as the sort key for ordering the points.
When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error. + /// public GeoLineAggregationDescriptor Sort(Elastic.Clients.Elasticsearch.Aggregations.GeoLineSort sort) { SortDescriptor = null; @@ -239,6 +264,9 @@ public GeoLineAggregationDescriptor Sort(Action + /// When `true`, returns an additional array of the sort values in the feature properties. + /// public GeoLineAggregationDescriptor IncludeSort(bool? includeSort = true) { IncludeSortValue = includeSort; @@ -251,12 +279,18 @@ public GeoLineAggregationDescriptor Meta(Func + /// The maximum length of the line represented in the aggregation.
Valid sizes are between 1 and 10000. + /// public GeoLineAggregationDescriptor Size(int? size) { SizeValue = size; return Self; } + /// + /// The order in which the line is sorted (ascending or descending). + /// public GeoLineAggregationDescriptor SortOrder(Elastic.Clients.Elasticsearch.SortOrder? sortOrder) { SortOrderValue = sortOrder; @@ -348,6 +382,9 @@ public GeoLineAggregationDescriptor() : base() private int? SizeValue { get; set; } private Elastic.Clients.Elasticsearch.SortOrder? SortOrderValue { get; set; } + /// + /// The name of the geo_point field. + /// public GeoLineAggregationDescriptor Point(Elastic.Clients.Elasticsearch.Aggregations.GeoLinePoint point) { PointDescriptor = null; @@ -372,6 +409,9 @@ public GeoLineAggregationDescriptor Point(Action configu return Self; } + /// + /// The name of the numeric field to use as the sort key for ordering the points.
When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error. + /// public GeoLineAggregationDescriptor Sort(Elastic.Clients.Elasticsearch.Aggregations.GeoLineSort sort) { SortDescriptor = null; @@ -396,6 +436,9 @@ public GeoLineAggregationDescriptor Sort(Action configure return Self; } + /// + /// When `true`, returns an additional array of the sort values in the feature properties. + /// public GeoLineAggregationDescriptor IncludeSort(bool? includeSort = true) { IncludeSortValue = includeSort; @@ -408,12 +451,18 @@ public GeoLineAggregationDescriptor Meta(Func, return Self; } + /// + /// The maximum length of the line represented in the aggregation.
Valid sizes are between 1 and 10000. + /// public GeoLineAggregationDescriptor Size(int? size) { SizeValue = size; return Self; } + /// + /// The order in which the line is sorted (ascending or descending). + /// public GeoLineAggregationDescriptor SortOrder(Elastic.Clients.Elasticsearch.SortOrder? sortOrder) { SortOrderValue = sortOrder; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLinePoint.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLinePoint.g.cs index 1e74f52c307..ab26f8f02bf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLinePoint.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLinePoint.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class GeoLinePoint { + /// + /// The name of the geo_point field. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } } @@ -43,12 +46,18 @@ public GeoLinePointDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } + /// + /// The name of the geo_point field. + /// public GeoLinePointDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The name of the geo_point field. + /// public GeoLinePointDescriptor Field(Expression> field) { FieldValue = field; @@ -74,18 +83,27 @@ public GeoLinePointDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } + /// + /// The name of the geo_point field. + /// public GeoLinePointDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The name of the geo_point field. + /// public GeoLinePointDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The name of the geo_point field. + /// public GeoLinePointDescriptor Field(Expression> field) { FieldValue = field; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineSort.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineSort.g.cs index 335562f4eee..080520cf0e1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineSort.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeoLineSort.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class GeoLineSort { + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } } @@ -43,12 +46,18 @@ public GeoLineSortDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// public GeoLineSortDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// public GeoLineSortDescriptor Field(Expression> field) { FieldValue = field; @@ -74,18 +83,27 @@ public GeoLineSortDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// public GeoLineSortDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// public GeoLineSortDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The name of the numeric field to use as the sort key for ordering the points. + /// public GeoLineSortDescriptor Field(Expression> field) { FieldValue = field; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohashGridAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohashGridAggregation.g.cs index 6696c28859a..0431128bc09 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohashGridAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohashGridAggregation.g.cs @@ -197,12 +197,32 @@ internal GeohashGridAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// The bounding box to filter the points in each bucket. + /// public Elastic.Clients.Elasticsearch.GeoBounds? Bounds { get; set; } + + /// + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// The string length of the geohashes used to define cells/buckets in the results. + /// public Elastic.Clients.Elasticsearch.GeohashPrecision? Precision { get; set; } + + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// public int? ShardSize { get; set; } + + /// + /// The maximum number of geohash buckets to return. + /// public int? Size { get; set; } } @@ -248,18 +268,27 @@ public GeohashGridAggregationDescriptor Aggregations(Action + /// The bounding box to filter the points in each bucket. + /// public GeohashGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.GeoBounds? bounds) { BoundsValue = bounds; return Self; } + /// + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// public GeohashGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// public GeohashGridAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -272,18 +301,27 @@ public GeohashGridAggregationDescriptor Meta(Func + /// The string length of the geohashes used to define cells/buckets in the results. + /// public GeohashGridAggregationDescriptor Precision(Elastic.Clients.Elasticsearch.GeohashPrecision? precision) { PrecisionValue = precision; return Self; } + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// public GeohashGridAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; return Self; } + /// + /// The maximum number of geohash buckets to return. + /// public GeohashGridAggregationDescriptor Size(int? size) { SizeValue = size; @@ -394,24 +432,36 @@ public GeohashGridAggregationDescriptor Aggregations(Action + /// The bounding box to filter the points in each bucket. + /// public GeohashGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.GeoBounds? bounds) { BoundsValue = bounds; return Self; } + /// + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// public GeohashGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// public GeohashGridAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohash_grid` aggregates all array values. + /// public GeohashGridAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -424,18 +474,27 @@ public GeohashGridAggregationDescriptor Meta(Func + /// The string length of the geohashes used to define cells/buckets in the results. + /// public GeohashGridAggregationDescriptor Precision(Elastic.Clients.Elasticsearch.GeohashPrecision? precision) { PrecisionValue = precision; return Self; } + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// public GeohashGridAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; return Self; } + /// + /// The maximum number of geohash buckets to return. + /// public GeohashGridAggregationDescriptor Size(int? size) { SizeValue = size; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohexGridAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohexGridAggregation.g.cs index fc8c12b855a..6fa495849ff 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohexGridAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeohexGridAggregation.g.cs @@ -196,7 +196,7 @@ internal GeohexGridAggregation() public Elastic.Clients.Elasticsearch.GeoBounds? Bounds { get; set; } /// - /// Field containing indexed geo-point values. Must be explicitly
mapped as a `geo_point` field. If the field contains an array
`geohex_grid` aggregates all array values. + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. /// public Elastic.Clients.Elasticsearch.Field Field { get; set; } public IDictionary? Meta { get; set; } @@ -270,7 +270,7 @@ public GeohexGridAggregationDescriptor Bounds(Elastic.Clients.Elastic } /// - /// Field containing indexed geo-point values. Must be explicitly
mapped as a `geo_point` field. If the field contains an array
`geohex_grid` aggregates all array values. + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. /// public GeohexGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -279,7 +279,7 @@ public GeohexGridAggregationDescriptor Field(Elastic.Clients.Elastics } /// - /// Field containing indexed geo-point values. Must be explicitly
mapped as a `geo_point` field. If the field contains an array
`geohex_grid` aggregates all array values. + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. /// public GeohexGridAggregationDescriptor Field(Expression> field) { @@ -430,7 +430,7 @@ public GeohexGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.GeoB } /// - /// Field containing indexed geo-point values. Must be explicitly
mapped as a `geo_point` field. If the field contains an array
`geohex_grid` aggregates all array values. + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. /// public GeohexGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -439,7 +439,7 @@ public GeohexGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field } /// - /// Field containing indexed geo-point values. Must be explicitly
mapped as a `geo_point` field. If the field contains an array
`geohex_grid` aggregates all array values. + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. /// public GeohexGridAggregationDescriptor Field(Expression> field) { @@ -448,7 +448,7 @@ public GeohexGridAggregationDescriptor Field(Expression - /// Field containing indexed geo-point values. Must be explicitly
mapped as a `geo_point` field. If the field contains an array
`geohex_grid` aggregates all array values. + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geohex_grid` aggregates all array values. /// public GeohexGridAggregationDescriptor Field(Expression> field) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeotileGridAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeotileGridAggregation.g.cs index 15ce214daa5..6d94aad20a5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeotileGridAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GeotileGridAggregation.g.cs @@ -197,12 +197,32 @@ internal GeotileGridAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// public Elastic.Clients.Elasticsearch.GeoBounds? Bounds { get; set; } + + /// + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// Integer zoom of the key used to define cells/buckets in the results.
Values outside of the range [0,29] will be rejected. + /// public double? Precision { get; set; } + + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// public int? ShardSize { get; set; } + + /// + /// The maximum number of buckets to return. + /// public int? Size { get; set; } } @@ -248,18 +268,27 @@ public GeotileGridAggregationDescriptor Aggregations(Action + /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// public GeotileGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.GeoBounds? bounds) { BoundsValue = bounds; return Self; } + /// + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// public GeotileGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// public GeotileGridAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -272,18 +301,27 @@ public GeotileGridAggregationDescriptor Meta(Func + /// Integer zoom of the key used to define cells/buckets in the results.
Values outside of the range [0,29] will be rejected. + /// public GeotileGridAggregationDescriptor Precision(double? precision) { PrecisionValue = precision; return Self; } + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// public GeotileGridAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; return Self; } + /// + /// The maximum number of buckets to return. + /// public GeotileGridAggregationDescriptor Size(int? size) { SizeValue = size; @@ -394,24 +432,36 @@ public GeotileGridAggregationDescriptor Aggregations(Action + /// A bounding box to filter the geo-points or geo-shapes in each bucket. + /// public GeotileGridAggregationDescriptor Bounds(Elastic.Clients.Elasticsearch.GeoBounds? bounds) { BoundsValue = bounds; return Self; } + /// + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// public GeotileGridAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// public GeotileGridAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Field containing indexed `geo_point` or `geo_shape` values.
If the field contains an array, `geotile_grid` aggregates all array values. + /// public GeotileGridAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -424,18 +474,27 @@ public GeotileGridAggregationDescriptor Meta(Func + /// Integer zoom of the key used to define cells/buckets in the results.
Values outside of the range [0,29] will be rejected. + /// public GeotileGridAggregationDescriptor Precision(double? precision) { PrecisionValue = precision; return Self; } + /// + /// Allows for more accurate counting of the top cells returned in the final result the aggregation.
Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + /// public GeotileGridAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; return Self; } + /// + /// The maximum number of buckets to return. + /// public GeotileGridAggregationDescriptor Size(int? size) { SizeValue = size; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GoogleNormalizedDistanceHeuristic.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GoogleNormalizedDistanceHeuristic.g.cs index 53e547e6721..892bcf25808 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GoogleNormalizedDistanceHeuristic.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/GoogleNormalizedDistanceHeuristic.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class GoogleNormalizedDistanceHeuristic { + /// + /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// [JsonInclude, JsonPropertyName("background_is_superset")] public bool? BackgroundIsSuperset { get; set; } } @@ -43,6 +46,9 @@ public GoogleNormalizedDistanceHeuristicDescriptor() : base() private bool? BackgroundIsSupersetValue { get; set; } + /// + /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// public GoogleNormalizedDistanceHeuristicDescriptor BackgroundIsSuperset(bool? backgroundIsSuperset = true) { BackgroundIsSupersetValue = backgroundIsSuperset; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HdrMethod.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HdrMethod.g.cs new file mode 100644 index 00000000000..2ec10b55d2a --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HdrMethod.g.cs @@ -0,0 +1,69 @@ +// Licensed to Elasticsearch B.V under one or more agreements. +// Elasticsearch B.V licenses this file to you under the Apache 2.0 License. +// See the LICENSE file in the project root for more information. +// +// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗ +// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝ +// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗ +// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝ +// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗ +// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝ +// ------------------------------------------------ +// +// This file is automatically generated. +// Please do not edit these files manually. +// +// ------------------------------------------------ + +#nullable restore + +using Elastic.Clients.Elasticsearch.Fluent; +using Elastic.Clients.Elasticsearch.Serialization; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Aggregations; + +public sealed partial class HdrMethod +{ + /// + /// Specifies the resolution of values for the histogram in number of significant digits. + /// + [JsonInclude, JsonPropertyName("number_of_significant_value_digits")] + public int? NumberOfSignificantValueDigits { get; set; } +} + +public sealed partial class HdrMethodDescriptor : SerializableDescriptor +{ + internal HdrMethodDescriptor(Action configure) => configure.Invoke(this); + + public HdrMethodDescriptor() : base() + { + } + + private int? NumberOfSignificantValueDigitsValue { get; set; } + + /// + /// Specifies the resolution of values for the histogram in number of significant digits. + /// + public HdrMethodDescriptor NumberOfSignificantValueDigits(int? numberOfSignificantValueDigits) + { + NumberOfSignificantValueDigitsValue = numberOfSignificantValueDigits; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (NumberOfSignificantValueDigitsValue.HasValue) + { + writer.WritePropertyName("number_of_significant_value_digits"); + writer.WriteNumberValue(NumberOfSignificantValueDigitsValue.Value); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HistogramAggregation.g.cs index bba12dc7cf1..e57e18b0b50 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/HistogramAggregation.g.cs @@ -251,15 +251,38 @@ internal HistogramAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// The name of the field to aggregate on. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } public string? Format { get; set; } + + /// + /// The interval for the buckets.
Must be a positive decimal. + /// public double? Interval { get; set; } public IDictionary? Meta { get; set; } + + /// + /// Only returns buckets that have `min_doc_count` number of documents.
By default, the response will fill gaps in the histogram with empty buckets. + /// public int? MinDocCount { get; set; } + + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public double? Missing { get; set; } override public string? Name { get; internal set; } + + /// + /// By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.
The bucket boundaries can be shifted by using the `offset` option. + /// public double? Offset { get; set; } [JsonConverter(typeof(AggregateOrderConverter))] + /// + /// The sort order of the returned buckets.
By default, the returned buckets are sorted by their key ascending. + /// public ICollection>? Order { get; set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } } @@ -309,12 +332,18 @@ public HistogramAggregationDescriptor Aggregations(Action + /// The name of the field to aggregate on. + /// public HistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The name of the field to aggregate on. + /// public HistogramAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -327,6 +356,9 @@ public HistogramAggregationDescriptor Format(string? format) return Self; } + /// + /// The interval for the buckets.
Must be a positive decimal. + /// public HistogramAggregationDescriptor Interval(double? interval) { IntervalValue = interval; @@ -339,24 +371,36 @@ public HistogramAggregationDescriptor Meta(Func + /// Only returns buckets that have `min_doc_count` number of documents.
By default, the response will fill gaps in the histogram with empty buckets. + /// public HistogramAggregationDescriptor MinDocCount(int? minDocCount) { MinDocCountValue = minDocCount; return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public HistogramAggregationDescriptor Missing(double? missing) { MissingValue = missing; return Self; } + /// + /// By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.
The bucket boundaries can be shifted by using the `offset` option. + /// public HistogramAggregationDescriptor Offset(double? offset) { OffsetValue = offset; return Self; } + /// + /// The sort order of the returned buckets.
By default, the returned buckets are sorted by their key ascending. + /// public HistogramAggregationDescriptor Order(ICollection>? order) { OrderValue = order; @@ -494,18 +538,27 @@ public HistogramAggregationDescriptor Aggregations(Action + /// The name of the field to aggregate on. + /// public HistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The name of the field to aggregate on. + /// public HistogramAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The name of the field to aggregate on. + /// public HistogramAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -518,6 +571,9 @@ public HistogramAggregationDescriptor Format(string? format) return Self; } + /// + /// The interval for the buckets.
Must be a positive decimal. + /// public HistogramAggregationDescriptor Interval(double? interval) { IntervalValue = interval; @@ -530,24 +586,36 @@ public HistogramAggregationDescriptor Meta(Func return Self; } + /// + /// Only returns buckets that have `min_doc_count` number of documents.
By default, the response will fill gaps in the histogram with empty buckets. + /// public HistogramAggregationDescriptor MinDocCount(int? minDocCount) { MinDocCountValue = minDocCount; return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public HistogramAggregationDescriptor Missing(double? missing) { MissingValue = missing; return Self; } + /// + /// By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.
The bucket boundaries can be shifted by using the `offset` option. + /// public HistogramAggregationDescriptor Offset(double? offset) { OffsetValue = offset; return Self; } + /// + /// The sort order of the returned buckets.
By default, the returned buckets are sorted by their key ascending. + /// public HistogramAggregationDescriptor Order(ICollection>? order) { OrderValue = order; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/InferenceAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/InferenceAggregation.g.cs index 4334972643f..d2be96d1c4f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/InferenceAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/InferenceAggregation.g.cs @@ -174,8 +174,16 @@ internal InferenceAggregation() public Elastic.Clients.Elasticsearch.Aggregations.BucketsPath? BucketsPath { get; set; } public string? Format { get; set; } public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } + + /// + /// Contains the inference type and its options. + /// public Elastic.Clients.Elasticsearch.Aggregations.InferenceConfig? InferenceConfig { get; set; } public IDictionary? Meta { get; set; } + + /// + /// The ID or alias for the trained model. + /// public Elastic.Clients.Elasticsearch.Name ModelId { get; set; } override public string? Name { get; internal set; } } @@ -197,6 +205,9 @@ public InferenceAggregationDescriptor() : base() private IDictionary? MetaValue { get; set; } private Elastic.Clients.Elasticsearch.Name ModelIdValue { get; set; } + /// + /// Contains the inference type and its options. + /// public InferenceAggregationDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Aggregations.InferenceConfig? inferenceConfig) { InferenceConfigDescriptor = null; @@ -245,6 +256,9 @@ public InferenceAggregationDescriptor Meta(Func + /// The ID or alias for the trained model. + /// public InferenceAggregationDescriptor ModelId(Elastic.Clients.Elasticsearch.Name modelId) { ModelIdValue = modelId; @@ -320,6 +334,9 @@ public InferenceAggregationDescriptor() : base() private IDictionary? MetaValue { get; set; } private Elastic.Clients.Elasticsearch.Name ModelIdValue { get; set; } + /// + /// Contains the inference type and its options. + /// public InferenceAggregationDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Aggregations.InferenceConfig? inferenceConfig) { InferenceConfigDescriptor = null; @@ -368,6 +385,9 @@ public InferenceAggregationDescriptor Meta(Func return Self; } + /// + /// The ID or alias for the trained model. + /// public InferenceAggregationDescriptor ModelId(Elastic.Clients.Elasticsearch.Name modelId) { ModelIdValue = modelId; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpPrefixAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpPrefixAggregation.g.cs index fcefcf7356e..6f80a3e147a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpPrefixAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpPrefixAggregation.g.cs @@ -206,7 +206,7 @@ internal IpPrefixAggregation() public bool? AppendPrefixLength { get; set; } /// - /// The document IP address field to aggregation on. The field mapping type must be `ip` + /// The IP address field to aggregation on. The field mapping type must be `ip`. /// public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -222,7 +222,7 @@ internal IpPrefixAggregation() public IDictionary? Meta { get; set; } /// - /// Minimum number of documents for buckets to be included in the response. + /// Minimum number of documents in a bucket for it to be included in the response. /// public long? MinDocCount { get; set; } override public string? Name { get; internal set; } @@ -286,7 +286,7 @@ public IpPrefixAggregationDescriptor AppendPrefixLength(bool? appendP } /// - /// The document IP address field to aggregation on. The field mapping type must be `ip` + /// The IP address field to aggregation on. The field mapping type must be `ip`. /// public IpPrefixAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -295,7 +295,7 @@ public IpPrefixAggregationDescriptor Field(Elastic.Clients.Elasticsea } /// - /// The document IP address field to aggregation on. The field mapping type must be `ip` + /// The IP address field to aggregation on. The field mapping type must be `ip`. /// public IpPrefixAggregationDescriptor Field(Expression> field) { @@ -328,7 +328,7 @@ public IpPrefixAggregationDescriptor Meta(Func - /// Minimum number of documents for buckets to be included in the response. + /// Minimum number of documents in a bucket for it to be included in the response. /// public IpPrefixAggregationDescriptor MinDocCount(long? minDocCount) { @@ -458,7 +458,7 @@ public IpPrefixAggregationDescriptor AppendPrefixLength(bool? appendPrefixLength } /// - /// The document IP address field to aggregation on. The field mapping type must be `ip` + /// The IP address field to aggregation on. The field mapping type must be `ip`. /// public IpPrefixAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { @@ -467,7 +467,7 @@ public IpPrefixAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field f } /// - /// The document IP address field to aggregation on. The field mapping type must be `ip` + /// The IP address field to aggregation on. The field mapping type must be `ip`. /// public IpPrefixAggregationDescriptor Field(Expression> field) { @@ -476,7 +476,7 @@ public IpPrefixAggregationDescriptor Field(Expression - /// The document IP address field to aggregation on. The field mapping type must be `ip` + /// The IP address field to aggregation on. The field mapping type must be `ip`. /// public IpPrefixAggregationDescriptor Field(Expression> field) { @@ -509,7 +509,7 @@ public IpPrefixAggregationDescriptor Meta(Func, } /// - /// Minimum number of documents for buckets to be included in the response. + /// Minimum number of documents in a bucket for it to be included in the response. /// public IpPrefixAggregationDescriptor MinDocCount(long? minDocCount) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregation.g.cs index 499bfe5b1d2..18e407da0d6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregation.g.cs @@ -143,9 +143,17 @@ internal IpRangeAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// The date field whose values are used to build ranges. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// Array of IP ranges. + /// public ICollection? Ranges { get; set; } } @@ -191,12 +199,18 @@ public IpRangeAggregationDescriptor Aggregations(Action + /// The date field whose values are used to build ranges. + /// public IpRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The date field whose values are used to build ranges. + /// public IpRangeAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -209,6 +223,9 @@ public IpRangeAggregationDescriptor Meta(Func + /// Array of IP ranges. + /// public IpRangeAggregationDescriptor Ranges(ICollection? ranges) { RangesDescriptor = null; @@ -356,18 +373,27 @@ public IpRangeAggregationDescriptor Aggregations(Action + /// The date field whose values are used to build ranges. + /// public IpRangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The date field whose values are used to build ranges. + /// public IpRangeAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The date field whose values are used to build ranges. + /// public IpRangeAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -380,6 +406,9 @@ public IpRangeAggregationDescriptor Meta(Func, return Self; } + /// + /// Array of IP ranges. + /// public IpRangeAggregationDescriptor Ranges(ICollection? ranges) { RangesDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregationRange.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregationRange.g.cs index b182e8f0d30..22713397185 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregationRange.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/IpRangeAggregationRange.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class IpRangeAggregationRange { + /// + /// Start of the range. + /// [JsonInclude, JsonPropertyName("from")] public string? From { get; set; } + + /// + /// IP range defined as a CIDR mask. + /// [JsonInclude, JsonPropertyName("mask")] public string? Mask { get; set; } + + /// + /// End of the range. + /// [JsonInclude, JsonPropertyName("to")] public string? To { get; set; } } @@ -49,18 +60,27 @@ public IpRangeAggregationRangeDescriptor() : base() private string? MaskValue { get; set; } private string? ToValue { get; set; } + /// + /// Start of the range. + /// public IpRangeAggregationRangeDescriptor From(string? from) { FromValue = from; return Self; } + /// + /// IP range defined as a CIDR mask. + /// public IpRangeAggregationRangeDescriptor Mask(string? mask) { MaskValue = mask; return Self; } + /// + /// End of the range. + /// public IpRangeAggregationRangeDescriptor To(string? to) { ToValue = to; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MatrixStatsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MatrixStatsAggregation.g.cs index 1dc7291f804..c1513bb4f0d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MatrixStatsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MatrixStatsAggregation.g.cs @@ -146,6 +146,10 @@ internal MatrixStatsAggregation() public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } public IDictionary? Meta { get; set; } public IDictionary? Missing { get; set; } + + /// + /// Array value the aggregation will use for array or multi-valued fields. + /// public Elastic.Clients.Elasticsearch.SortMode? Mode { get; set; } override public string? Name { get; internal set; } } @@ -181,6 +185,9 @@ public MatrixStatsAggregationDescriptor Missing(Func + /// Array value the aggregation will use for array or multi-valued fields. + /// public MatrixStatsAggregationDescriptor Mode(Elastic.Clients.Elasticsearch.SortMode? mode) { ModeValue = mode; @@ -252,6 +259,9 @@ public MatrixStatsAggregationDescriptor Missing(Func + /// Array value the aggregation will use for array or multi-valued fields. + /// public MatrixStatsAggregationDescriptor Mode(Elastic.Clients.Elasticsearch.SortMode? mode) { ModeValue = mode; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregation.g.cs index f8288d23c13..1360e30b0ea 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MedianAbsoluteDeviationAggregation.g.cs @@ -180,6 +180,9 @@ internal MedianAbsoluteDeviationAggregation() { } + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// public double? Compression { get; set; } public Elastic.Clients.Elasticsearch.Field? Field { get; set; } public string? Format { get; set; } @@ -204,6 +207,9 @@ public MedianAbsoluteDeviationAggregationDescriptor() : base() private FieldValue? MissingValue { get; set; } private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// public MedianAbsoluteDeviationAggregationDescriptor Compression(double? compression) { CompressionValue = compression; @@ -307,6 +313,9 @@ public MedianAbsoluteDeviationAggregationDescriptor() : base() private FieldValue? MissingValue { get; set; } private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// public MedianAbsoluteDeviationAggregationDescriptor Compression(double? compression) { CompressionValue = compression; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MissingAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MissingAggregation.g.cs index c36e842f9e5..d85a9762d4b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MissingAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MissingAggregation.g.cs @@ -143,6 +143,10 @@ internal MissingAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// The name of the field. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } public IDictionary? Meta { get; set; } public FieldValue? Missing { get; set; } @@ -188,12 +192,18 @@ public MissingAggregationDescriptor Aggregations(Action + /// The name of the field. + /// public MissingAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The name of the field. + /// public MissingAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -295,18 +305,27 @@ public MissingAggregationDescriptor Aggregations(Action + /// The name of the field. + /// public MissingAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The name of the field. + /// public MissingAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The name of the field. + /// public MissingAggregationDescriptor Field(Expression> field) { FieldValue = field; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermLookup.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermLookup.g.cs index 9c115bf219e..21a10e563aa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermLookup.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermLookup.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MultiTermLookup { + /// + /// A fields from which to retrieve terms. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } + + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// [JsonInclude, JsonPropertyName("missing")] public FieldValue? Missing { get; set; } } @@ -46,18 +53,27 @@ public MultiTermLookupDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } private FieldValue? MissingValue { get; set; } + /// + /// A fields from which to retrieve terms. + /// public MultiTermLookupDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// A fields from which to retrieve terms. + /// public MultiTermLookupDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public MultiTermLookupDescriptor Missing(FieldValue? missing) { MissingValue = missing; @@ -90,24 +106,36 @@ public MultiTermLookupDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } private FieldValue? MissingValue { get; set; } + /// + /// A fields from which to retrieve terms. + /// public MultiTermLookupDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// A fields from which to retrieve terms. + /// public MultiTermLookupDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// A fields from which to retrieve terms. + /// public MultiTermLookupDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public MultiTermLookupDescriptor Missing(FieldValue? missing) { MissingValue = missing; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermsAggregation.g.cs index ce2493fea4b..35e287acf98 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MultiTermsAggregation.g.cs @@ -243,16 +243,47 @@ internal MultiTermsAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// Specifies the strategy for data collection. + /// public Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationCollectMode? CollectMode { get; set; } public IDictionary? Meta { get; set; } + + /// + /// The minimum number of documents in a bucket for it to be returned. + /// public long? MinDocCount { get; set; } override public string? Name { get; internal set; } [JsonConverter(typeof(AggregateOrderConverter))] + /// + /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// public ICollection>? Order { get; set; } + + /// + /// The minimum number of documents in a bucket on each shard for it to be returned. + /// public long? ShardMinDocCount { get; set; } + + /// + /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// public int? ShardSize { get; set; } + + /// + /// Calculates the doc count error on per term basis. + /// public bool? ShowTermDocCountError { get; set; } + + /// + /// The number of term buckets should be returned out of the overall terms list. + /// public int? Size { get; set; } + + /// + /// The field from which to generate sets of terms. + /// public ICollection Terms { get; set; } } @@ -304,6 +335,9 @@ public MultiTermsAggregationDescriptor Aggregations(Action + /// The field from which to generate sets of terms. + /// public MultiTermsAggregationDescriptor Terms(ICollection terms) { TermsDescriptor = null; @@ -340,6 +374,9 @@ public MultiTermsAggregationDescriptor Terms(params Action + /// Specifies the strategy for data collection. + /// public MultiTermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationCollectMode? collectMode) { CollectModeValue = collectMode; @@ -352,36 +389,54 @@ public MultiTermsAggregationDescriptor Meta(Func + /// The minimum number of documents in a bucket for it to be returned. + /// public MultiTermsAggregationDescriptor MinDocCount(long? minDocCount) { MinDocCountValue = minDocCount; return Self; } + /// + /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// public MultiTermsAggregationDescriptor Order(ICollection>? order) { OrderValue = order; return Self; } + /// + /// The minimum number of documents in a bucket on each shard for it to be returned. + /// public MultiTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { ShardMinDocCountValue = shardMinDocCount; return Self; } + /// + /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// public MultiTermsAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; return Self; } + /// + /// Calculates the doc count error on per term basis. + /// public MultiTermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountError = true) { ShowTermDocCountErrorValue = showTermDocCountError; return Self; } + /// + /// The number of term buckets should be returned out of the overall terms list. + /// public MultiTermsAggregationDescriptor Size(int? size) { SizeValue = size; @@ -541,6 +596,9 @@ public MultiTermsAggregationDescriptor Aggregations(Action + /// The field from which to generate sets of terms. + /// public MultiTermsAggregationDescriptor Terms(ICollection terms) { TermsDescriptor = null; @@ -577,6 +635,9 @@ public MultiTermsAggregationDescriptor Terms(params Action + /// Specifies the strategy for data collection. + /// public MultiTermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationCollectMode? collectMode) { CollectModeValue = collectMode; @@ -589,36 +650,54 @@ public MultiTermsAggregationDescriptor Meta(Func + /// The minimum number of documents in a bucket for it to be returned. + /// public MultiTermsAggregationDescriptor MinDocCount(long? minDocCount) { MinDocCountValue = minDocCount; return Self; } + /// + /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// public MultiTermsAggregationDescriptor Order(ICollection>? order) { OrderValue = order; return Self; } + /// + /// The minimum number of documents in a bucket on each shard for it to be returned. + /// public MultiTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { ShardMinDocCountValue = shardMinDocCount; return Self; } + /// + /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// public MultiTermsAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; return Self; } + /// + /// Calculates the doc count error on per term basis. + /// public MultiTermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountError = true) { ShowTermDocCountErrorValue = showTermDocCountError; return Self; } + /// + /// The number of term buckets should be returned out of the overall terms list. + /// public MultiTermsAggregationDescriptor Size(int? size) { SizeValue = size; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MutualInformationHeuristic.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MutualInformationHeuristic.g.cs index b22372039b5..5ad6254071b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MutualInformationHeuristic.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/MutualInformationHeuristic.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class MutualInformationHeuristic { + /// + /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// [JsonInclude, JsonPropertyName("background_is_superset")] public bool? BackgroundIsSuperset { get; set; } + + /// + /// Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + /// [JsonInclude, JsonPropertyName("include_negatives")] public bool? IncludeNegatives { get; set; } } @@ -46,12 +53,18 @@ public MutualInformationHeuristicDescriptor() : base() private bool? BackgroundIsSupersetValue { get; set; } private bool? IncludeNegativesValue { get; set; } + /// + /// Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + /// public MutualInformationHeuristicDescriptor BackgroundIsSuperset(bool? backgroundIsSuperset = true) { BackgroundIsSupersetValue = backgroundIsSuperset; return Self; } + /// + /// Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + /// public MutualInformationHeuristicDescriptor IncludeNegatives(bool? includeNegatives = true) { IncludeNegativesValue = includeNegatives; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NestedAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NestedAggregation.g.cs index 4240230b794..5198966b63c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NestedAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/NestedAggregation.g.cs @@ -127,6 +127,10 @@ internal NestedAggregation() public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// The path to the field of type `nested`. + /// public Elastic.Clients.Elasticsearch.Field? Path { get; set; } } @@ -174,12 +178,18 @@ public NestedAggregationDescriptor Meta(Func + /// The path to the field of type `nested`. + /// public NestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Field? path) { PathValue = path; return Self; } + /// + /// The path to the field of type `nested`. + /// public NestedAggregationDescriptor Path(Expression> path) { PathValue = path; @@ -268,18 +278,27 @@ public NestedAggregationDescriptor Meta(Func, F return Self; } + /// + /// The path to the field of type `nested`. + /// public NestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Field? path) { PathValue = path; return Self; } + /// + /// The path to the field of type `nested`. + /// public NestedAggregationDescriptor Path(Expression> path) { PathValue = path; return Self; } + /// + /// The path to the field of type `nested`. + /// public NestedAggregationDescriptor Path(Expression> path) { PathValue = path; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ParentAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ParentAggregation.g.cs index 2eebaf5ead5..956e5ce01e1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ParentAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ParentAggregation.g.cs @@ -127,6 +127,10 @@ internal ParentAggregation() public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// The child type that should be selected. + /// public string? Type { get; set; } } @@ -174,6 +178,9 @@ public ParentAggregationDescriptor Meta(Func + /// The child type that should be selected. + /// public ParentAggregationDescriptor Type(string? type) { TypeValue = type; @@ -262,6 +269,9 @@ public ParentAggregationDescriptor Meta(Func, F return Self; } + /// + /// The child type that should be selected. + /// public ParentAggregationDescriptor Type(string? type) { TypeValue = type; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentileRanksAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentileRanksAggregation.g.cs new file mode 100644 index 00000000000..f533836144c --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentileRanksAggregation.g.cs @@ -0,0 +1,642 @@ +// Licensed to Elasticsearch B.V under one or more agreements. +// Elasticsearch B.V licenses this file to you under the Apache 2.0 License. +// See the LICENSE file in the project root for more information. +// +// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗ +// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝ +// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗ +// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝ +// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗ +// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝ +// ------------------------------------------------ +// +// This file is automatically generated. +// Please do not edit these files manually. +// +// ------------------------------------------------ + +#nullable restore + +using Elastic.Clients.Elasticsearch.Fluent; +using Elastic.Clients.Elasticsearch.Serialization; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Aggregations; + +internal sealed class PercentileRanksAggregationConverter : JsonConverter +{ + public override PercentileRanksAggregation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType != JsonTokenType.StartObject) + throw new JsonException("Unexpected JSON detected."); + reader.Read(); + var aggName = reader.GetString(); + if (aggName != "percentile_ranks") + throw new JsonException("Unexpected JSON detected."); + var agg = new PercentileRanksAggregation(aggName); + while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) + { + if (reader.TokenType == JsonTokenType.PropertyName) + { + if (reader.ValueTextEquals("field")) + { + reader.Read(); + var value = JsonSerializer.Deserialize(ref reader, options); + if (value is not null) + { + agg.Field = value; + } + + continue; + } + + if (reader.ValueTextEquals("format")) + { + reader.Read(); + var value = JsonSerializer.Deserialize(ref reader, options); + if (value is not null) + { + agg.Format = value; + } + + continue; + } + + if (reader.ValueTextEquals("hdr")) + { + reader.Read(); + var value = JsonSerializer.Deserialize(ref reader, options); + if (value is not null) + { + agg.Hdr = value; + } + + continue; + } + + if (reader.ValueTextEquals("missing")) + { + reader.Read(); + var value = JsonSerializer.Deserialize(ref reader, options); + if (value is not null) + { + agg.Missing = value; + } + + continue; + } + + if (reader.ValueTextEquals("script")) + { + reader.Read(); + var value = JsonSerializer.Deserialize(ref reader, options); + if (value is not null) + { + agg.Script = value; + } + + continue; + } + + if (reader.ValueTextEquals("tdigest")) + { + reader.Read(); + var value = JsonSerializer.Deserialize(ref reader, options); + if (value is not null) + { + agg.TDigest = value; + } + + continue; + } + + if (reader.ValueTextEquals("values")) + { + reader.Read(); + var value = JsonSerializer.Deserialize?>(ref reader, options); + if (value is not null) + { + agg.Values = value; + } + + continue; + } + } + } + + while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) + { + if (reader.TokenType == JsonTokenType.PropertyName) + { + if (reader.ValueTextEquals("meta")) + { + var value = JsonSerializer.Deserialize>(ref reader, options); + if (value is not null) + { + agg.Meta = value; + } + + continue; + } + } + } + + return agg; + } + + public override void Write(Utf8JsonWriter writer, PercentileRanksAggregation value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + writer.WritePropertyName("percentile_ranks"); + writer.WriteStartObject(); + if (value.Field is not null) + { + writer.WritePropertyName("field"); + JsonSerializer.Serialize(writer, value.Field, options); + } + + if (!string.IsNullOrEmpty(value.Format)) + { + writer.WritePropertyName("format"); + writer.WriteStringValue(value.Format); + } + + if (value.Hdr is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, value.Hdr, options); + } + + if (value.Missing is not null) + { + writer.WritePropertyName("missing"); + JsonSerializer.Serialize(writer, value.Missing, options); + } + + if (value.Script is not null) + { + writer.WritePropertyName("script"); + JsonSerializer.Serialize(writer, value.Script, options); + } + + if (value.TDigest is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, value.TDigest, options); + } + + if (value.Values is not null) + { + writer.WritePropertyName("values"); + JsonSerializer.Serialize(writer, value.Values, options); + } + + writer.WriteEndObject(); + if (value.Meta is not null) + { + writer.WritePropertyName("meta"); + JsonSerializer.Serialize(writer, value.Meta, options); + } + + writer.WriteEndObject(); + } +} + +[JsonConverter(typeof(PercentileRanksAggregationConverter))] +public sealed partial class PercentileRanksAggregation : SearchAggregation +{ + public PercentileRanksAggregation(string name, Field field) : this(name) => Field = field; + public PercentileRanksAggregation(string name) => Name = name; + + internal PercentileRanksAggregation() + { + } + + public Elastic.Clients.Elasticsearch.Field? Field { get; set; } + public string? Format { get; set; } + + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// + public Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? Hdr { get; set; } + public IDictionary? Meta { get; set; } + public FieldValue? Missing { get; set; } + override public string? Name { get; internal set; } + public Elastic.Clients.Elasticsearch.Script? Script { get; set; } + + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// + public Elastic.Clients.Elasticsearch.Aggregations.TDigest? TDigest { get; set; } + + /// + /// An array of values for which to calculate the percentile ranks. + /// + public ICollection? Values { get; set; } +} + +public sealed partial class PercentileRanksAggregationDescriptor : SerializableDescriptor> +{ + internal PercentileRanksAggregationDescriptor(Action> configure) => configure.Invoke(this); + + public PercentileRanksAggregationDescriptor() : base() + { + } + + private Elastic.Clients.Elasticsearch.Field? FieldValue { get; set; } + private string? FormatValue { get; set; } + private Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? HdrValue { get; set; } + private HdrMethodDescriptor HdrDescriptor { get; set; } + private Action HdrDescriptorAction { get; set; } + private IDictionary? MetaValue { get; set; } + private FieldValue? MissingValue { get; set; } + private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + private Elastic.Clients.Elasticsearch.Aggregations.TDigest? TDigestValue { get; set; } + private TDigestDescriptor TDigestDescriptor { get; set; } + private Action TDigestDescriptorAction { get; set; } + private ICollection? ValuesValue { get; set; } + + public PercentileRanksAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) + { + FieldValue = field; + return Self; + } + + public PercentileRanksAggregationDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + public PercentileRanksAggregationDescriptor Format(string? format) + { + FormatValue = format; + return Self; + } + + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// + public PercentileRanksAggregationDescriptor Hdr(Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? hdr) + { + HdrDescriptor = null; + HdrDescriptorAction = null; + HdrValue = hdr; + return Self; + } + + public PercentileRanksAggregationDescriptor Hdr(HdrMethodDescriptor descriptor) + { + HdrValue = null; + HdrDescriptorAction = null; + HdrDescriptor = descriptor; + return Self; + } + + public PercentileRanksAggregationDescriptor Hdr(Action configure) + { + HdrValue = null; + HdrDescriptor = null; + HdrDescriptorAction = configure; + return Self; + } + + public PercentileRanksAggregationDescriptor Meta(Func, FluentDictionary> selector) + { + MetaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + public PercentileRanksAggregationDescriptor Missing(FieldValue? missing) + { + MissingValue = missing; + return Self; + } + + public PercentileRanksAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) + { + ScriptValue = script; + return Self; + } + + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// + public PercentileRanksAggregationDescriptor TDigest(Elastic.Clients.Elasticsearch.Aggregations.TDigest? tDigest) + { + TDigestDescriptor = null; + TDigestDescriptorAction = null; + TDigestValue = tDigest; + return Self; + } + + public PercentileRanksAggregationDescriptor TDigest(TDigestDescriptor descriptor) + { + TDigestValue = null; + TDigestDescriptorAction = null; + TDigestDescriptor = descriptor; + return Self; + } + + public PercentileRanksAggregationDescriptor TDigest(Action configure) + { + TDigestValue = null; + TDigestDescriptor = null; + TDigestDescriptorAction = configure; + return Self; + } + + /// + /// An array of values for which to calculate the percentile ranks. + /// + public PercentileRanksAggregationDescriptor Values(ICollection? values) + { + ValuesValue = values; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("percentile_ranks"); + writer.WriteStartObject(); + if (FieldValue is not null) + { + writer.WritePropertyName("field"); + JsonSerializer.Serialize(writer, FieldValue, options); + } + + if (!string.IsNullOrEmpty(FormatValue)) + { + writer.WritePropertyName("format"); + writer.WriteStringValue(FormatValue); + } + + if (HdrDescriptor is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, HdrDescriptor, options); + } + else if (HdrDescriptorAction is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, new HdrMethodDescriptor(HdrDescriptorAction), options); + } + else if (HdrValue is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, HdrValue, options); + } + + if (MissingValue is not null) + { + writer.WritePropertyName("missing"); + JsonSerializer.Serialize(writer, MissingValue, options); + } + + if (ScriptValue is not null) + { + writer.WritePropertyName("script"); + JsonSerializer.Serialize(writer, ScriptValue, options); + } + + if (TDigestDescriptor is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, TDigestDescriptor, options); + } + else if (TDigestDescriptorAction is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, new TDigestDescriptor(TDigestDescriptorAction), options); + } + else if (TDigestValue is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, TDigestValue, options); + } + + if (ValuesValue is not null) + { + writer.WritePropertyName("values"); + JsonSerializer.Serialize(writer, ValuesValue, options); + } + + writer.WriteEndObject(); + if (MetaValue is not null) + { + writer.WritePropertyName("meta"); + JsonSerializer.Serialize(writer, MetaValue, options); + } + + writer.WriteEndObject(); + } +} + +public sealed partial class PercentileRanksAggregationDescriptor : SerializableDescriptor +{ + internal PercentileRanksAggregationDescriptor(Action configure) => configure.Invoke(this); + + public PercentileRanksAggregationDescriptor() : base() + { + } + + private Elastic.Clients.Elasticsearch.Field? FieldValue { get; set; } + private string? FormatValue { get; set; } + private Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? HdrValue { get; set; } + private HdrMethodDescriptor HdrDescriptor { get; set; } + private Action HdrDescriptorAction { get; set; } + private IDictionary? MetaValue { get; set; } + private FieldValue? MissingValue { get; set; } + private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + private Elastic.Clients.Elasticsearch.Aggregations.TDigest? TDigestValue { get; set; } + private TDigestDescriptor TDigestDescriptor { get; set; } + private Action TDigestDescriptorAction { get; set; } + private ICollection? ValuesValue { get; set; } + + public PercentileRanksAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) + { + FieldValue = field; + return Self; + } + + public PercentileRanksAggregationDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + public PercentileRanksAggregationDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + public PercentileRanksAggregationDescriptor Format(string? format) + { + FormatValue = format; + return Self; + } + + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. + /// + public PercentileRanksAggregationDescriptor Hdr(Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? hdr) + { + HdrDescriptor = null; + HdrDescriptorAction = null; + HdrValue = hdr; + return Self; + } + + public PercentileRanksAggregationDescriptor Hdr(HdrMethodDescriptor descriptor) + { + HdrValue = null; + HdrDescriptorAction = null; + HdrDescriptor = descriptor; + return Self; + } + + public PercentileRanksAggregationDescriptor Hdr(Action configure) + { + HdrValue = null; + HdrDescriptor = null; + HdrDescriptorAction = configure; + return Self; + } + + public PercentileRanksAggregationDescriptor Meta(Func, FluentDictionary> selector) + { + MetaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + public PercentileRanksAggregationDescriptor Missing(FieldValue? missing) + { + MissingValue = missing; + return Self; + } + + public PercentileRanksAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) + { + ScriptValue = script; + return Self; + } + + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentile ranks. + /// + public PercentileRanksAggregationDescriptor TDigest(Elastic.Clients.Elasticsearch.Aggregations.TDigest? tDigest) + { + TDigestDescriptor = null; + TDigestDescriptorAction = null; + TDigestValue = tDigest; + return Self; + } + + public PercentileRanksAggregationDescriptor TDigest(TDigestDescriptor descriptor) + { + TDigestValue = null; + TDigestDescriptorAction = null; + TDigestDescriptor = descriptor; + return Self; + } + + public PercentileRanksAggregationDescriptor TDigest(Action configure) + { + TDigestValue = null; + TDigestDescriptor = null; + TDigestDescriptorAction = configure; + return Self; + } + + /// + /// An array of values for which to calculate the percentile ranks. + /// + public PercentileRanksAggregationDescriptor Values(ICollection? values) + { + ValuesValue = values; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("percentile_ranks"); + writer.WriteStartObject(); + if (FieldValue is not null) + { + writer.WritePropertyName("field"); + JsonSerializer.Serialize(writer, FieldValue, options); + } + + if (!string.IsNullOrEmpty(FormatValue)) + { + writer.WritePropertyName("format"); + writer.WriteStringValue(FormatValue); + } + + if (HdrDescriptor is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, HdrDescriptor, options); + } + else if (HdrDescriptorAction is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, new HdrMethodDescriptor(HdrDescriptorAction), options); + } + else if (HdrValue is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, HdrValue, options); + } + + if (MissingValue is not null) + { + writer.WritePropertyName("missing"); + JsonSerializer.Serialize(writer, MissingValue, options); + } + + if (ScriptValue is not null) + { + writer.WritePropertyName("script"); + JsonSerializer.Serialize(writer, ScriptValue, options); + } + + if (TDigestDescriptor is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, TDigestDescriptor, options); + } + else if (TDigestDescriptorAction is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, new TDigestDescriptor(TDigestDescriptorAction), options); + } + else if (TDigestValue is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, TDigestValue, options); + } + + if (ValuesValue is not null) + { + writer.WritePropertyName("values"); + JsonSerializer.Serialize(writer, ValuesValue, options); + } + + writer.WriteEndObject(); + if (MetaValue is not null) + { + writer.WritePropertyName("meta"); + JsonSerializer.Serialize(writer, MetaValue, options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesAggregation.g.cs new file mode 100644 index 00000000000..2263f4ee994 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesAggregation.g.cs @@ -0,0 +1,642 @@ +// Licensed to Elasticsearch B.V under one or more agreements. +// Elasticsearch B.V licenses this file to you under the Apache 2.0 License. +// See the LICENSE file in the project root for more information. +// +// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗ +// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝ +// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗ +// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝ +// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗ +// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝ +// ------------------------------------------------ +// +// This file is automatically generated. +// Please do not edit these files manually. +// +// ------------------------------------------------ + +#nullable restore + +using Elastic.Clients.Elasticsearch.Fluent; +using Elastic.Clients.Elasticsearch.Serialization; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Aggregations; + +internal sealed class PercentilesAggregationConverter : JsonConverter +{ + public override PercentilesAggregation Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType != JsonTokenType.StartObject) + throw new JsonException("Unexpected JSON detected."); + reader.Read(); + var aggName = reader.GetString(); + if (aggName != "percentiles") + throw new JsonException("Unexpected JSON detected."); + var agg = new PercentilesAggregation(aggName); + while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) + { + if (reader.TokenType == JsonTokenType.PropertyName) + { + if (reader.ValueTextEquals("field")) + { + reader.Read(); + var value = JsonSerializer.Deserialize(ref reader, options); + if (value is not null) + { + agg.Field = value; + } + + continue; + } + + if (reader.ValueTextEquals("format")) + { + reader.Read(); + var value = JsonSerializer.Deserialize(ref reader, options); + if (value is not null) + { + agg.Format = value; + } + + continue; + } + + if (reader.ValueTextEquals("hdr")) + { + reader.Read(); + var value = JsonSerializer.Deserialize(ref reader, options); + if (value is not null) + { + agg.Hdr = value; + } + + continue; + } + + if (reader.ValueTextEquals("missing")) + { + reader.Read(); + var value = JsonSerializer.Deserialize(ref reader, options); + if (value is not null) + { + agg.Missing = value; + } + + continue; + } + + if (reader.ValueTextEquals("percents")) + { + reader.Read(); + var value = JsonSerializer.Deserialize?>(ref reader, options); + if (value is not null) + { + agg.Percents = value; + } + + continue; + } + + if (reader.ValueTextEquals("script")) + { + reader.Read(); + var value = JsonSerializer.Deserialize(ref reader, options); + if (value is not null) + { + agg.Script = value; + } + + continue; + } + + if (reader.ValueTextEquals("tdigest")) + { + reader.Read(); + var value = JsonSerializer.Deserialize(ref reader, options); + if (value is not null) + { + agg.TDigest = value; + } + + continue; + } + } + } + + while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) + { + if (reader.TokenType == JsonTokenType.PropertyName) + { + if (reader.ValueTextEquals("meta")) + { + var value = JsonSerializer.Deserialize>(ref reader, options); + if (value is not null) + { + agg.Meta = value; + } + + continue; + } + } + } + + return agg; + } + + public override void Write(Utf8JsonWriter writer, PercentilesAggregation value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + writer.WritePropertyName("percentiles"); + writer.WriteStartObject(); + if (value.Field is not null) + { + writer.WritePropertyName("field"); + JsonSerializer.Serialize(writer, value.Field, options); + } + + if (!string.IsNullOrEmpty(value.Format)) + { + writer.WritePropertyName("format"); + writer.WriteStringValue(value.Format); + } + + if (value.Hdr is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, value.Hdr, options); + } + + if (value.Missing is not null) + { + writer.WritePropertyName("missing"); + JsonSerializer.Serialize(writer, value.Missing, options); + } + + if (value.Percents is not null) + { + writer.WritePropertyName("percents"); + JsonSerializer.Serialize(writer, value.Percents, options); + } + + if (value.Script is not null) + { + writer.WritePropertyName("script"); + JsonSerializer.Serialize(writer, value.Script, options); + } + + if (value.TDigest is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, value.TDigest, options); + } + + writer.WriteEndObject(); + if (value.Meta is not null) + { + writer.WritePropertyName("meta"); + JsonSerializer.Serialize(writer, value.Meta, options); + } + + writer.WriteEndObject(); + } +} + +[JsonConverter(typeof(PercentilesAggregationConverter))] +public sealed partial class PercentilesAggregation : SearchAggregation +{ + public PercentilesAggregation(string name, Field field) : this(name) => Field = field; + public PercentilesAggregation(string name) => Name = name; + + internal PercentilesAggregation() + { + } + + public Elastic.Clients.Elasticsearch.Field? Field { get; set; } + public string? Format { get; set; } + + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// + public Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? Hdr { get; set; } + public IDictionary? Meta { get; set; } + public FieldValue? Missing { get; set; } + override public string? Name { get; internal set; } + + /// + /// The percentiles to calculate. + /// + public ICollection? Percents { get; set; } + public Elastic.Clients.Elasticsearch.Script? Script { get; set; } + + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// + public Elastic.Clients.Elasticsearch.Aggregations.TDigest? TDigest { get; set; } +} + +public sealed partial class PercentilesAggregationDescriptor : SerializableDescriptor> +{ + internal PercentilesAggregationDescriptor(Action> configure) => configure.Invoke(this); + + public PercentilesAggregationDescriptor() : base() + { + } + + private Elastic.Clients.Elasticsearch.Field? FieldValue { get; set; } + private string? FormatValue { get; set; } + private Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? HdrValue { get; set; } + private HdrMethodDescriptor HdrDescriptor { get; set; } + private Action HdrDescriptorAction { get; set; } + private IDictionary? MetaValue { get; set; } + private FieldValue? MissingValue { get; set; } + private ICollection? PercentsValue { get; set; } + private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + private Elastic.Clients.Elasticsearch.Aggregations.TDigest? TDigestValue { get; set; } + private TDigestDescriptor TDigestDescriptor { get; set; } + private Action TDigestDescriptorAction { get; set; } + + public PercentilesAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) + { + FieldValue = field; + return Self; + } + + public PercentilesAggregationDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + public PercentilesAggregationDescriptor Format(string? format) + { + FormatValue = format; + return Self; + } + + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// + public PercentilesAggregationDescriptor Hdr(Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? hdr) + { + HdrDescriptor = null; + HdrDescriptorAction = null; + HdrValue = hdr; + return Self; + } + + public PercentilesAggregationDescriptor Hdr(HdrMethodDescriptor descriptor) + { + HdrValue = null; + HdrDescriptorAction = null; + HdrDescriptor = descriptor; + return Self; + } + + public PercentilesAggregationDescriptor Hdr(Action configure) + { + HdrValue = null; + HdrDescriptor = null; + HdrDescriptorAction = configure; + return Self; + } + + public PercentilesAggregationDescriptor Meta(Func, FluentDictionary> selector) + { + MetaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + public PercentilesAggregationDescriptor Missing(FieldValue? missing) + { + MissingValue = missing; + return Self; + } + + /// + /// The percentiles to calculate. + /// + public PercentilesAggregationDescriptor Percents(ICollection? percents) + { + PercentsValue = percents; + return Self; + } + + public PercentilesAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) + { + ScriptValue = script; + return Self; + } + + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// + public PercentilesAggregationDescriptor TDigest(Elastic.Clients.Elasticsearch.Aggregations.TDigest? tDigest) + { + TDigestDescriptor = null; + TDigestDescriptorAction = null; + TDigestValue = tDigest; + return Self; + } + + public PercentilesAggregationDescriptor TDigest(TDigestDescriptor descriptor) + { + TDigestValue = null; + TDigestDescriptorAction = null; + TDigestDescriptor = descriptor; + return Self; + } + + public PercentilesAggregationDescriptor TDigest(Action configure) + { + TDigestValue = null; + TDigestDescriptor = null; + TDigestDescriptorAction = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("percentiles"); + writer.WriteStartObject(); + if (FieldValue is not null) + { + writer.WritePropertyName("field"); + JsonSerializer.Serialize(writer, FieldValue, options); + } + + if (!string.IsNullOrEmpty(FormatValue)) + { + writer.WritePropertyName("format"); + writer.WriteStringValue(FormatValue); + } + + if (HdrDescriptor is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, HdrDescriptor, options); + } + else if (HdrDescriptorAction is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, new HdrMethodDescriptor(HdrDescriptorAction), options); + } + else if (HdrValue is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, HdrValue, options); + } + + if (MissingValue is not null) + { + writer.WritePropertyName("missing"); + JsonSerializer.Serialize(writer, MissingValue, options); + } + + if (PercentsValue is not null) + { + writer.WritePropertyName("percents"); + JsonSerializer.Serialize(writer, PercentsValue, options); + } + + if (ScriptValue is not null) + { + writer.WritePropertyName("script"); + JsonSerializer.Serialize(writer, ScriptValue, options); + } + + if (TDigestDescriptor is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, TDigestDescriptor, options); + } + else if (TDigestDescriptorAction is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, new TDigestDescriptor(TDigestDescriptorAction), options); + } + else if (TDigestValue is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, TDigestValue, options); + } + + writer.WriteEndObject(); + if (MetaValue is not null) + { + writer.WritePropertyName("meta"); + JsonSerializer.Serialize(writer, MetaValue, options); + } + + writer.WriteEndObject(); + } +} + +public sealed partial class PercentilesAggregationDescriptor : SerializableDescriptor +{ + internal PercentilesAggregationDescriptor(Action configure) => configure.Invoke(this); + + public PercentilesAggregationDescriptor() : base() + { + } + + private Elastic.Clients.Elasticsearch.Field? FieldValue { get; set; } + private string? FormatValue { get; set; } + private Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? HdrValue { get; set; } + private HdrMethodDescriptor HdrDescriptor { get; set; } + private Action HdrDescriptorAction { get; set; } + private IDictionary? MetaValue { get; set; } + private FieldValue? MissingValue { get; set; } + private ICollection? PercentsValue { get; set; } + private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + private Elastic.Clients.Elasticsearch.Aggregations.TDigest? TDigestValue { get; set; } + private TDigestDescriptor TDigestDescriptor { get; set; } + private Action TDigestDescriptorAction { get; set; } + + public PercentilesAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) + { + FieldValue = field; + return Self; + } + + public PercentilesAggregationDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + public PercentilesAggregationDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + public PercentilesAggregationDescriptor Format(string? format) + { + FormatValue = format; + return Self; + } + + /// + /// Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. + /// + public PercentilesAggregationDescriptor Hdr(Elastic.Clients.Elasticsearch.Aggregations.HdrMethod? hdr) + { + HdrDescriptor = null; + HdrDescriptorAction = null; + HdrValue = hdr; + return Self; + } + + public PercentilesAggregationDescriptor Hdr(HdrMethodDescriptor descriptor) + { + HdrValue = null; + HdrDescriptorAction = null; + HdrDescriptor = descriptor; + return Self; + } + + public PercentilesAggregationDescriptor Hdr(Action configure) + { + HdrValue = null; + HdrDescriptor = null; + HdrDescriptorAction = configure; + return Self; + } + + public PercentilesAggregationDescriptor Meta(Func, FluentDictionary> selector) + { + MetaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + public PercentilesAggregationDescriptor Missing(FieldValue? missing) + { + MissingValue = missing; + return Self; + } + + /// + /// The percentiles to calculate. + /// + public PercentilesAggregationDescriptor Percents(ICollection? percents) + { + PercentsValue = percents; + return Self; + } + + public PercentilesAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) + { + ScriptValue = script; + return Self; + } + + /// + /// Sets parameters for the default TDigest algorithm used to calculate percentiles. + /// + public PercentilesAggregationDescriptor TDigest(Elastic.Clients.Elasticsearch.Aggregations.TDigest? tDigest) + { + TDigestDescriptor = null; + TDigestDescriptorAction = null; + TDigestValue = tDigest; + return Self; + } + + public PercentilesAggregationDescriptor TDigest(TDigestDescriptor descriptor) + { + TDigestValue = null; + TDigestDescriptorAction = null; + TDigestDescriptor = descriptor; + return Self; + } + + public PercentilesAggregationDescriptor TDigest(Action configure) + { + TDigestValue = null; + TDigestDescriptor = null; + TDigestDescriptorAction = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("percentiles"); + writer.WriteStartObject(); + if (FieldValue is not null) + { + writer.WritePropertyName("field"); + JsonSerializer.Serialize(writer, FieldValue, options); + } + + if (!string.IsNullOrEmpty(FormatValue)) + { + writer.WritePropertyName("format"); + writer.WriteStringValue(FormatValue); + } + + if (HdrDescriptor is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, HdrDescriptor, options); + } + else if (HdrDescriptorAction is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, new HdrMethodDescriptor(HdrDescriptorAction), options); + } + else if (HdrValue is not null) + { + writer.WritePropertyName("hdr"); + JsonSerializer.Serialize(writer, HdrValue, options); + } + + if (MissingValue is not null) + { + writer.WritePropertyName("missing"); + JsonSerializer.Serialize(writer, MissingValue, options); + } + + if (PercentsValue is not null) + { + writer.WritePropertyName("percents"); + JsonSerializer.Serialize(writer, PercentsValue, options); + } + + if (ScriptValue is not null) + { + writer.WritePropertyName("script"); + JsonSerializer.Serialize(writer, ScriptValue, options); + } + + if (TDigestDescriptor is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, TDigestDescriptor, options); + } + else if (TDigestDescriptorAction is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, new TDigestDescriptor(TDigestDescriptorAction), options); + } + else if (TDigestValue is not null) + { + writer.WritePropertyName("tdigest"); + JsonSerializer.Serialize(writer, TDigestValue, options); + } + + writer.WriteEndObject(); + if (MetaValue is not null) + { + writer.WritePropertyName("meta"); + JsonSerializer.Serialize(writer, MetaValue, options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesBucketAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesBucketAggregation.g.cs index 59e5ea9444d..bba3fb59809 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesBucketAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/PercentilesBucketAggregation.g.cs @@ -166,6 +166,10 @@ internal PercentilesBucketAggregation() public Elastic.Clients.Elasticsearch.Aggregations.GapPolicy? GapPolicy { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// The list of percentiles to calculate. + /// public ICollection? Percents { get; set; } } @@ -207,6 +211,9 @@ public PercentilesBucketAggregationDescriptor Meta(Func + /// The list of percentiles to calculate. + /// public PercentilesBucketAggregationDescriptor Percents(ICollection? percents) { PercentsValue = percents; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RangeAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RangeAggregation.g.cs index 42baa9bcd22..e34f3fc5bc4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RangeAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RangeAggregation.g.cs @@ -197,11 +197,23 @@ internal RangeAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// The date field whose values are use to build ranges. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } public string? Format { get; set; } public IDictionary? Meta { get; set; } + + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public int? Missing { get; set; } override public string? Name { get; internal set; } + + /// + /// An array of ranges used to bucket documents. + /// public ICollection? Ranges { get; set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } } @@ -251,12 +263,18 @@ public RangeAggregationDescriptor Aggregations(Action + /// The date field whose values are use to build ranges. + /// public RangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The date field whose values are use to build ranges. + /// public RangeAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -275,12 +293,18 @@ public RangeAggregationDescriptor Meta(Func + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public RangeAggregationDescriptor Missing(int? missing) { MissingValue = missing; return Self; } + /// + /// An array of ranges used to bucket documents. + /// public RangeAggregationDescriptor Ranges(ICollection? ranges) { RangesDescriptor = null; @@ -455,18 +479,27 @@ public RangeAggregationDescriptor Aggregations(Action + /// The date field whose values are use to build ranges. + /// public RangeAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The date field whose values are use to build ranges. + /// public RangeAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The date field whose values are use to build ranges. + /// public RangeAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -485,12 +518,18 @@ public RangeAggregationDescriptor Meta(Func, Fl return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public RangeAggregationDescriptor Missing(int? missing) { MissingValue = missing; return Self; } + /// + /// An array of ranges used to bucket documents. + /// public RangeAggregationDescriptor Ranges(ICollection? ranges) { RangesDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RareTermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RareTermsAggregation.g.cs index 0c500a914bb..6272fa83a4d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RareTermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RareTermsAggregation.g.cs @@ -233,13 +233,37 @@ internal RareTermsAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// Terms that should be excluded from the aggregation. + /// public Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? Exclude { get; set; } + + /// + /// The field from which to return rare terms. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } + + /// + /// Terms that should be included in the aggregation. + /// public Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? Include { get; set; } + + /// + /// The maximum number of documents a term should appear in. + /// public long? MaxDocCount { get; set; } public IDictionary? Meta { get; set; } + + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public FieldValue? Missing { get; set; } override public string? Name { get; internal set; } + + /// + /// The precision of the internal CuckooFilters.
Smaller precision leads to better approximation, but higher memory usage. + /// public double? Precision { get; set; } public string? ValueType { get; set; } } @@ -288,30 +312,45 @@ public RareTermsAggregationDescriptor Aggregations(Action + /// Terms that should be excluded from the aggregation. + /// public RareTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { ExcludeValue = exclude; return Self; } + /// + /// The field from which to return rare terms. + /// public RareTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The field from which to return rare terms. + /// public RareTermsAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Terms that should be included in the aggregation. + /// public RareTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { IncludeValue = include; return Self; } + /// + /// The maximum number of documents a term should appear in. + /// public RareTermsAggregationDescriptor MaxDocCount(long? maxDocCount) { MaxDocCountValue = maxDocCount; @@ -324,12 +363,18 @@ public RareTermsAggregationDescriptor Meta(Func + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public RareTermsAggregationDescriptor Missing(FieldValue? missing) { MissingValue = missing; return Self; } + /// + /// The precision of the internal CuckooFilters.
Smaller precision leads to better approximation, but higher memory usage. + /// public RareTermsAggregationDescriptor Precision(double? precision) { PrecisionValue = precision; @@ -460,36 +505,54 @@ public RareTermsAggregationDescriptor Aggregations(Action + /// Terms that should be excluded from the aggregation. + /// public RareTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { ExcludeValue = exclude; return Self; } + /// + /// The field from which to return rare terms. + /// public RareTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The field from which to return rare terms. + /// public RareTermsAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field from which to return rare terms. + /// public RareTermsAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Terms that should be included in the aggregation. + /// public RareTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { IncludeValue = include; return Self; } + /// + /// The maximum number of documents a term should appear in. + /// public RareTermsAggregationDescriptor MaxDocCount(long? maxDocCount) { MaxDocCountValue = maxDocCount; @@ -502,12 +565,18 @@ public RareTermsAggregationDescriptor Meta(Func return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public RareTermsAggregationDescriptor Missing(FieldValue? missing) { MissingValue = missing; return Self; } + /// + /// The precision of the internal CuckooFilters.
Smaller precision leads to better approximation, but higher memory usage. + /// public RareTermsAggregationDescriptor Precision(double? precision) { PrecisionValue = precision; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RateAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RateAggregation.g.cs index 3f9ccbc6966..c3cc6615fae 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RateAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/RateAggregation.g.cs @@ -202,9 +202,17 @@ internal RateAggregation() public string? Format { get; set; } public IDictionary? Meta { get; set; } public FieldValue? Missing { get; set; } + + /// + /// How the rate is calculated. + /// public Elastic.Clients.Elasticsearch.Aggregations.RateMode? Mode { get; set; } override public string? Name { get; internal set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } + + /// + /// The interval used to calculate the rate.
By default, the interval of the `date_histogram` is used. + /// public Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? Unit { get; set; } } @@ -254,6 +262,9 @@ public RateAggregationDescriptor Missing(FieldValue? missing) return Self; } + /// + /// How the rate is calculated. + /// public RateAggregationDescriptor Mode(Elastic.Clients.Elasticsearch.Aggregations.RateMode? mode) { ModeValue = mode; @@ -266,6 +277,9 @@ public RateAggregationDescriptor Script(Elastic.Clients.Elasticsearch return Self; } + /// + /// The interval used to calculate the rate.
By default, the interval of the `date_histogram` is used. + /// public RateAggregationDescriptor Unit(Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? unit) { UnitValue = unit; @@ -376,6 +390,9 @@ public RateAggregationDescriptor Missing(FieldValue? missing) return Self; } + /// + /// How the rate is calculated. + /// public RateAggregationDescriptor Mode(Elastic.Clients.Elasticsearch.Aggregations.RateMode? mode) { ModeValue = mode; @@ -388,6 +405,9 @@ public RateAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? sc return Self; } + /// + /// The interval used to calculate the rate.
By default, the interval of the `date_histogram` is used. + /// public RateAggregationDescriptor Unit(Elastic.Clients.Elasticsearch.Aggregations.CalendarInterval? unit) { UnitValue = unit; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ReverseNestedAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ReverseNestedAggregation.g.cs index 8e6658281b7..54798e98042 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ReverseNestedAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ReverseNestedAggregation.g.cs @@ -127,6 +127,10 @@ internal ReverseNestedAggregation() public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// public Elastic.Clients.Elasticsearch.Field? Path { get; set; } } @@ -174,12 +178,18 @@ public ReverseNestedAggregationDescriptor Meta(Func + /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// public ReverseNestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Field? path) { PathValue = path; return Self; } + /// + /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// public ReverseNestedAggregationDescriptor Path(Expression> path) { PathValue = path; @@ -268,18 +278,27 @@ public ReverseNestedAggregationDescriptor Meta(Func + /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// public ReverseNestedAggregationDescriptor Path(Elastic.Clients.Elasticsearch.Field? path) { PathValue = path; return Self; } + /// + /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// public ReverseNestedAggregationDescriptor Path(Expression> path) { PathValue = path; return Self; } + /// + /// Defines the nested object field that should be joined back to.
The default is empty, which means that it joins back to the root/main document level. + /// public ReverseNestedAggregationDescriptor Path(Expression> path) { PathValue = path; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SamplerAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SamplerAggregation.g.cs index 3cec867365a..6499106c8b9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SamplerAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SamplerAggregation.g.cs @@ -127,6 +127,10 @@ internal SamplerAggregation() public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// public int? ShardSize { get; set; } } @@ -174,6 +178,9 @@ public SamplerAggregationDescriptor Meta(Func + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// public SamplerAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; @@ -262,6 +269,9 @@ public SamplerAggregationDescriptor Meta(Func, return Self; } + /// + /// Limits how many top-scoring documents are collected in the sample processed on each shard. + /// public SamplerAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ScriptedMetricAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ScriptedMetricAggregation.g.cs index e1159504a0d..ce7fb5b0c3d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ScriptedMetricAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/ScriptedMetricAggregation.g.cs @@ -234,14 +234,33 @@ internal ScriptedMetricAggregation() { } + /// + /// Runs once on each shard after document collection is complete.
Allows the aggregation to consolidate the state returned from each shard. + /// public Elastic.Clients.Elasticsearch.Script? CombineScript { get; set; } public Elastic.Clients.Elasticsearch.Field? Field { get; set; } + + /// + /// Runs prior to any collection of documents.
Allows the aggregation to set up any initial state. + /// public Elastic.Clients.Elasticsearch.Script? InitScript { get; set; } + + /// + /// Run once per document collected.
If no `combine_script` is specified, the resulting state needs to be stored in the `state` object. + /// public Elastic.Clients.Elasticsearch.Script? MapScript { get; set; } public IDictionary? Meta { get; set; } public FieldValue? Missing { get; set; } override public string? Name { get; internal set; } + + /// + /// A global object with script parameters for `init`, `map` and `combine` scripts.
It is shared between the scripts. + /// public IDictionary? Params { get; set; } + + /// + /// Runs once on the coordinating node after all shards have returned their results.
The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard. + /// public Elastic.Clients.Elasticsearch.Script? ReduceScript { get; set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } } @@ -264,6 +283,9 @@ public ScriptedMetricAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Script? ReduceScriptValue { get; set; } private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + /// + /// Runs once on each shard after document collection is complete.
Allows the aggregation to consolidate the state returned from each shard. + /// public ScriptedMetricAggregationDescriptor CombineScript(Elastic.Clients.Elasticsearch.Script? combineScript) { CombineScriptValue = combineScript; @@ -282,12 +304,18 @@ public ScriptedMetricAggregationDescriptor Field(Expression + /// Runs prior to any collection of documents.
Allows the aggregation to set up any initial state. + /// public ScriptedMetricAggregationDescriptor InitScript(Elastic.Clients.Elasticsearch.Script? initScript) { InitScriptValue = initScript; return Self; } + /// + /// Run once per document collected.
If no `combine_script` is specified, the resulting state needs to be stored in the `state` object. + /// public ScriptedMetricAggregationDescriptor MapScript(Elastic.Clients.Elasticsearch.Script? mapScript) { MapScriptValue = mapScript; @@ -306,12 +334,18 @@ public ScriptedMetricAggregationDescriptor Missing(FieldValue? missin return Self; } + /// + /// A global object with script parameters for `init`, `map` and `combine` scripts.
It is shared between the scripts. + /// public ScriptedMetricAggregationDescriptor Params(Func, FluentDictionary> selector) { ParamsValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// Runs once on the coordinating node after all shards have returned their results.
The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard. + /// public ScriptedMetricAggregationDescriptor ReduceScript(Elastic.Clients.Elasticsearch.Script? reduceScript) { ReduceScriptValue = reduceScript; @@ -406,6 +440,9 @@ public ScriptedMetricAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Script? ReduceScriptValue { get; set; } private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + /// + /// Runs once on each shard after document collection is complete.
Allows the aggregation to consolidate the state returned from each shard. + /// public ScriptedMetricAggregationDescriptor CombineScript(Elastic.Clients.Elasticsearch.Script? combineScript) { CombineScriptValue = combineScript; @@ -430,12 +467,18 @@ public ScriptedMetricAggregationDescriptor Field(Expression + /// Runs prior to any collection of documents.
Allows the aggregation to set up any initial state. + /// public ScriptedMetricAggregationDescriptor InitScript(Elastic.Clients.Elasticsearch.Script? initScript) { InitScriptValue = initScript; return Self; } + /// + /// Run once per document collected.
If no `combine_script` is specified, the resulting state needs to be stored in the `state` object. + /// public ScriptedMetricAggregationDescriptor MapScript(Elastic.Clients.Elasticsearch.Script? mapScript) { MapScriptValue = mapScript; @@ -454,12 +497,18 @@ public ScriptedMetricAggregationDescriptor Missing(FieldValue? missing) return Self; } + /// + /// A global object with script parameters for `init`, `map` and `combine` scripts.
It is shared between the scripts. + /// public ScriptedMetricAggregationDescriptor Params(Func, FluentDictionary> selector) { ParamsValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// Runs once on the coordinating node after all shards have returned their results.
The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard. + /// public ScriptedMetricAggregationDescriptor ReduceScript(Elastic.Clients.Elasticsearch.Script? reduceScript) { ReduceScriptValue = reduceScript; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantTermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantTermsAggregation.g.cs index 7542c60db67..78ad90def2b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantTermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/SignificantTermsAggregation.g.cs @@ -377,22 +377,82 @@ internal SignificantTermsAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// public Elastic.Clients.Elasticsearch.QueryDsl.Query? BackgroundFilter { get; set; } + + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// public Elastic.Clients.Elasticsearch.Aggregations.ChiSquareHeuristic? ChiSquare { get; set; } + + /// + /// Terms to exclude. + /// public Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? Exclude { get; set; } + + /// + /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// public Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? ExecutionHint { get; set; } + + /// + /// The field from which to return significant terms. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } + + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// public Elastic.Clients.Elasticsearch.Aggregations.GoogleNormalizedDistanceHeuristic? Gnd { get; set; } + + /// + /// Terms to include. + /// public Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? Include { get; set; } + + /// + /// Use JLH score as the significance score. + /// public Elastic.Clients.Elasticsearch.EmptyObject? Jlh { get; set; } public IDictionary? Meta { get; set; } + + /// + /// Only return terms that are found in more than `min_doc_count` hits. + /// public long? MinDocCount { get; set; } + + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// public Elastic.Clients.Elasticsearch.Aggregations.MutualInformationHeuristic? MutualInformation { get; set; } override public string? Name { get; internal set; } + + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// public Elastic.Clients.Elasticsearch.Aggregations.PercentageScoreHeuristic? Percentage { get; set; } + + /// + /// Customized score, implemented via a script. + /// public Elastic.Clients.Elasticsearch.Aggregations.ScriptedHeuristic? ScriptHeuristic { get; set; } + + /// + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// public long? ShardMinDocCount { get; set; } + + /// + /// Can be used to control the volumes of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// public int? ShardSize { get; set; } + + /// + /// The number of buckets returned out of the overall terms list. + /// public int? Size { get; set; } } @@ -462,6 +522,9 @@ public SignificantTermsAggregationDescriptor Aggregations(Action + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// public SignificantTermsAggregationDescriptor BackgroundFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? backgroundFilter) { BackgroundFilterDescriptor = null; @@ -486,6 +549,9 @@ public SignificantTermsAggregationDescriptor BackgroundFilter(Action< return Self; } + /// + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// public SignificantTermsAggregationDescriptor ChiSquare(Elastic.Clients.Elasticsearch.Aggregations.ChiSquareHeuristic? chiSquare) { ChiSquareDescriptor = null; @@ -510,30 +576,45 @@ public SignificantTermsAggregationDescriptor ChiSquare(Action + /// Terms to exclude. + /// public SignificantTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { ExcludeValue = exclude; return Self; } + /// + /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// public SignificantTermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? executionHint) { ExecutionHintValue = executionHint; return Self; } + /// + /// The field from which to return significant terms. + /// public SignificantTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The field from which to return significant terms. + /// public SignificantTermsAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// public SignificantTermsAggregationDescriptor Gnd(Elastic.Clients.Elasticsearch.Aggregations.GoogleNormalizedDistanceHeuristic? gnd) { GndDescriptor = null; @@ -558,12 +639,18 @@ public SignificantTermsAggregationDescriptor Gnd(Action + /// Terms to include. + /// public SignificantTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { IncludeValue = include; return Self; } + /// + /// Use JLH score as the significance score. + /// public SignificantTermsAggregationDescriptor Jlh(Elastic.Clients.Elasticsearch.EmptyObject? jlh) { JlhDescriptor = null; @@ -594,12 +681,18 @@ public SignificantTermsAggregationDescriptor Meta(Func + /// Only return terms that are found in more than `min_doc_count` hits. + /// public SignificantTermsAggregationDescriptor MinDocCount(long? minDocCount) { MinDocCountValue = minDocCount; return Self; } + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// public SignificantTermsAggregationDescriptor MutualInformation(Elastic.Clients.Elasticsearch.Aggregations.MutualInformationHeuristic? mutualInformation) { MutualInformationDescriptor = null; @@ -624,6 +717,9 @@ public SignificantTermsAggregationDescriptor MutualInformation(Action return Self; } + /// + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// public SignificantTermsAggregationDescriptor Percentage(Elastic.Clients.Elasticsearch.Aggregations.PercentageScoreHeuristic? percentage) { PercentageDescriptor = null; @@ -648,6 +744,9 @@ public SignificantTermsAggregationDescriptor Percentage(Action + /// Customized score, implemented via a script. + /// public SignificantTermsAggregationDescriptor ScriptHeuristic(Elastic.Clients.Elasticsearch.Aggregations.ScriptedHeuristic? scriptHeuristic) { ScriptHeuristicDescriptor = null; @@ -672,18 +771,27 @@ public SignificantTermsAggregationDescriptor ScriptHeuristic(Action + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// public SignificantTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { ShardMinDocCountValue = shardMinDocCount; return Self; } + /// + /// Can be used to control the volumes of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// public SignificantTermsAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; return Self; } + /// + /// The number of buckets returned out of the overall terms list. + /// public SignificantTermsAggregationDescriptor Size(int? size) { SizeValue = size; @@ -948,6 +1056,9 @@ public SignificantTermsAggregationDescriptor Aggregations(Action + /// A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. + /// public SignificantTermsAggregationDescriptor BackgroundFilter(Elastic.Clients.Elasticsearch.QueryDsl.Query? backgroundFilter) { BackgroundFilterDescriptor = null; @@ -972,6 +1083,9 @@ public SignificantTermsAggregationDescriptor BackgroundFilter(Action + /// Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. + /// public SignificantTermsAggregationDescriptor ChiSquare(Elastic.Clients.Elasticsearch.Aggregations.ChiSquareHeuristic? chiSquare) { ChiSquareDescriptor = null; @@ -996,36 +1110,54 @@ public SignificantTermsAggregationDescriptor ChiSquare(Action + /// Terms to exclude. + /// public SignificantTermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { ExcludeValue = exclude; return Self; } + /// + /// Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. + /// public SignificantTermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? executionHint) { ExecutionHintValue = executionHint; return Self; } + /// + /// The field from which to return significant terms. + /// public SignificantTermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The field from which to return significant terms. + /// public SignificantTermsAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field from which to return significant terms. + /// public SignificantTermsAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + /// public SignificantTermsAggregationDescriptor Gnd(Elastic.Clients.Elasticsearch.Aggregations.GoogleNormalizedDistanceHeuristic? gnd) { GndDescriptor = null; @@ -1050,12 +1182,18 @@ public SignificantTermsAggregationDescriptor Gnd(Action + /// Terms to include. + /// public SignificantTermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { IncludeValue = include; return Self; } + /// + /// Use JLH score as the significance score. + /// public SignificantTermsAggregationDescriptor Jlh(Elastic.Clients.Elasticsearch.EmptyObject? jlh) { JlhDescriptor = null; @@ -1086,12 +1224,18 @@ public SignificantTermsAggregationDescriptor Meta(Func + /// Only return terms that are found in more than `min_doc_count` hits. + /// public SignificantTermsAggregationDescriptor MinDocCount(long? minDocCount) { MinDocCountValue = minDocCount; return Self; } + /// + /// Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. + /// public SignificantTermsAggregationDescriptor MutualInformation(Elastic.Clients.Elasticsearch.Aggregations.MutualInformationHeuristic? mutualInformation) { MutualInformationDescriptor = null; @@ -1116,6 +1260,9 @@ public SignificantTermsAggregationDescriptor MutualInformation(Action + /// A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. + /// public SignificantTermsAggregationDescriptor Percentage(Elastic.Clients.Elasticsearch.Aggregations.PercentageScoreHeuristic? percentage) { PercentageDescriptor = null; @@ -1140,6 +1287,9 @@ public SignificantTermsAggregationDescriptor Percentage(Action + /// Customized score, implemented via a script. + /// public SignificantTermsAggregationDescriptor ScriptHeuristic(Elastic.Clients.Elasticsearch.Aggregations.ScriptedHeuristic? scriptHeuristic) { ScriptHeuristicDescriptor = null; @@ -1164,18 +1314,27 @@ public SignificantTermsAggregationDescriptor ScriptHeuristic(Action + /// Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`.
Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + /// public SignificantTermsAggregationDescriptor ShardMinDocCount(long? shardMinDocCount) { ShardMinDocCountValue = shardMinDocCount; return Self; } + /// + /// Can be used to control the volumes of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// public SignificantTermsAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; return Self; } + /// + /// The number of buckets returned out of the overall terms list. + /// public SignificantTermsAggregationDescriptor Size(int? size) { SizeValue = size; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringStatsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringStatsAggregation.g.cs index 70bb44b747b..0f153058861 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringStatsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/StringStatsAggregation.g.cs @@ -167,6 +167,10 @@ internal StringStatsAggregation() public FieldValue? Missing { get; set; } override public string? Name { get; internal set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } + + /// + /// Shows the probability distribution for all characters. + /// public bool? ShowDistribution { get; set; } } @@ -214,6 +218,9 @@ public StringStatsAggregationDescriptor Script(Elastic.Clients.Elasti return Self; } + /// + /// Shows the probability distribution for all characters. + /// public StringStatsAggregationDescriptor ShowDistribution(bool? showDistribution = true) { ShowDistributionValue = showDistribution; @@ -310,6 +317,9 @@ public StringStatsAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Scr return Self; } + /// + /// Shows the probability distribution for all characters. + /// public StringStatsAggregationDescriptor ShowDistribution(bool? showDistribution = true) { ShowDistributionValue = showDistribution; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TDigest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TDigest.g.cs new file mode 100644 index 00000000000..5ac8d211326 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TDigest.g.cs @@ -0,0 +1,69 @@ +// Licensed to Elasticsearch B.V under one or more agreements. +// Elasticsearch B.V licenses this file to you under the Apache 2.0 License. +// See the LICENSE file in the project root for more information. +// +// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗ +// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝ +// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗ +// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝ +// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗ +// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝ +// ------------------------------------------------ +// +// This file is automatically generated. +// Please do not edit these files manually. +// +// ------------------------------------------------ + +#nullable restore + +using Elastic.Clients.Elasticsearch.Fluent; +using Elastic.Clients.Elasticsearch.Serialization; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Aggregations; + +public sealed partial class TDigest +{ + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + [JsonInclude, JsonPropertyName("compression")] + public int? Compression { get; set; } +} + +public sealed partial class TDigestDescriptor : SerializableDescriptor +{ + internal TDigestDescriptor(Action configure) => configure.Invoke(this); + + public TDigestDescriptor() : base() + { + } + + private int? CompressionValue { get; set; } + + /// + /// Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + /// + public TDigestDescriptor Compression(int? compression) + { + CompressionValue = compression; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (CompressionValue.HasValue) + { + writer.WritePropertyName("compression"); + writer.WriteNumberValue(CompressionValue.Value); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TTestAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TTestAggregation.g.cs index 92d25160178..dfa9cddc86b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TTestAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TTestAggregation.g.cs @@ -143,10 +143,21 @@ internal TTestAggregation() { } + /// + /// Test population A. + /// public Elastic.Clients.Elasticsearch.Aggregations.TestPopulation? a { get; set; } + + /// + /// Test population B. + /// public Elastic.Clients.Elasticsearch.Aggregations.TestPopulation? b { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// The type of test. + /// public Elastic.Clients.Elasticsearch.Aggregations.TTestType? Type { get; set; } } @@ -167,6 +178,9 @@ public TTestAggregationDescriptor() : base() private IDictionary? MetaValue { get; set; } private Elastic.Clients.Elasticsearch.Aggregations.TTestType? TypeValue { get; set; } + /// + /// Test population A. + /// public TTestAggregationDescriptor a(Elastic.Clients.Elasticsearch.Aggregations.TestPopulation? a) { aDescriptor = null; @@ -191,6 +205,9 @@ public TTestAggregationDescriptor a(Action + /// Test population B. + /// public TTestAggregationDescriptor b(Elastic.Clients.Elasticsearch.Aggregations.TestPopulation? b) { bDescriptor = null; @@ -221,6 +238,9 @@ public TTestAggregationDescriptor Meta(Func + /// The type of test. + /// public TTestAggregationDescriptor Type(Elastic.Clients.Elasticsearch.Aggregations.TTestType? type) { TypeValue = type; @@ -298,6 +318,9 @@ public TTestAggregationDescriptor() : base() private IDictionary? MetaValue { get; set; } private Elastic.Clients.Elasticsearch.Aggregations.TTestType? TypeValue { get; set; } + /// + /// Test population A. + /// public TTestAggregationDescriptor a(Elastic.Clients.Elasticsearch.Aggregations.TestPopulation? a) { aDescriptor = null; @@ -322,6 +345,9 @@ public TTestAggregationDescriptor a(Action configure) return Self; } + /// + /// Test population B. + /// public TTestAggregationDescriptor b(Elastic.Clients.Elasticsearch.Aggregations.TestPopulation? b) { bDescriptor = null; @@ -352,6 +378,9 @@ public TTestAggregationDescriptor Meta(Func, Fl return Self; } + /// + /// The type of test. + /// public TTestAggregationDescriptor Type(Elastic.Clients.Elasticsearch.Aggregations.TTestType? type) { TypeValue = type; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TermsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TermsAggregation.g.cs index c043db1927e..bf25fbe8a2a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TermsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TermsAggregation.g.cs @@ -395,24 +395,71 @@ internal TermsAggregation() } public Elastic.Clients.Elasticsearch.Aggregations.AggregationDictionary? Aggregations { get; set; } + + /// + /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// public Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationCollectMode? CollectMode { get; set; } + + /// + /// Values to exclude.
Accepts regular expressions and partitions. + /// public Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? Exclude { get; set; } + + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// public Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? ExecutionHint { get; set; } + + /// + /// The field from which to return terms. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } public string? Format { get; set; } + + /// + /// Values to include.
Accepts regular expressions and partitions. + /// public Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? Include { get; set; } public IDictionary? Meta { get; set; } + + /// + /// Only return values that are found in more than `min_doc_count` hits. + /// public int? MinDocCount { get; set; } + + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public FieldValue? Missing { get; set; } public bool? MissingBucket { get; set; } public Elastic.Clients.Elasticsearch.Aggregations.MissingOrder? MissingOrder { get; set; } override public string? Name { get; internal set; } [JsonConverter(typeof(AggregateOrderConverter))] + /// + /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// public ICollection>? Order { get; set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } + + /// + /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// public int? ShardSize { get; set; } + + /// + /// Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. + /// public bool? ShowTermDocCountError { get; set; } + + /// + /// The number of buckets returned out of the overall terms list. + /// public int? Size { get; set; } + + /// + /// Coerced unmapped fields into the specified type. + /// public string? ValueType { get; set; } } @@ -469,30 +516,45 @@ public TermsAggregationDescriptor Aggregations(Action + /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// public TermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationCollectMode? collectMode) { CollectModeValue = collectMode; return Self; } + /// + /// Values to exclude.
Accepts regular expressions and partitions. + /// public TermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { ExcludeValue = exclude; return Self; } + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// public TermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? executionHint) { ExecutionHintValue = executionHint; return Self; } + /// + /// The field from which to return terms. + /// public TermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The field from which to return terms. + /// public TermsAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -505,6 +567,9 @@ public TermsAggregationDescriptor Format(string? format) return Self; } + /// + /// Values to include.
Accepts regular expressions and partitions. + /// public TermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { IncludeValue = include; @@ -517,12 +582,18 @@ public TermsAggregationDescriptor Meta(Func + /// Only return values that are found in more than `min_doc_count` hits. + /// public TermsAggregationDescriptor MinDocCount(int? minDocCount) { MinDocCountValue = minDocCount; return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public TermsAggregationDescriptor Missing(FieldValue? missing) { MissingValue = missing; @@ -541,6 +612,9 @@ public TermsAggregationDescriptor MissingOrder(Elastic.Clients.Elasti return Self; } + /// + /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// public TermsAggregationDescriptor Order(ICollection>? order) { OrderValue = order; @@ -553,24 +627,36 @@ public TermsAggregationDescriptor Script(Elastic.Clients.Elasticsearc return Self; } + /// + /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// public TermsAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; return Self; } + /// + /// Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. + /// public TermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountError = true) { ShowTermDocCountErrorValue = showTermDocCountError; return Self; } + /// + /// The number of buckets returned out of the overall terms list. + /// public TermsAggregationDescriptor Size(int? size) { SizeValue = size; return Self; } + /// + /// Coerced unmapped fields into the specified type. + /// public TermsAggregationDescriptor ValueType(string? valueType) { ValueTypeValue = valueType; @@ -758,36 +844,54 @@ public TermsAggregationDescriptor Aggregations(Action + /// Determines how child aggregations should be calculated: breadth-first or depth-first. + /// public TermsAggregationDescriptor CollectMode(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationCollectMode? collectMode) { CollectModeValue = collectMode; return Self; } + /// + /// Values to exclude.
Accepts regular expressions and partitions. + /// public TermsAggregationDescriptor Exclude(Elastic.Clients.Elasticsearch.Aggregations.TermsExclude? exclude) { ExcludeValue = exclude; return Self; } + /// + /// Determines whether the aggregation will use field values directly or global ordinals. + /// public TermsAggregationDescriptor ExecutionHint(Elastic.Clients.Elasticsearch.Aggregations.TermsAggregationExecutionHint? executionHint) { ExecutionHintValue = executionHint; return Self; } + /// + /// The field from which to return terms. + /// public TermsAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The field from which to return terms. + /// public TermsAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field from which to return terms. + /// public TermsAggregationDescriptor Field(Expression> field) { FieldValue = field; @@ -800,6 +904,9 @@ public TermsAggregationDescriptor Format(string? format) return Self; } + /// + /// Values to include.
Accepts regular expressions and partitions. + /// public TermsAggregationDescriptor Include(Elastic.Clients.Elasticsearch.Aggregations.TermsInclude? include) { IncludeValue = include; @@ -812,12 +919,18 @@ public TermsAggregationDescriptor Meta(Func, Fl return Self; } + /// + /// Only return values that are found in more than `min_doc_count` hits. + /// public TermsAggregationDescriptor MinDocCount(int? minDocCount) { MinDocCountValue = minDocCount; return Self; } + /// + /// The value to apply to documents that do not have a value.
By default, documents without a value are ignored. + /// public TermsAggregationDescriptor Missing(FieldValue? missing) { MissingValue = missing; @@ -836,6 +949,9 @@ public TermsAggregationDescriptor MissingOrder(Elastic.Clients.Elasticsearch.Agg return Self; } + /// + /// Specifies the sort order of the buckets.
Defaults to sorting by descending document count. + /// public TermsAggregationDescriptor Order(ICollection>? order) { OrderValue = order; @@ -848,24 +964,36 @@ public TermsAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? s return Self; } + /// + /// The number of candidate terms produced by each shard.
By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + /// public TermsAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; return Self; } + /// + /// Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. + /// public TermsAggregationDescriptor ShowTermDocCountError(bool? showTermDocCountError = true) { ShowTermDocCountErrorValue = showTermDocCountError; return Self; } + /// + /// The number of buckets returned out of the overall terms list. + /// public TermsAggregationDescriptor Size(int? size) { SizeValue = size; return Self; } + /// + /// Coerced unmapped fields into the specified type. + /// public TermsAggregationDescriptor ValueType(string? valueType) { ValueTypeValue = valueType; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TermsPartition.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TermsPartition.g.cs index 67c351dab32..79aeeda6870 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TermsPartition.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TermsPartition.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class TermsPartition { + /// + /// The number of partitions. + /// [JsonInclude, JsonPropertyName("num_partitions")] public long NumPartitions { get; set; } + + /// + /// The partition number for this request. + /// [JsonInclude, JsonPropertyName("partition")] public long Partition { get; set; } } @@ -46,12 +53,18 @@ public TermsPartitionDescriptor() : base() private long NumPartitionsValue { get; set; } private long PartitionValue { get; set; } + /// + /// The number of partitions. + /// public TermsPartitionDescriptor NumPartitions(long numPartitions) { NumPartitionsValue = numPartitions; return Self; } + /// + /// The partition number for this request. + /// public TermsPartitionDescriptor Partition(long partition) { PartitionValue = partition; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TestPopulation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TestPopulation.g.cs index 4c7976e83c7..bb42b05d85a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TestPopulation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TestPopulation.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class TestPopulation { + /// + /// The field to aggregate. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } + + /// + /// A filter used to define a set of records to run unpaired t-test on. + /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; set; } [JsonInclude, JsonPropertyName("script")] @@ -51,6 +58,9 @@ public TestPopulationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + /// + /// A filter used to define a set of records to run unpaired t-test on. + /// public TestPopulationDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { FilterDescriptor = null; @@ -75,12 +85,18 @@ public TestPopulationDescriptor Filter(Action + /// The field to aggregate. + /// public TestPopulationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to aggregate. + /// public TestPopulationDescriptor Field(Expression> field) { FieldValue = field; @@ -138,6 +154,9 @@ public TestPopulationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + /// + /// A filter used to define a set of records to run unpaired t-test on. + /// public TestPopulationDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { FilterDescriptor = null; @@ -162,18 +181,27 @@ public TestPopulationDescriptor Filter(Action configur return Self; } + /// + /// The field to aggregate. + /// public TestPopulationDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to aggregate. + /// public TestPopulationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to aggregate. + /// public TestPopulationDescriptor Field(Expression> field) { FieldValue = field; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopHitsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopHitsAggregation.g.cs index 45c01e6d5e9..6dbb98110a6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopHitsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopHitsAggregation.g.cs @@ -360,22 +360,69 @@ internal TopHitsAggregation() { } + /// + /// Selects the fields of the source that are returned. + /// public Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? Source { get; set; } + + /// + /// Fields for which to return doc values. + /// public Elastic.Clients.Elasticsearch.Fields? DocvalueFields { get; set; } + + /// + /// If `true`, returns detailed information about score computation as part of a hit. + /// public bool? Explain { get; set; } public Elastic.Clients.Elasticsearch.Field? Field { get; set; } + + /// + /// Starting document offset. + /// public int? From { get; set; } + + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// public Elastic.Clients.Elasticsearch.Core.Search.Highlight? Highlight { get; set; } public IDictionary? Meta { get; set; } public FieldValue? Missing { get; set; } override public string? Name { get; internal set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } + + /// + /// Returns the result of one or more script evaluations for each hit. + /// public IDictionary? ScriptFields { get; set; } + + /// + /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// public bool? SeqNoPrimaryTerm { get; set; } + + /// + /// The maximum number of top matching hits to return per bucket. + /// public int? Size { get; set; } + + /// + /// Sort order of the top matching hits.
By default, the hits are sorted by the score of the main query. + /// public ICollection? Sort { get; set; } + + /// + /// Returns values for the specified stored fields (fields that use the `store` mapping option). + /// public Elastic.Clients.Elasticsearch.Fields? StoredFields { get; set; } + + /// + /// If `true`, calculates and returns document scores, even if the scores are not used for sorting. + /// public bool? TrackScores { get; set; } + + /// + /// If `true`, returns document version as part of a hit. + /// public bool? Version { get; set; } } @@ -409,6 +456,9 @@ public TopHitsAggregationDescriptor() : base() private bool? TrackScoresValue { get; set; } private bool? VersionValue { get; set; } + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// public TopHitsAggregationDescriptor Highlight(Elastic.Clients.Elasticsearch.Core.Search.Highlight? highlight) { HighlightDescriptor = null; @@ -433,6 +483,9 @@ public TopHitsAggregationDescriptor Highlight(Action + /// Sort order of the top matching hits.
By default, the hits are sorted by the score of the main query. + /// public TopHitsAggregationDescriptor Sort(ICollection? sort) { SortDescriptor = null; @@ -469,18 +522,27 @@ public TopHitsAggregationDescriptor Sort(params Action + /// Selects the fields of the source that are returned. + /// public TopHitsAggregationDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { SourceValue = source; return Self; } + /// + /// Fields for which to return doc values. + /// public TopHitsAggregationDescriptor DocvalueFields(Elastic.Clients.Elasticsearch.Fields? docvalueFields) { DocvalueFieldsValue = docvalueFields; return Self; } + /// + /// If `true`, returns detailed information about score computation as part of a hit. + /// public TopHitsAggregationDescriptor Explain(bool? explain = true) { ExplainValue = explain; @@ -499,6 +561,9 @@ public TopHitsAggregationDescriptor Field(Expression + /// Starting document offset. + /// public TopHitsAggregationDescriptor From(int? from) { FromValue = from; @@ -523,36 +588,54 @@ public TopHitsAggregationDescriptor Script(Elastic.Clients.Elasticsea return Self; } + /// + /// Returns the result of one or more script evaluations for each hit. + /// public TopHitsAggregationDescriptor ScriptFields(Func, FluentDictionary> selector) { ScriptFieldsValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// public TopHitsAggregationDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { SeqNoPrimaryTermValue = seqNoPrimaryTerm; return Self; } + /// + /// The maximum number of top matching hits to return per bucket. + /// public TopHitsAggregationDescriptor Size(int? size) { SizeValue = size; return Self; } + /// + /// Returns values for the specified stored fields (fields that use the `store` mapping option). + /// public TopHitsAggregationDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { StoredFieldsValue = storedFields; return Self; } + /// + /// If `true`, calculates and returns document scores, even if the scores are not used for sorting. + /// public TopHitsAggregationDescriptor TrackScores(bool? trackScores = true) { TrackScoresValue = trackScores; return Self; } + /// + /// If `true`, returns document version as part of a hit. + /// public TopHitsAggregationDescriptor Version(bool? version = true) { VersionValue = version; @@ -728,6 +811,9 @@ public TopHitsAggregationDescriptor() : base() private bool? TrackScoresValue { get; set; } private bool? VersionValue { get; set; } + /// + /// Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. + /// public TopHitsAggregationDescriptor Highlight(Elastic.Clients.Elasticsearch.Core.Search.Highlight? highlight) { HighlightDescriptor = null; @@ -752,6 +838,9 @@ public TopHitsAggregationDescriptor Highlight(Action + /// Sort order of the top matching hits.
By default, the hits are sorted by the score of the main query. + /// public TopHitsAggregationDescriptor Sort(ICollection? sort) { SortDescriptor = null; @@ -788,18 +877,27 @@ public TopHitsAggregationDescriptor Sort(params Action[] return Self; } + /// + /// Selects the fields of the source that are returned. + /// public TopHitsAggregationDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfig? source) { SourceValue = source; return Self; } + /// + /// Fields for which to return doc values. + /// public TopHitsAggregationDescriptor DocvalueFields(Elastic.Clients.Elasticsearch.Fields? docvalueFields) { DocvalueFieldsValue = docvalueFields; return Self; } + /// + /// If `true`, returns detailed information about score computation as part of a hit. + /// public TopHitsAggregationDescriptor Explain(bool? explain = true) { ExplainValue = explain; @@ -824,6 +922,9 @@ public TopHitsAggregationDescriptor Field(Expression + /// Starting document offset. + /// public TopHitsAggregationDescriptor From(int? from) { FromValue = from; @@ -848,36 +949,54 @@ public TopHitsAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Script? return Self; } + /// + /// Returns the result of one or more script evaluations for each hit. + /// public TopHitsAggregationDescriptor ScriptFields(Func, FluentDictionary> selector) { ScriptFieldsValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// If `true`, returns sequence number and primary term of the last modification of each hit. + /// public TopHitsAggregationDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) { SeqNoPrimaryTermValue = seqNoPrimaryTerm; return Self; } + /// + /// The maximum number of top matching hits to return per bucket. + /// public TopHitsAggregationDescriptor Size(int? size) { SizeValue = size; return Self; } + /// + /// Returns values for the specified stored fields (fields that use the `store` mapping option). + /// public TopHitsAggregationDescriptor StoredFields(Elastic.Clients.Elasticsearch.Fields? storedFields) { StoredFieldsValue = storedFields; return Self; } + /// + /// If `true`, calculates and returns document scores, even if the scores are not used for sorting. + /// public TopHitsAggregationDescriptor TrackScores(bool? trackScores = true) { TrackScoresValue = trackScores; return Self; } + /// + /// If `true`, returns document version as part of a hit. + /// public TopHitsAggregationDescriptor Version(bool? version = true) { VersionValue = version; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsAggregation.g.cs index 834d28f8c1b..ff4750f8aa1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsAggregation.g.cs @@ -200,11 +200,23 @@ internal TopMetricsAggregation() public Elastic.Clients.Elasticsearch.Field? Field { get; set; } public IDictionary? Meta { get; set; } + + /// + /// The fields of the top document to return. + /// public ICollection? Metrics { get; set; } public FieldValue? Missing { get; set; } override public string? Name { get; internal set; } public Elastic.Clients.Elasticsearch.Script? Script { get; set; } + + /// + /// The number of top documents from which to return metrics. + /// public int? Size { get; set; } + + /// + /// The sort order of the documents. + /// public ICollection? Sort { get; set; } } @@ -230,6 +242,9 @@ public TopMetricsAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } private int? SizeValue { get; set; } + /// + /// The fields of the top document to return. + /// public TopMetricsAggregationDescriptor Metrics(ICollection? metrics) { MetricsDescriptor = null; @@ -266,6 +281,9 @@ public TopMetricsAggregationDescriptor Metrics(params Action + /// The sort order of the documents. + /// public TopMetricsAggregationDescriptor Sort(ICollection? sort) { SortDescriptor = null; @@ -332,6 +350,9 @@ public TopMetricsAggregationDescriptor Script(Elastic.Clients.Elastic return Self; } + /// + /// The number of top documents from which to return metrics. + /// public TopMetricsAggregationDescriptor Size(int? size) { SizeValue = size; @@ -458,6 +479,9 @@ public TopMetricsAggregationDescriptor() : base() private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } private int? SizeValue { get; set; } + /// + /// The fields of the top document to return. + /// public TopMetricsAggregationDescriptor Metrics(ICollection? metrics) { MetricsDescriptor = null; @@ -494,6 +518,9 @@ public TopMetricsAggregationDescriptor Metrics(params Action + /// The sort order of the documents. + /// public TopMetricsAggregationDescriptor Sort(ICollection? sort) { SortDescriptor = null; @@ -566,6 +593,9 @@ public TopMetricsAggregationDescriptor Script(Elastic.Clients.Elasticsearch.Scri return Self; } + /// + /// The number of top documents from which to return metrics. + /// public TopMetricsAggregationDescriptor Size(int? size) { SizeValue = size; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsValue.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsValue.g.cs index 56f7ce58cca..d8b8a2d2ffa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsValue.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/TopMetricsValue.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class TopMetricsValue { + /// + /// A field to return as a metric. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } } @@ -43,12 +46,18 @@ public TopMetricsValueDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } + /// + /// A field to return as a metric. + /// public TopMetricsValueDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// A field to return as a metric. + /// public TopMetricsValueDescriptor Field(Expression> field) { FieldValue = field; @@ -74,18 +83,27 @@ public TopMetricsValueDescriptor() : base() private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } + /// + /// A field to return as a metric. + /// public TopMetricsValueDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// A field to return as a metric. + /// public TopMetricsValueDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// A field to return as a metric. + /// public TopMetricsValueDescriptor Field(Expression> field) { FieldValue = field; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/VariableWidthHistogramAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/VariableWidthHistogramAggregation.g.cs index c32e86f595e..38865f806f0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/VariableWidthHistogramAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/VariableWidthHistogramAggregation.g.cs @@ -161,11 +161,26 @@ internal VariableWidthHistogramAggregation() { } + /// + /// The target number of buckets. + /// public int? Buckets { get; set; } + + /// + /// The name of the field. + /// public Elastic.Clients.Elasticsearch.Field? Field { get; set; } + + /// + /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.
Defaults to `min(10 * shard_size, 50000)`. + /// public int? InitialBuffer { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// The number of buckets that the coordinating node will request from each shard.
Defaults to `buckets * 50`. + /// public int? ShardSize { get; set; } } @@ -183,24 +198,36 @@ public VariableWidthHistogramAggregationDescriptor() : base() private IDictionary? MetaValue { get; set; } private int? ShardSizeValue { get; set; } + /// + /// The target number of buckets. + /// public VariableWidthHistogramAggregationDescriptor Buckets(int? buckets) { BucketsValue = buckets; return Self; } + /// + /// The name of the field. + /// public VariableWidthHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The name of the field. + /// public VariableWidthHistogramAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.
Defaults to `min(10 * shard_size, 50000)`. + /// public VariableWidthHistogramAggregationDescriptor InitialBuffer(int? initialBuffer) { InitialBufferValue = initialBuffer; @@ -213,6 +240,9 @@ public VariableWidthHistogramAggregationDescriptor Meta(Func + /// The number of buckets that the coordinating node will request from each shard.
Defaults to `buckets * 50`. + /// public VariableWidthHistogramAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; @@ -273,30 +303,45 @@ public VariableWidthHistogramAggregationDescriptor() : base() private IDictionary? MetaValue { get; set; } private int? ShardSizeValue { get; set; } + /// + /// The target number of buckets. + /// public VariableWidthHistogramAggregationDescriptor Buckets(int? buckets) { BucketsValue = buckets; return Self; } + /// + /// The name of the field. + /// public VariableWidthHistogramAggregationDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The name of the field. + /// public VariableWidthHistogramAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The name of the field. + /// public VariableWidthHistogramAggregationDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.
Defaults to `min(10 * shard_size, 50000)`. + /// public VariableWidthHistogramAggregationDescriptor InitialBuffer(int? initialBuffer) { InitialBufferValue = initialBuffer; @@ -309,6 +354,9 @@ public VariableWidthHistogramAggregationDescriptor Meta(Func + /// The number of buckets that the coordinating node will request from each shard.
Defaults to `buckets * 50`. + /// public VariableWidthHistogramAggregationDescriptor ShardSize(int? shardSize) { ShardSizeValue = shardSize; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageAggregation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageAggregation.g.cs index 443c3225eb6..44613784066 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageAggregation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageAggregation.g.cs @@ -161,11 +161,22 @@ internal WeightedAverageAggregation() { } + /// + /// A numeric response formatter. + /// public string? Format { get; set; } public IDictionary? Meta { get; set; } override public string? Name { get; internal set; } + + /// + /// Configuration for the field that provides the values. + /// public Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageValue? Value { get; set; } public Elastic.Clients.Elasticsearch.Aggregations.ValueType? ValueType { get; set; } + + /// + /// Configuration for the field or script that provides the weights. + /// public Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageValue? Weight { get; set; } } @@ -187,6 +198,9 @@ public WeightedAverageAggregationDescriptor() : base() private IDictionary? MetaValue { get; set; } private Elastic.Clients.Elasticsearch.Aggregations.ValueType? ValueTypeValue { get; set; } + /// + /// Configuration for the field that provides the values. + /// public WeightedAverageAggregationDescriptor Value(Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageValue? value) { ValueDescriptor = null; @@ -211,6 +225,9 @@ public WeightedAverageAggregationDescriptor Value(Action + /// Configuration for the field or script that provides the weights. + /// public WeightedAverageAggregationDescriptor Weight(Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageValue? weight) { WeightDescriptor = null; @@ -235,6 +252,9 @@ public WeightedAverageAggregationDescriptor Weight(Action + /// A numeric response formatter. + /// public WeightedAverageAggregationDescriptor Format(string? format) { FormatValue = format; @@ -331,6 +351,9 @@ public WeightedAverageAggregationDescriptor() : base() private IDictionary? MetaValue { get; set; } private Elastic.Clients.Elasticsearch.Aggregations.ValueType? ValueTypeValue { get; set; } + /// + /// Configuration for the field that provides the values. + /// public WeightedAverageAggregationDescriptor Value(Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageValue? value) { ValueDescriptor = null; @@ -355,6 +378,9 @@ public WeightedAverageAggregationDescriptor Value(Action + /// Configuration for the field or script that provides the weights. + /// public WeightedAverageAggregationDescriptor Weight(Elastic.Clients.Elasticsearch.Aggregations.WeightedAverageValue? weight) { WeightDescriptor = null; @@ -379,6 +405,9 @@ public WeightedAverageAggregationDescriptor Weight(Action + /// A numeric response formatter. + /// public WeightedAverageAggregationDescriptor Format(string? format) { FormatValue = format; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageValue.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageValue.g.cs index c05bcc96c7e..cc58db541d1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageValue.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Aggregations/WeightedAverageValue.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Aggregations; public sealed partial class WeightedAverageValue { + /// + /// The field from which to extract the values or weights. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field? Field { get; set; } + + /// + /// A value or weight to use if the field is missing. + /// [JsonInclude, JsonPropertyName("missing")] public double? Missing { get; set; } [JsonInclude, JsonPropertyName("script")] @@ -49,18 +56,27 @@ public WeightedAverageValueDescriptor() : base() private double? MissingValue { get; set; } private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + /// + /// The field from which to extract the values or weights. + /// public WeightedAverageValueDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The field from which to extract the values or weights. + /// public WeightedAverageValueDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// A value or weight to use if the field is missing. + /// public WeightedAverageValueDescriptor Missing(double? missing) { MissingValue = missing; @@ -110,24 +126,36 @@ public WeightedAverageValueDescriptor() : base() private double? MissingValue { get; set; } private Elastic.Clients.Elasticsearch.Script? ScriptValue { get; set; } + /// + /// The field from which to extract the values or weights. + /// public WeightedAverageValueDescriptor Field(Elastic.Clients.Elasticsearch.Field? field) { FieldValue = field; return Self; } + /// + /// The field from which to extract the values or weights. + /// public WeightedAverageValueDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field from which to extract the values or weights. + /// public WeightedAverageValueDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// A value or weight to use if the field is missing. + /// public WeightedAverageValueDescriptor Missing(double? missing) { MissingValue = missing; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/ElisionTokenFilter.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/ElisionTokenFilter.g.cs index b88f128e4d1..103b0d8a7fe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/ElisionTokenFilter.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/ElisionTokenFilter.g.cs @@ -32,6 +32,7 @@ public sealed partial class ElisionTokenFilter : ITokenFilter [JsonInclude, JsonPropertyName("articles")] public ICollection? Articles { get; set; } [JsonInclude, JsonPropertyName("articles_case")] + [JsonConverter(typeof(StringifiedBoolConverter))] public bool? ArticlesCase { get; set; } [JsonInclude, JsonPropertyName("articles_path")] public string? ArticlesPath { get; set; } @@ -89,10 +90,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, ArticlesValue, options); } - if (ArticlesCaseValue.HasValue) + if (ArticlesCaseValue is not null) { writer.WritePropertyName("articles_case"); - writer.WriteBooleanValue(ArticlesCaseValue.Value); + JsonSerializer.Serialize(writer, ArticlesCaseValue, options); } if (!string.IsNullOrEmpty(ArticlesPathValue)) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/PathHierarchyTokenizer.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/PathHierarchyTokenizer.g.cs index 080b448a96b..ac523bcf1fa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/PathHierarchyTokenizer.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/PathHierarchyTokenizer.g.cs @@ -30,14 +30,17 @@ namespace Elastic.Clients.Elasticsearch.Analysis; public sealed partial class PathHierarchyTokenizer : ITokenizer { [JsonInclude, JsonPropertyName("buffer_size")] + [JsonConverter(typeof(StringifiedIntegerConverter))] public int BufferSize { get; set; } [JsonInclude, JsonPropertyName("delimiter")] public string Delimiter { get; set; } [JsonInclude, JsonPropertyName("replacement")] public string Replacement { get; set; } [JsonInclude, JsonPropertyName("reverse")] + [JsonConverter(typeof(StringifiedBoolConverter))] public bool Reverse { get; set; } [JsonInclude, JsonPropertyName("skip")] + [JsonConverter(typeof(StringifiedIntegerConverter))] public int Skip { get; set; } [JsonInclude, JsonPropertyName("type")] @@ -102,15 +105,15 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o { writer.WriteStartObject(); writer.WritePropertyName("buffer_size"); - writer.WriteNumberValue(BufferSizeValue); + JsonSerializer.Serialize(writer, BufferSizeValue, options); writer.WritePropertyName("delimiter"); writer.WriteStringValue(DelimiterValue); writer.WritePropertyName("replacement"); writer.WriteStringValue(ReplacementValue); writer.WritePropertyName("reverse"); - writer.WriteBooleanValue(ReverseValue); + JsonSerializer.Serialize(writer, ReverseValue, options); writer.WritePropertyName("skip"); - writer.WriteNumberValue(SkipValue); + JsonSerializer.Serialize(writer, SkipValue, options); writer.WritePropertyName("type"); writer.WriteStringValue("path_hierarchy"); if (VersionValue is not null) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/PatternTokenizer.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/PatternTokenizer.g.cs index 2a8355e304e..8f0e84db919 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/PatternTokenizer.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/PatternTokenizer.g.cs @@ -30,11 +30,11 @@ namespace Elastic.Clients.Elasticsearch.Analysis; public sealed partial class PatternTokenizer : ITokenizer { [JsonInclude, JsonPropertyName("flags")] - public string Flags { get; set; } + public string? Flags { get; set; } [JsonInclude, JsonPropertyName("group")] - public int Group { get; set; } + public int? Group { get; set; } [JsonInclude, JsonPropertyName("pattern")] - public string Pattern { get; set; } + public string? Pattern { get; set; } [JsonInclude, JsonPropertyName("type")] public string Type => "pattern"; @@ -51,24 +51,24 @@ public PatternTokenizerDescriptor() : base() { } - private string FlagsValue { get; set; } - private int GroupValue { get; set; } - private string PatternValue { get; set; } + private string? FlagsValue { get; set; } + private int? GroupValue { get; set; } + private string? PatternValue { get; set; } private string? VersionValue { get; set; } - public PatternTokenizerDescriptor Flags(string flags) + public PatternTokenizerDescriptor Flags(string? flags) { FlagsValue = flags; return Self; } - public PatternTokenizerDescriptor Group(int group) + public PatternTokenizerDescriptor Group(int? group) { GroupValue = group; return Self; } - public PatternTokenizerDescriptor Pattern(string pattern) + public PatternTokenizerDescriptor Pattern(string? pattern) { PatternValue = pattern; return Self; @@ -83,12 +83,24 @@ public PatternTokenizerDescriptor Version(string? version) protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); - writer.WritePropertyName("flags"); - writer.WriteStringValue(FlagsValue); - writer.WritePropertyName("group"); - writer.WriteNumberValue(GroupValue); - writer.WritePropertyName("pattern"); - writer.WriteStringValue(PatternValue); + if (!string.IsNullOrEmpty(FlagsValue)) + { + writer.WritePropertyName("flags"); + writer.WriteStringValue(FlagsValue); + } + + if (GroupValue.HasValue) + { + writer.WritePropertyName("group"); + writer.WriteNumberValue(GroupValue.Value); + } + + if (!string.IsNullOrEmpty(PatternValue)) + { + writer.WritePropertyName("pattern"); + writer.WriteStringValue(PatternValue); + } + writer.WritePropertyName("type"); writer.WriteStringValue("pattern"); if (VersionValue is not null) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/CharFilterTypes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/CharFilterTypes.g.cs index 5661a755fb3..e7a0fdc3f90 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/CharFilterTypes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/CharFilterTypes.g.cs @@ -29,18 +29,45 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class CharFilterTypes { + /// + /// Contains statistics about analyzer types used in selected nodes. + /// [JsonInclude, JsonPropertyName("analyzer_types")] public IReadOnlyCollection AnalyzerTypes { get; init; } + + /// + /// Contains statistics about built-in analyzers used in selected nodes. + /// [JsonInclude, JsonPropertyName("built_in_analyzers")] public IReadOnlyCollection BuiltInAnalyzers { get; init; } + + /// + /// Contains statistics about built-in character filters used in selected nodes. + /// [JsonInclude, JsonPropertyName("built_in_char_filters")] public IReadOnlyCollection BuiltInCharFilters { get; init; } + + /// + /// Contains statistics about built-in token filters used in selected nodes. + /// [JsonInclude, JsonPropertyName("built_in_filters")] public IReadOnlyCollection BuiltInFilters { get; init; } + + /// + /// Contains statistics about built-in tokenizers used in selected nodes. + /// [JsonInclude, JsonPropertyName("built_in_tokenizers")] public IReadOnlyCollection BuiltInTokenizers { get; init; } + + /// + /// Contains statistics about token filter types used in selected nodes. + /// [JsonInclude, JsonPropertyName("filter_types")] public IReadOnlyCollection FilterTypes { get; init; } + + /// + /// Contains statistics about tokenizer types used in selected nodes. + /// [JsonInclude, JsonPropertyName("tokenizer_types")] public IReadOnlyCollection TokenizerTypes { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterFileSystem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterFileSystem.g.cs index 57ac52a0707..1520f8c552a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterFileSystem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterFileSystem.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterFileSystem { + /// + /// Total number of bytes available to JVM in file stores across all selected nodes.
Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.
This is the actual amount of free disk space the selected Elasticsearch nodes can use. + /// [JsonInclude, JsonPropertyName("available_in_bytes")] public long AvailableInBytes { get; init; } + + /// + /// Total number of unallocated bytes in file stores across all selected nodes. + /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long FreeInBytes { get; init; } + + /// + /// Total size, in bytes, of all file stores across all selected nodes. + /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long TotalInBytes { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndices.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndices.g.cs index 7a84e35ae82..2698e53a175 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndices.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterIndices.g.cs @@ -88,6 +88,10 @@ public sealed partial class ClusterIndices /// [JsonInclude, JsonPropertyName("store")] public Elastic.Clients.Elasticsearch.StoreStats Store { get; init; } + + /// + /// Contains statistics about analyzers and analyzer components used in selected nodes. + /// [JsonInclude, JsonPropertyName("versions")] public IReadOnlyCollection? Versions { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvm.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvm.g.cs index 8178522ac4c..b9688f7a581 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvm.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvm.g.cs @@ -29,12 +29,27 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterJvm { + /// + /// Uptime duration, in milliseconds, since JVM last started. + /// [JsonInclude, JsonPropertyName("max_uptime_in_millis")] public long MaxUptimeInMillis { get; init; } + + /// + /// Contains statistics about memory used by selected nodes. + /// [JsonInclude, JsonPropertyName("mem")] public Elastic.Clients.Elasticsearch.Cluster.ClusterJvmMemory Mem { get; init; } + + /// + /// Number of active threads in use by JVM across all selected nodes. + /// [JsonInclude, JsonPropertyName("threads")] public long Threads { get; init; } + + /// + /// Contains statistics about the JVM versions used by selected nodes. + /// [JsonInclude, JsonPropertyName("versions")] public IReadOnlyCollection Versions { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmMemory.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmMemory.g.cs index 15b379ffa18..05928d59d94 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmMemory.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmMemory.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterJvmMemory { + /// + /// Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. + /// [JsonInclude, JsonPropertyName("heap_max_in_bytes")] public long HeapMaxInBytes { get; init; } + + /// + /// Memory, in bytes, currently in use by the heap across all selected nodes. + /// [JsonInclude, JsonPropertyName("heap_used_in_bytes")] public long HeapUsedInBytes { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmVersion.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmVersion.g.cs index fc187ab0d78..c360c172f70 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmVersion.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterJvmVersion.g.cs @@ -29,18 +29,45 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterJvmVersion { + /// + /// Always `true`. All distributions come with a bundled Java Development Kit (JDK). + /// [JsonInclude, JsonPropertyName("bundled_jdk")] public bool BundledJdk { get; init; } + + /// + /// Total number of selected nodes using JVM. + /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } + + /// + /// If `true`, a bundled JDK is in use by JVM. + /// [JsonInclude, JsonPropertyName("using_bundled_jdk")] public bool UsingBundledJdk { get; init; } + + /// + /// Version of JVM used by one or more selected nodes. + /// [JsonInclude, JsonPropertyName("version")] public string Version { get; init; } + + /// + /// Name of the JVM. + /// [JsonInclude, JsonPropertyName("vm_name")] public string VmName { get; init; } + + /// + /// Vendor of the JVM. + /// [JsonInclude, JsonPropertyName("vm_vendor")] public string VmVendor { get; init; } + + /// + /// Full version number of JVM.
The full version number includes a plus sign (+) followed by the build number. + /// [JsonInclude, JsonPropertyName("vm_version")] public string VmVersion { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNetworkTypes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNetworkTypes.g.cs index 2a55722dfd9..5ecb02648b8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNetworkTypes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNetworkTypes.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterNetworkTypes { + /// + /// Contains statistics about the HTTP network types used by selected nodes. + /// [JsonInclude, JsonPropertyName("http_types")] public IReadOnlyDictionary HttpTypes { get; init; } + + /// + /// Contains statistics about the transport network types used by selected nodes. + /// [JsonInclude, JsonPropertyName("transport_types")] public IReadOnlyDictionary TransportTypes { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNodes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNodes.g.cs index c13d828d95c..35ff984d11f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNodes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterNodes.g.cs @@ -76,7 +76,7 @@ public sealed partial class ClusterNodes public IReadOnlyCollection PackagingTypes { get; init; } /// - /// Contains statistics about installed plugins and modules by selected nodes. + /// Contains statistics about installed plugins and modules by selected nodes.
If no plugins or modules are installed, this array is empty. /// [JsonInclude, JsonPropertyName("plugins")] public IReadOnlyCollection Plugins { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystem.g.cs index 4526a044bb3..029e26f088c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystem.g.cs @@ -29,16 +29,39 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterOperatingSystem { + /// + /// Number of processors used to calculate thread pool size across all selected nodes.
This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system.
In both cases, this number will never be larger than 32. + /// [JsonInclude, JsonPropertyName("allocated_processors")] public int AllocatedProcessors { get; init; } + + /// + /// Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes. + /// [JsonInclude, JsonPropertyName("architectures")] public IReadOnlyCollection? Architectures { get; init; } + + /// + /// Number of processors available to JVM across all selected nodes. + /// [JsonInclude, JsonPropertyName("available_processors")] public int AvailableProcessors { get; init; } + + /// + /// Contains statistics about memory used by selected nodes. + /// [JsonInclude, JsonPropertyName("mem")] public Elastic.Clients.Elasticsearch.Cluster.OperatingSystemMemoryInfo Mem { get; init; } + + /// + /// Contains statistics about operating systems used by selected nodes. + /// [JsonInclude, JsonPropertyName("names")] public IReadOnlyCollection Names { get; init; } + + /// + /// Contains statistics about operating systems used by selected nodes. + /// [JsonInclude, JsonPropertyName("pretty_names")] public IReadOnlyCollection PrettyNames { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemArchitecture.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemArchitecture.g.cs index b45b434350c..e0232890c56 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemArchitecture.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemArchitecture.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterOperatingSystemArchitecture { + /// + /// Name of an architecture used by one or more selected nodes. + /// [JsonInclude, JsonPropertyName("arch")] public string Arch { get; init; } + + /// + /// Number of selected nodes using the architecture. + /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemName.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemName.g.cs index 03f14dfe69e..1e419f37b88 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemName.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemName.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterOperatingSystemName { + /// + /// Number of selected nodes using the operating system. + /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } + + /// + /// Name of an operating system used by one or more selected nodes. + /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemPrettyName.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemPrettyName.g.cs index 935b4d9fd32..0fb1da09475 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemPrettyName.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterOperatingSystemPrettyName.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterOperatingSystemPrettyName { + /// + /// Number of selected nodes using the operating system. + /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } + + /// + /// Human-readable name of an operating system used by one or more selected nodes. + /// [JsonInclude, JsonPropertyName("pretty_name")] public string PrettyName { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcess.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcess.g.cs index 407ec88b922..084fcb1f8d5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcess.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcess.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterProcess { + /// + /// Contains statistics about CPU used by selected nodes. + /// [JsonInclude, JsonPropertyName("cpu")] public Elastic.Clients.Elasticsearch.Cluster.ClusterProcessCpu Cpu { get; init; } + + /// + /// Contains statistics about open file descriptors in selected nodes. + /// [JsonInclude, JsonPropertyName("open_file_descriptors")] public Elastic.Clients.Elasticsearch.Cluster.ClusterProcessOpenFileDescriptors OpenFileDescriptors { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessCpu.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessCpu.g.cs index 1eacd5f2993..512a670fe20 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessCpu.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessCpu.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterProcessCpu { + /// + /// Percentage of CPU used across all selected nodes.
Returns `-1` if not supported. + /// [JsonInclude, JsonPropertyName("percent")] public int Percent { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessOpenFileDescriptors.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessOpenFileDescriptors.g.cs index 9d1e73918c3..80eb0e8e1dd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessOpenFileDescriptors.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterProcessOpenFileDescriptors.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterProcessOpenFileDescriptors { + /// + /// Average number of concurrently open file descriptors.
Returns `-1` if not supported. + /// [JsonInclude, JsonPropertyName("avg")] public long Avg { get; init; } + + /// + /// Maximum number of concurrently open file descriptors allowed across all selected nodes.
Returns `-1` if not supported. + /// [JsonInclude, JsonPropertyName("max")] public long Max { get; init; } + + /// + /// Minimum number of concurrently open file descriptors across all selected nodes.
Returns -1 if not supported. + /// [JsonInclude, JsonPropertyName("min")] public long Min { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterShardMetrics.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterShardMetrics.g.cs index c4588747ac7..1298dcb194d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterShardMetrics.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/ClusterShardMetrics.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class ClusterShardMetrics { + /// + /// Mean number of shards in an index, counting only shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("avg")] public double Avg { get; init; } + + /// + /// Maximum number of shards in an index, counting only shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("max")] public double Max { get; init; } + + /// + /// Minimum number of shards in an index, counting only shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("min")] public double Min { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypes.g.cs index 503d96c4b27..7b314d7427e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypes.g.cs @@ -29,18 +29,45 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class FieldTypes { + /// + /// The number of occurrences of the field type in selected nodes. + /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } + + /// + /// The number of indices containing the field type in selected nodes. + /// [JsonInclude, JsonPropertyName("index_count")] public int IndexCount { get; init; } + + /// + /// For dense_vector field types, number of indexed vector types in selected nodes. + /// [JsonInclude, JsonPropertyName("indexed_vector_count")] public long? IndexedVectorCount { get; init; } + + /// + /// For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. + /// [JsonInclude, JsonPropertyName("indexed_vector_dim_max")] public long? IndexedVectorDimMax { get; init; } + + /// + /// For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. + /// [JsonInclude, JsonPropertyName("indexed_vector_dim_min")] public long? IndexedVectorDimMin { get; init; } + + /// + /// The name for the field type in selected nodes. + /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } + + /// + /// The number of fields that declare a script. + /// [JsonInclude, JsonPropertyName("script_count")] public int? ScriptCount { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypesMappings.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypesMappings.g.cs index b9153916e56..ece0cddbc33 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypesMappings.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/FieldTypesMappings.g.cs @@ -29,16 +29,39 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class FieldTypesMappings { + /// + /// Contains statistics about field data types used in selected nodes. + /// [JsonInclude, JsonPropertyName("field_types")] public IReadOnlyCollection FieldTypes { get; init; } + + /// + /// Contains statistics about runtime field data types used in selected nodes. + /// [JsonInclude, JsonPropertyName("runtime_field_types")] public IReadOnlyCollection? RuntimeFieldTypes { get; init; } + + /// + /// Total number of fields in all non-system indices, accounting for mapping deduplication. + /// [JsonInclude, JsonPropertyName("total_deduplicated_field_count")] public int? TotalDeduplicatedFieldCount { get; init; } + + /// + /// Total size of all mappings after deduplication and compression. + /// [JsonInclude, JsonPropertyName("total_deduplicated_mapping_size")] public Elastic.Clients.Elasticsearch.ByteSize? TotalDeduplicatedMappingSize { get; init; } + + /// + /// Total size of all mappings, in bytes, after deduplication and compression. + /// [JsonInclude, JsonPropertyName("total_deduplicated_mapping_size_in_bytes")] public long? TotalDeduplicatedMappingSizeInBytes { get; init; } + + /// + /// Total number of fields in all non-system indices. + /// [JsonInclude, JsonPropertyName("total_field_count")] public int? TotalFieldCount { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/NodePackagingType.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/NodePackagingType.g.cs index 5aaabe0f4d4..6037b569013 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/NodePackagingType.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/NodePackagingType.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class NodePackagingType { + /// + /// Number of selected nodes using the distribution flavor and file type. + /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } + + /// + /// Type of Elasticsearch distribution. This is always `default`. + /// [JsonInclude, JsonPropertyName("flavor")] public string Flavor { get; init; } + + /// + /// File type (such as `tar` or `zip`) used for the distribution package. + /// [JsonInclude, JsonPropertyName("type")] public string Type { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/OperatingSystemMemoryInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/OperatingSystemMemoryInfo.g.cs index 79d496f7415..d781186a519 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/OperatingSystemMemoryInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/OperatingSystemMemoryInfo.g.cs @@ -29,16 +29,39 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class OperatingSystemMemoryInfo { + /// + /// Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set. + /// [JsonInclude, JsonPropertyName("adjusted_total_in_bytes")] public long? AdjustedTotalInBytes { get; init; } + + /// + /// Amount, in bytes, of free physical memory across all selected nodes. + /// [JsonInclude, JsonPropertyName("free_in_bytes")] public long FreeInBytes { get; init; } + + /// + /// Percentage of free physical memory across all selected nodes. + /// [JsonInclude, JsonPropertyName("free_percent")] public int FreePercent { get; init; } + + /// + /// Total amount, in bytes, of physical memory across all selected nodes. + /// [JsonInclude, JsonPropertyName("total_in_bytes")] public long TotalInBytes { get; init; } + + /// + /// Amount, in bytes, of physical memory in use across all selected nodes. + /// [JsonInclude, JsonPropertyName("used_in_bytes")] public long UsedInBytes { get; init; } + + /// + /// Percentage of physical memory in use across all selected nodes. + /// [JsonInclude, JsonPropertyName("used_percent")] public int UsedPercent { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/PendingTask.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/PendingTask.g.cs index 57b561be0da..bb419d5f265 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/PendingTask.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/PendingTask.g.cs @@ -29,16 +29,39 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class PendingTask { + /// + /// Indicates whether the pending tasks are currently executing or not. + /// [JsonInclude, JsonPropertyName("executing")] public bool Executing { get; init; } + + /// + /// The number that represents when the task has been inserted into the task queue. + /// [JsonInclude, JsonPropertyName("insert_order")] public int InsertOrder { get; init; } + + /// + /// The priority of the pending task.
The valid priorities in descending priority order are: `IMMEDIATE` > `URGENT` > `HIGH` > `NORMAL` > `LOW` > `LANGUID`. + /// [JsonInclude, JsonPropertyName("priority")] public string Priority { get; init; } + + /// + /// A general description of the cluster task that may include a reason and origin. + /// [JsonInclude, JsonPropertyName("source")] public string Source { get; init; } + + /// + /// The time since the task is waiting for being performed. + /// [JsonInclude, JsonPropertyName("time_in_queue")] public Elastic.Clients.Elasticsearch.Duration? TimeInQueue { get; init; } + + /// + /// The time expressed in milliseconds since the task is waiting for being performed. + /// [JsonInclude, JsonPropertyName("time_in_queue_millis")] public long TimeInQueueMillis { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/RuntimeFieldTypes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/RuntimeFieldTypes.g.cs index 654d65e3d45..1ef4a777843 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/RuntimeFieldTypes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Cluster/RuntimeFieldTypes.g.cs @@ -29,32 +29,87 @@ namespace Elastic.Clients.Elasticsearch.Cluster; public sealed partial class RuntimeFieldTypes { + /// + /// Maximum number of characters for a single runtime field script. + /// [JsonInclude, JsonPropertyName("chars_max")] public int CharsMax { get; init; } + + /// + /// Total number of characters for the scripts that define the current runtime field data type. + /// [JsonInclude, JsonPropertyName("chars_total")] public int CharsTotal { get; init; } + + /// + /// Number of runtime fields mapped to the field data type in selected nodes. + /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } + + /// + /// Maximum number of accesses to doc_values for a single runtime field script + /// [JsonInclude, JsonPropertyName("doc_max")] public int DocMax { get; init; } + + /// + /// Total number of accesses to doc_values for the scripts that define the current runtime field data type. + /// [JsonInclude, JsonPropertyName("doc_total")] public int DocTotal { get; init; } + + /// + /// Number of indices containing a mapping of the runtime field data type in selected nodes. + /// [JsonInclude, JsonPropertyName("index_count")] public int IndexCount { get; init; } + + /// + /// Script languages used for the runtime fields scripts. + /// [JsonInclude, JsonPropertyName("lang")] public IReadOnlyCollection Lang { get; init; } + + /// + /// Maximum number of lines for a single runtime field script. + /// [JsonInclude, JsonPropertyName("lines_max")] public int LinesMax { get; init; } + + /// + /// Total number of lines for the scripts that define the current runtime field data type. + /// [JsonInclude, JsonPropertyName("lines_total")] public int LinesTotal { get; init; } + + /// + /// Field data type used in selected nodes. + /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } + + /// + /// Number of runtime fields that don’t declare a script. + /// [JsonInclude, JsonPropertyName("scriptless_count")] public int ScriptlessCount { get; init; } + + /// + /// Number of runtime fields that shadow an indexed field. + /// [JsonInclude, JsonPropertyName("shadowed_count")] public int ShadowedCount { get; init; } + + /// + /// Maximum number of accesses to _source for a single runtime field script. + /// [JsonInclude, JsonPropertyName("source_max")] public int SourceMax { get; init; } + + /// + /// Total number of accesses to _source for the scripts that define the current runtime field data type. + /// [JsonInclude, JsonPropertyName("source_total")] public int SourceTotal { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskStatus.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ClusterDetails.g.cs similarity index 51% rename from src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskStatus.g.cs rename to src/Elastic.Clients.Elasticsearch/_Generated/Types/ClusterDetails.g.cs index deb2513da69..535f945911e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskStatus.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ClusterDetails.g.cs @@ -25,42 +25,20 @@ using System.Text.Json; using System.Text.Json.Serialization; -namespace Elastic.Clients.Elasticsearch.Tasks; +namespace Elastic.Clients.Elasticsearch; -public sealed partial class TaskStatus +public sealed partial class ClusterDetails { - [JsonInclude, JsonPropertyName("batches")] - public long Batches { get; init; } - [JsonInclude, JsonPropertyName("canceled")] - public string? Canceled { get; init; } - [JsonInclude, JsonPropertyName("created")] - public long Created { get; init; } - [JsonInclude, JsonPropertyName("deleted")] - public long Deleted { get; init; } + [JsonInclude, JsonPropertyName("_shards")] + public Elastic.Clients.Elasticsearch.ShardStatistics? Shards { get; init; } [JsonInclude, JsonPropertyName("failures")] - public IReadOnlyCollection? Failures { get; init; } - [JsonInclude, JsonPropertyName("noops")] - public long Noops { get; init; } - [JsonInclude, JsonPropertyName("requests_per_second")] - public float RequestsPerSecond { get; init; } - [JsonInclude, JsonPropertyName("retries")] - public Elastic.Clients.Elasticsearch.Retries Retries { get; init; } - [JsonInclude, JsonPropertyName("throttled")] - public Elastic.Clients.Elasticsearch.Duration? Throttled { get; init; } - [JsonInclude, JsonPropertyName("throttled_millis")] - public long ThrottledMillis { get; init; } - [JsonInclude, JsonPropertyName("throttled_until")] - public Elastic.Clients.Elasticsearch.Duration? ThrottledUntil { get; init; } - [JsonInclude, JsonPropertyName("throttled_until_millis")] - public long ThrottledUntilMillis { get; init; } + public IReadOnlyCollection? Failures { get; init; } + [JsonInclude, JsonPropertyName("indices")] + public string Indices { get; init; } + [JsonInclude, JsonPropertyName("status")] + public Elastic.Clients.Elasticsearch.ClusterSearchStatus Status { get; init; } [JsonInclude, JsonPropertyName("timed_out")] - public bool? TimedOut { get; init; } + public bool TimedOut { get; init; } [JsonInclude, JsonPropertyName("took")] public long? Took { get; init; } - [JsonInclude, JsonPropertyName("total")] - public long Total { get; init; } - [JsonInclude, JsonPropertyName("updated")] - public long Updated { get; init; } - [JsonInclude, JsonPropertyName("version_conflicts")] - public long VersionConflicts { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/ClusterStatistics.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ClusterStatistics.g.cs index a1fea4f7973..850bdcd7028 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/ClusterStatistics.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ClusterStatistics.g.cs @@ -29,6 +29,8 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class ClusterStatistics { + [JsonInclude, JsonPropertyName("details")] + public IReadOnlyDictionary? Details { get; init; } [JsonInclude, JsonPropertyName("skipped")] public int Skipped { get; init; } [JsonInclude, JsonPropertyName("successful")] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/CompletionStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/CompletionStats.g.cs index 2bbb9b14ff5..1c1b2e852d8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/CompletionStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/CompletionStats.g.cs @@ -32,8 +32,16 @@ public sealed partial class CompletionStats [JsonInclude, JsonPropertyName("fields")] [ReadOnlyFieldDictionaryConverter(typeof(Elastic.Clients.Elasticsearch.FieldSizeUsage))] public IReadOnlyDictionary? Fields { get; init; } + + /// + /// Total amount of memory used for completion across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("size")] public Elastic.Clients.Elasticsearch.ByteSize? Size { get; init; } + + /// + /// Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("size_in_bytes")] public long SizeInBytes { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/FieldCollapse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/FieldCollapse.g.cs index 779fb77acf9..208a874335c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/FieldCollapse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/FieldCollapse.g.cs @@ -31,10 +31,22 @@ public sealed partial class FieldCollapse { [JsonInclude, JsonPropertyName("collapse")] public Elastic.Clients.Elasticsearch.Core.Search.FieldCollapse? Collapse { get; set; } + + /// + /// The field to collapse the result set on + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } + + /// + /// The number of inner hits and their sort order + /// [JsonInclude, JsonPropertyName("inner_hits"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Core.Search.InnerHits))] public ICollection? InnerHits { get; set; } + + /// + /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// [JsonInclude, JsonPropertyName("max_concurrent_group_searches")] public int? MaxConcurrentGroupSearches { get; set; } } @@ -81,6 +93,9 @@ public FieldCollapseDescriptor Collapse(Action + /// The number of inner hits and their sort order + /// public FieldCollapseDescriptor InnerHits(ICollection? innerHits) { InnerHitsDescriptor = null; @@ -117,18 +132,27 @@ public FieldCollapseDescriptor InnerHits(params Action + /// The field to collapse the result set on + /// public FieldCollapseDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to collapse the result set on + /// public FieldCollapseDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// public FieldCollapseDescriptor MaxConcurrentGroupSearches(int? maxConcurrentGroupSearches) { MaxConcurrentGroupSearchesValue = maxConcurrentGroupSearches; @@ -237,6 +261,9 @@ public FieldCollapseDescriptor Collapse(Action configur return Self; } + /// + /// The number of inner hits and their sort order + /// public FieldCollapseDescriptor InnerHits(ICollection? innerHits) { InnerHitsDescriptor = null; @@ -273,24 +300,36 @@ public FieldCollapseDescriptor InnerHits(params Action[] co return Self; } + /// + /// The field to collapse the result set on + /// public FieldCollapseDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to collapse the result set on + /// public FieldCollapseDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to collapse the result set on + /// public FieldCollapseDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The number of concurrent requests allowed to retrieve the inner_hits per group + /// public FieldCollapseDescriptor MaxConcurrentGroupSearches(int? maxConcurrentGroupSearches) { MaxConcurrentGroupSearchesValue = maxConcurrentGroupSearches; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/InnerHits.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/InnerHits.g.cs index a1ff35dc40b..28436499e79 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/InnerHits.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/InnerHits.g.cs @@ -39,20 +39,36 @@ public sealed partial class InnerHits public bool? Explain { get; set; } [JsonInclude, JsonPropertyName("fields")] public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } + + /// + /// Inner hit starting document offset. + /// [JsonInclude, JsonPropertyName("from")] public int? From { get; set; } [JsonInclude, JsonPropertyName("highlight")] public Elastic.Clients.Elasticsearch.Core.Search.Highlight? Highlight { get; set; } [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } + + /// + /// The name for the particular inner hit definition in the response.
Useful when a search request contains multiple inner hits. + /// [JsonInclude, JsonPropertyName("name")] public Elastic.Clients.Elasticsearch.Name? Name { get; set; } [JsonInclude, JsonPropertyName("script_fields")] public IDictionary? ScriptFields { get; set; } [JsonInclude, JsonPropertyName("seq_no_primary_term")] public bool? SeqNoPrimaryTerm { get; set; } + + /// + /// The maximum number of hits to return per `inner_hits`. + /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } + + /// + /// How the inner hits should be sorted per `inner_hits`.
By default, inner hits are sorted by score. + /// [JsonInclude, JsonPropertyName("sort"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.SortOptions))] public ICollection? Sort { get; set; } [JsonInclude, JsonPropertyName("stored_field")] @@ -182,6 +198,9 @@ public InnerHitsDescriptor Highlight(Action + /// How the inner hits should be sorted per `inner_hits`.
By default, inner hits are sorted by score. + /// public InnerHitsDescriptor Sort(ICollection? sort) { SortDescriptor = null; @@ -236,6 +255,9 @@ public InnerHitsDescriptor Fields(Elastic.Clients.Elasticsearch.Field return Self; } + /// + /// Inner hit starting document offset. + /// public InnerHitsDescriptor From(int? from) { FromValue = from; @@ -248,6 +270,9 @@ public InnerHitsDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true return Self; } + /// + /// The name for the particular inner hit definition in the response.
Useful when a search request contains multiple inner hits. + /// public InnerHitsDescriptor Name(Elastic.Clients.Elasticsearch.Name? name) { NameValue = name; @@ -266,6 +291,9 @@ public InnerHitsDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = return Self; } + /// + /// The maximum number of hits to return per `inner_hits`. + /// public InnerHitsDescriptor Size(int? size) { SizeValue = size; @@ -580,6 +608,9 @@ public InnerHitsDescriptor Highlight(Action configure) return Self; } + /// + /// How the inner hits should be sorted per `inner_hits`.
By default, inner hits are sorted by score. + /// public InnerHitsDescriptor Sort(ICollection? sort) { SortDescriptor = null; @@ -634,6 +665,9 @@ public InnerHitsDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) return Self; } + /// + /// Inner hit starting document offset. + /// public InnerHitsDescriptor From(int? from) { FromValue = from; @@ -646,6 +680,9 @@ public InnerHitsDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) return Self; } + /// + /// The name for the particular inner hit definition in the response.
Useful when a search request contains multiple inner hits. + /// public InnerHitsDescriptor Name(Elastic.Clients.Elasticsearch.Name? name) { NameValue = name; @@ -664,6 +701,9 @@ public InnerHitsDescriptor SeqNoPrimaryTerm(bool? seqNoPrimaryTerm = true) return Self; } + /// + /// The maximum number of hits to return per `inner_hits`. + /// public InnerHitsDescriptor Size(int? size) { SizeValue = size; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/RescoreQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/RescoreQuery.g.cs index 8b0c2d8f221..5e0be4614be 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/RescoreQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Search/RescoreQuery.g.cs @@ -29,12 +29,27 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; public sealed partial class RescoreQuery { + /// + /// Relative importance of the original query versus the rescore query. + /// [JsonInclude, JsonPropertyName("query_weight")] public double? QueryWeight { get; set; } + + /// + /// The query to use for rescoring.
This query is only run on the Top-K results returned by the `query` and `post_filter` phases. + /// [JsonInclude, JsonPropertyName("rescore_query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } + + /// + /// Relative importance of the rescore query versus the original query. + /// [JsonInclude, JsonPropertyName("rescore_query_weight")] public double? RescoreQueryWeight { get; set; } + + /// + /// Determines how scores are combined. + /// [JsonInclude, JsonPropertyName("score_mode")] public Elastic.Clients.Elasticsearch.Core.Search.ScoreMode? ScoreMode { get; set; } } @@ -54,6 +69,9 @@ public RescoreQueryDescriptor() : base() private double? RescoreQueryWeightValue { get; set; } private Elastic.Clients.Elasticsearch.Core.Search.ScoreMode? ScoreModeValue { get; set; } + /// + /// The query to use for rescoring.
This query is only run on the Top-K results returned by the `query` and `post_filter` phases. + /// public RescoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { QueryDescriptor = null; @@ -78,18 +96,27 @@ public RescoreQueryDescriptor Query(Action + /// Relative importance of the original query versus the rescore query. + /// public RescoreQueryDescriptor QueryWeight(double? queryWeight) { QueryWeightValue = queryWeight; return Self; } + /// + /// Relative importance of the rescore query versus the original query. + /// public RescoreQueryDescriptor RescoreQueryWeight(double? rescoreQueryWeight) { RescoreQueryWeightValue = rescoreQueryWeight; return Self; } + /// + /// Determines how scores are combined. + /// public RescoreQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Core.Search.ScoreMode? scoreMode) { ScoreModeValue = scoreMode; @@ -152,6 +179,9 @@ public RescoreQueryDescriptor() : base() private double? RescoreQueryWeightValue { get; set; } private Elastic.Clients.Elasticsearch.Core.Search.ScoreMode? ScoreModeValue { get; set; } + /// + /// The query to use for rescoring.
This query is only run on the Top-K results returned by the `query` and `post_filter` phases. + /// public RescoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { QueryDescriptor = null; @@ -176,18 +206,27 @@ public RescoreQueryDescriptor Query(Action configure) return Self; } + /// + /// Relative importance of the original query versus the rescore query. + /// public RescoreQueryDescriptor QueryWeight(double? queryWeight) { QueryWeightValue = queryWeight; return Self; } + /// + /// Relative importance of the rescore query versus the original query. + /// public RescoreQueryDescriptor RescoreQueryWeight(double? rescoreQueryWeight) { RescoreQueryWeightValue = rescoreQueryWeight; return Self; } + /// + /// Determines how scores are combined. + /// public RescoreQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.Core.Search.ScoreMode? scoreMode) { ScoreModeValue = scoreMode; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/DocStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/DocStats.g.cs index 9173402743e..81d06bb0719 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/DocStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/DocStats.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class DocStats { + /// + /// Total number of non-deleted documents across all primary shards assigned to selected nodes.
This number is based on documents in Lucene segments and may include documents from nested fields. + /// [JsonInclude, JsonPropertyName("count")] public long Count { get; init; } + + /// + /// Total number of deleted documents across all primary shards assigned to selected nodes.
This number is based on documents in Lucene segments.
Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged. + /// [JsonInclude, JsonPropertyName("deleted")] public long? Deleted { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Aggregations.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Aggregations.g.cs index d198046c6a6..f8c27eb1444 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Aggregations.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Aggregations.g.cs @@ -122,14 +122,29 @@ public override void Write(Utf8JsonWriter writer, CalendarInterval value, JsonSe [JsonConverter(typeof(CardinalityExecutionModeConverter))] public enum CardinalityExecutionMode { + /// + /// Run the aggregation by using segment ordinal values and resolving those values after each segment. + /// [EnumMember(Value = "segment_ordinals")] SegmentOrdinals, + /// + /// Heuristic-based mode, default in Elasticsearch 8.4 and later. + /// [EnumMember(Value = "save_time_heuristic")] SaveTimeHeuristic, + /// + /// Heuristic-based mode, default in Elasticsearch 8.3 and earlier. + /// [EnumMember(Value = "save_memory_heuristic")] SaveMemoryHeuristic, + /// + /// Run the aggregation by using global ordinals of the field and resolving those values after finishing a shard. + /// [EnumMember(Value = "global_ordinals")] GlobalOrdinals, + /// + /// Run the aggregation by using field values directly. + /// [EnumMember(Value = "direct")] Direct } @@ -358,8 +373,14 @@ public override void Write(Utf8JsonWriter writer, MissingOrder value, JsonSerial [JsonConverter(typeof(RateModeConverter))] public enum RateMode { + /// + /// Uses the number of values of the field. + /// [EnumMember(Value = "value_count")] ValueCount, + /// + /// Calculates the sum of all values of the field. + /// [EnumMember(Value = "sum")] Sum } @@ -399,10 +420,19 @@ public override void Write(Utf8JsonWriter writer, RateMode value, JsonSerializer [JsonConverter(typeof(SamplerAggregationExecutionHintConverter))] public enum SamplerAggregationExecutionHint { + /// + /// Hold field values directly. + /// [EnumMember(Value = "map")] Map, + /// + /// Hold ordinals of the field as determined by the Lucene index. + /// [EnumMember(Value = "global_ordinals")] GlobalOrdinals, + /// + /// Hold hashes of the field values - with potential for hash collisions. + /// [EnumMember(Value = "bytes_hash")] BytesHash } @@ -447,8 +477,14 @@ public override void Write(Utf8JsonWriter writer, SamplerAggregationExecutionHin [JsonConverter(typeof(TermsAggregationCollectModeConverter))] public enum TermsAggregationCollectMode { + /// + /// Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs. + /// [EnumMember(Value = "depth_first")] DepthFirst, + /// + /// Caches the set of documents that fall into the uppermost buckets for subsequent replay. + /// [EnumMember(Value = "breadth_first")] BreadthFirst } @@ -543,10 +579,19 @@ public override void Write(Utf8JsonWriter writer, TermsAggregationExecutionHint [JsonConverter(typeof(TTestTypeConverter))] public enum TTestType { + /// + /// Performs paired t-test. + /// [EnumMember(Value = "paired")] Paired, + /// + /// Performs two-sample equal variance test. + /// [EnumMember(Value = "homoscedastic")] Homoscedastic, + /// + /// Performs two-sample unequal variance test. + /// [EnumMember(Value = "heteroscedastic")] Heteroscedastic } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Core.Search.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Core.Search.g.cs index 24287f5ac84..7f3d26f7d55 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Core.Search.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Core.Search.g.cs @@ -31,10 +31,19 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; [JsonConverter(typeof(BoundaryScannerConverter))] public enum BoundaryScanner { + /// + /// Break highlighted fragments at the next word boundary, as determined by Java’s `BreakIterator`.
You can specify the locale to use with `boundary_scanner_locale`. + /// [EnumMember(Value = "word")] Word, + /// + /// Break highlighted fragments at the next sentence boundary, as determined by Java’s `BreakIterator`.
You can specify the locale to use with `boundary_scanner_locale`.
When used with the `unified` highlighter, the `sentence` scanner splits sentences bigger than `fragment_size` at the first word boundary next to fragment_size.
You can set `fragment_size` to `0` to never split any sentence. + /// [EnumMember(Value = "sentence")] Sentence, + /// + /// Use the characters specified by `boundary_chars` as highlighting boundaries.
The `boundary_max_scan` setting controls how far to scan for boundary characters.
Only valid for the `fvh` highlighter. + /// [EnumMember(Value = "chars")] Chars } @@ -234,8 +243,20 @@ public override void Write(Utf8JsonWriter writer, HighlighterTagsSchema value, J HighlighterType IEnumStruct.Create(string value) => value; public readonly string Value { get; } + + /// + /// The unified highlighter uses the Lucene Unified Highlighter. + /// public static HighlighterType Unified { get; } = new HighlighterType("unified"); + + /// + /// The `plain` highlighter uses the standard Lucene highlighter + /// public static HighlighterType Plain { get; } = new HighlighterType("plain"); + + /// + /// The fvh highlighter uses the Lucene Fast Vector highlighter. + /// public static HighlighterType FastVector { get; } = new HighlighterType("fvh"); public override string ToString() => Value ?? string.Empty; @@ -254,14 +275,29 @@ public override void Write(Utf8JsonWriter writer, HighlighterTagsSchema value, J [JsonConverter(typeof(ScoreModeConverter))] public enum ScoreMode { + /// + /// Add the original score and the rescore query score. + /// [EnumMember(Value = "total")] Total, + /// + /// Multiply the original score by the rescore query score.
Useful for `function` query rescores. + /// [EnumMember(Value = "multiply")] Multiply, + /// + /// Take the min of the original score and the rescore query score. + /// [EnumMember(Value = "min")] Min, + /// + /// Take the max of original score and the rescore query score. + /// [EnumMember(Value = "max")] Max, + /// + /// Average the original score and the rescore query score. + /// [EnumMember(Value = "avg")] Avg } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.NoNamespace.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.NoNamespace.g.cs index 71f4cf70ec3..1581f267e96 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.NoNamespace.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.NoNamespace.g.cs @@ -28,6 +28,68 @@ namespace Elastic.Clients.Elasticsearch; +[JsonConverter(typeof(ClusterSearchStatusConverter))] +public enum ClusterSearchStatus +{ + [EnumMember(Value = "successful")] + Successful, + [EnumMember(Value = "skipped")] + Skipped, + [EnumMember(Value = "running")] + Running, + [EnumMember(Value = "partial")] + Partial, + [EnumMember(Value = "failed")] + Failed +} + +internal sealed class ClusterSearchStatusConverter : JsonConverter +{ + public override ClusterSearchStatus Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + var enumString = reader.GetString(); + switch (enumString) + { + case "successful": + return ClusterSearchStatus.Successful; + case "skipped": + return ClusterSearchStatus.Skipped; + case "running": + return ClusterSearchStatus.Running; + case "partial": + return ClusterSearchStatus.Partial; + case "failed": + return ClusterSearchStatus.Failed; + } + + ThrowHelper.ThrowJsonException(); return default; + } + + public override void Write(Utf8JsonWriter writer, ClusterSearchStatus value, JsonSerializerOptions options) + { + switch (value) + { + case ClusterSearchStatus.Successful: + writer.WriteStringValue("successful"); + return; + case ClusterSearchStatus.Skipped: + writer.WriteStringValue("skipped"); + return; + case ClusterSearchStatus.Running: + writer.WriteStringValue("running"); + return; + case ClusterSearchStatus.Partial: + writer.WriteStringValue("partial"); + return; + case ClusterSearchStatus.Failed: + writer.WriteStringValue("failed"); + return; + } + + writer.WriteNullValue(); + } +} + [JsonConverter(typeof(ConflictsConverter))] public enum Conflicts { @@ -466,8 +528,14 @@ public override void Write(Utf8JsonWriter writer, FieldSortNumericType value, Js [JsonConverter(typeof(GeoDistanceTypeConverter))] public enum GeoDistanceType { + /// + /// The `plane` calculation is faster but less accurate. + /// [EnumMember(Value = "plane")] Plane, + /// + /// The `arc` calculation is the most accurate. + /// [EnumMember(Value = "arc")] Arc } @@ -507,12 +575,24 @@ public override void Write(Utf8JsonWriter writer, GeoDistanceType value, JsonSer [JsonConverter(typeof(GeoShapeRelationConverter))] public enum GeoShapeRelation { + /// + /// Return all documents whose `geo_shape` or `geo_point` field is within the query geometry.
Line geometries are not supported. + /// [EnumMember(Value = "within")] Within, + /// + /// Return all documents whose `geo_shape` or `geo_point` field intersects the query geometry. + /// [EnumMember(Value = "intersects")] Intersects, + /// + /// Return all documents whose `geo_shape` or `geo_point` field has nothing in common with the query geometry. + /// [EnumMember(Value = "disjoint")] Disjoint, + /// + /// Return all documents whose `geo_shape` or `geo_point` field contains the query geometry. + /// [EnumMember(Value = "contains")] Contains } @@ -1006,9 +1086,25 @@ public override void Write(Utf8JsonWriter writer, Result value, JsonSerializerOp ScriptLanguage IEnumStruct.Create(string value) => value; public readonly string Value { get; } + + /// + /// Painless scripting language, purpose-built for Elasticsearch. + /// public static ScriptLanguage Painless { get; } = new ScriptLanguage("painless"); + + /// + /// Mustache templated, used for templates. + /// public static ScriptLanguage Mustache { get; } = new ScriptLanguage("mustache"); + + /// + /// Expert Java API + /// public static ScriptLanguage Java { get; } = new ScriptLanguage("java"); + + /// + /// Lucene’s expressions language, compiles a JavaScript expression to bytecode. + /// public static ScriptLanguage Expression { get; } = new ScriptLanguage("expression"); public override string ToString() => Value ?? string.Empty; @@ -1221,8 +1317,14 @@ public override void Write(Utf8JsonWriter writer, SortMode value, JsonSerializer [JsonConverter(typeof(SortOrderConverter))] public enum SortOrder { + /// + /// Descending (largest to smallest) + /// [EnumMember(Value = "desc")] Desc, + /// + /// Ascending (smallest to largest) + /// [EnumMember(Value = "asc")] Asc } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.QueryDsl.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.QueryDsl.g.cs index 277d48df77b..f917171c292 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.QueryDsl.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.QueryDsl.g.cs @@ -134,8 +134,14 @@ public override void Write(Utf8JsonWriter writer, CombinedFieldsOperator value, [JsonConverter(typeof(CombinedFieldsZeroTermsConverter))] public enum CombinedFieldsZeroTerms { + /// + /// No documents are returned if the analyzer removes all tokens. + /// [EnumMember(Value = "none")] None, + /// + /// Returns all documents, similar to a `match_all` query. + /// [EnumMember(Value = "all")] All } @@ -175,24 +181,54 @@ public override void Write(Utf8JsonWriter writer, CombinedFieldsZeroTerms value, [JsonConverter(typeof(FieldValueFactorModifierConverter))] public enum FieldValueFactorModifier { + /// + /// Square the field value (multiply it by itself). + /// [EnumMember(Value = "square")] Square, + /// + /// Take the square root of the field value. + /// [EnumMember(Value = "sqrt")] Sqrt, + /// + /// Reciprocate the field value, same as `1/x` where `x` is the field’s value. + /// [EnumMember(Value = "reciprocal")] Reciprocal, + /// + /// Do not apply any multiplier to the field value. + /// [EnumMember(Value = "none")] None, + /// + /// Add 2 to the field value and take the common logarithm. + /// [EnumMember(Value = "log2p")] Log2p, + /// + /// Add 1 to the field value and take the common logarithm. + /// [EnumMember(Value = "log1p")] Log1p, + /// + /// Take the common logarithm of the field value.
Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `log1p` instead. + /// [EnumMember(Value = "log")] Log, + /// + /// Add 2 to the field value and take the natural logarithm. + /// [EnumMember(Value = "ln2p")] Ln2p, + /// + /// Add 1 to the field value and take the natural logarithm. + /// [EnumMember(Value = "ln1p")] Ln1p, + /// + /// Take the natural logarithm of the field value.
Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `ln1p` instead. + /// [EnumMember(Value = "ln")] Ln } @@ -272,16 +308,34 @@ public override void Write(Utf8JsonWriter writer, FieldValueFactorModifier value [JsonConverter(typeof(FunctionBoostModeConverter))] public enum FunctionBoostMode { + /// + /// Query score and function score are added + /// [EnumMember(Value = "sum")] Sum, + /// + /// Only the function score is used.
The query score is ignored. + /// [EnumMember(Value = "replace")] Replace, + /// + /// Query score and function score are multiplied + /// [EnumMember(Value = "multiply")] Multiply, + /// + /// Min of query score and function score + /// [EnumMember(Value = "min")] Min, + /// + /// Max of query score and function score + /// [EnumMember(Value = "max")] Max, + /// + /// Query score and function score are averaged + /// [EnumMember(Value = "avg")] Avg } @@ -341,16 +395,34 @@ public override void Write(Utf8JsonWriter writer, FunctionBoostMode value, JsonS [JsonConverter(typeof(FunctionScoreModeConverter))] public enum FunctionScoreMode { + /// + /// Scores are summed. + /// [EnumMember(Value = "sum")] Sum, + /// + /// Scores are multiplied. + /// [EnumMember(Value = "multiply")] Multiply, + /// + /// Minimum score is used. + /// [EnumMember(Value = "min")] Min, + /// + /// Maximum score is used. + /// [EnumMember(Value = "max")] Max, + /// + /// The first function that has a matching filter is applied. + /// [EnumMember(Value = "first")] First, + /// + /// Scores are averaged. + /// [EnumMember(Value = "avg")] Avg } @@ -412,8 +484,14 @@ public enum GeoValidationMethod { [EnumMember(Value = "strict")] Strict, + /// + /// Accept geo points with invalid latitude or longitude. + /// [EnumMember(Value = "ignore_malformed")] IgnoreMalformed, + /// + /// Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates. + /// [EnumMember(Value = "coerce")] Coerce } @@ -501,10 +579,19 @@ public override void Write(Utf8JsonWriter writer, Operator value, JsonSerializer [JsonConverter(typeof(RangeRelationConverter))] public enum RangeRelation { + /// + /// Matches documents with a range field value entirely within the query’s range. + /// [EnumMember(Value = "within")] Within, + /// + /// Matches documents with a range field value that intersects the query’s range. + /// [EnumMember(Value = "intersects")] Intersects, + /// + /// Matches documents with a range field value that entirely contains the query’s range. + /// [EnumMember(Value = "contains")] Contains } @@ -550,30 +637,69 @@ public override void Write(Utf8JsonWriter writer, RangeRelation value, JsonSeria [Flags] public enum SimpleQueryStringFlags { + /// + /// Enables whitespace as split characters. + /// [EnumMember(Value = "WHITESPACE")] Whitespace = 1 << 0, + /// + /// Enables the `~N` operator, after a phrase where `N` is maximum number of positions allowed between matching tokens.
Synonymous to `NEAR`. + /// [EnumMember(Value = "SLOP")] Slop = 1 << 1, + /// + /// Enables the `*` prefix operator. + /// [EnumMember(Value = "PREFIX")] Prefix = 1 << 2, + /// + /// Enables the `(` and `)` operators to control operator precedence. + /// [EnumMember(Value = "PRECEDENCE")] Precedence = 1 << 3, + /// + /// Enables the `"` quotes operator used to search for phrases. + /// [EnumMember(Value = "PHRASE")] Phrase = 1 << 4, + /// + /// Enables the `\|` OR operator. + /// [EnumMember(Value = "OR")] Or = 1 << 5, + /// + /// Enables the `-` NOT operator. + /// [EnumMember(Value = "NOT")] Not = 1 << 6, + /// + /// Disables all operators. + /// [EnumMember(Value = "NONE")] None = 1 << 7, + /// + /// Enables the `~N` operator, after a phrase where `N` is the maximum number of positions allowed between matching tokens.
Synonymous to `SLOP`. + /// [EnumMember(Value = "NEAR")] Near = 1 << 8, + /// + /// Enables the `~N` operator after a word, where `N` is an integer denoting the allowed edit distance for matching. + /// [EnumMember(Value = "FUZZY")] Fuzzy = 1 << 9, + /// + /// Enables `\` as an escape character. + /// [EnumMember(Value = "ESCAPE")] Escape = 1 << 10, + /// + /// Enables the `+` AND operator. + /// [EnumMember(Value = "AND")] And = 1 << 11, + /// + /// Enables all optional operators. + /// [EnumMember(Value = "ALL")] All = 1 << 12 } @@ -663,16 +789,34 @@ public override void Write(Utf8JsonWriter writer, SimpleQueryStringFlags value, [JsonConverter(typeof(TextQueryTypeConverter))] public enum TextQueryType { + /// + /// Runs a `match_phrase_prefix` query on each field and uses the `_score` from the best field. + /// [EnumMember(Value = "phrase_prefix")] PhrasePrefix, + /// + /// Runs a `match_phrase` query on each field and uses the `_score` from the best field. + /// [EnumMember(Value = "phrase")] Phrase, + /// + /// Finds documents that match any field and combines the `_score` from each field. + /// [EnumMember(Value = "most_fields")] MostFields, + /// + /// Treats fields with the same analyzer as though they were one big field.
Looks for each word in any field. + /// [EnumMember(Value = "cross_fields")] CrossFields, + /// + /// Creates a `match_bool_prefix` query on each field and combines the `_score` from each field. + /// [EnumMember(Value = "bool_prefix")] BoolPrefix, + /// + /// Finds documents that match any field, but uses the `_score` from the best field. + /// [EnumMember(Value = "best_fields")] BestFields } @@ -732,8 +876,14 @@ public override void Write(Utf8JsonWriter writer, TextQueryType value, JsonSeria [JsonConverter(typeof(ZeroTermsQueryConverter))] public enum ZeroTermsQuery { + /// + /// No documents are returned if the `analyzer` removes all tokens. + /// [EnumMember(Value = "none")] None, + /// + /// Returns all documents, similar to a `match_all` query. + /// [EnumMember(Value = "all")] All } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/ExploreControls.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/ExploreControls.g.cs index e7f9661576c..2d27e3bf5a7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/ExploreControls.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/ExploreControls.g.cs @@ -29,12 +29,27 @@ namespace Elastic.Clients.Elasticsearch.Graph; public sealed partial class ExploreControls { + /// + /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.
You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// [JsonInclude, JsonPropertyName("sample_diversity")] public Elastic.Clients.Elasticsearch.Graph.SampleDiversity? SampleDiversity { get; set; } + + /// + /// Each hop considers a sample of the best-matching documents on each shard.
Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.
Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.
Very large sample sizes can dilute the quality of the results and increase execution times. + /// [JsonInclude, JsonPropertyName("sample_size")] public int? SampleSize { get; set; } + + /// + /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.
This timeout is honored on a best-effort basis.
Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// [JsonInclude, JsonPropertyName("timeout")] public Elastic.Clients.Elasticsearch.Duration? Timeout { get; set; } + + /// + /// Filters associated terms so only those that are significantly associated with your query are included. + /// [JsonInclude, JsonPropertyName("use_significance")] public bool UseSignificance { get; set; } } @@ -54,6 +69,9 @@ public ExploreControlsDescriptor() : base() private Elastic.Clients.Elasticsearch.Duration? TimeoutValue { get; set; } private bool UseSignificanceValue { get; set; } + /// + /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.
You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// public ExploreControlsDescriptor SampleDiversity(Elastic.Clients.Elasticsearch.Graph.SampleDiversity? sampleDiversity) { SampleDiversityDescriptor = null; @@ -78,18 +96,27 @@ public ExploreControlsDescriptor SampleDiversity(Action + /// Each hop considers a sample of the best-matching documents on each shard.
Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.
Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.
Very large sample sizes can dilute the quality of the results and increase execution times. + /// public ExploreControlsDescriptor SampleSize(int? sampleSize) { SampleSizeValue = sampleSize; return Self; } + /// + /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.
This timeout is honored on a best-effort basis.
Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// public ExploreControlsDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { TimeoutValue = timeout; return Self; } + /// + /// Filters associated terms so only those that are significantly associated with your query are included. + /// public ExploreControlsDescriptor UseSignificance(bool useSignificance = true) { UseSignificanceValue = useSignificance; @@ -148,6 +175,9 @@ public ExploreControlsDescriptor() : base() private Elastic.Clients.Elasticsearch.Duration? TimeoutValue { get; set; } private bool UseSignificanceValue { get; set; } + /// + /// To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.
You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. + /// public ExploreControlsDescriptor SampleDiversity(Elastic.Clients.Elasticsearch.Graph.SampleDiversity? sampleDiversity) { SampleDiversityDescriptor = null; @@ -172,18 +202,27 @@ public ExploreControlsDescriptor SampleDiversity(Action + /// Each hop considers a sample of the best-matching documents on each shard.
Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms.
Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms.
Very large sample sizes can dilute the quality of the results and increase execution times. + /// public ExploreControlsDescriptor SampleSize(int? sampleSize) { SampleSizeValue = sampleSize; return Self; } + /// + /// The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.
This timeout is honored on a best-effort basis.
Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. + /// public ExploreControlsDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) { TimeoutValue = timeout; return Self; } + /// + /// Filters associated terms so only those that are significantly associated with your query are included. + /// public ExploreControlsDescriptor UseSignificance(bool useSignificance = true) { UseSignificanceValue = useSignificance; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/Hop.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/Hop.g.cs index 0891f2aee25..ee47408b499 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/Hop.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/Hop.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.Graph; public sealed partial class Hop { + /// + /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// [JsonInclude, JsonPropertyName("connections")] public Elastic.Clients.Elasticsearch.Graph.Hop? Connections { get; set; } + + /// + /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } + + /// + /// Contains the fields you are interested in. + /// [JsonInclude, JsonPropertyName("vertices")] public ICollection Vertices { get; set; } } @@ -56,6 +67,9 @@ public HopDescriptor() : base() private Action> VerticesDescriptorAction { get; set; } private Action>[] VerticesDescriptorActions { get; set; } + /// + /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// public HopDescriptor Connections(Elastic.Clients.Elasticsearch.Graph.Hop? connections) { ConnectionsDescriptor = null; @@ -80,6 +94,9 @@ public HopDescriptor Connections(Action> con return Self; } + /// + /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// public HopDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { QueryDescriptor = null; @@ -104,6 +121,9 @@ public HopDescriptor Query(Action return Self; } + /// + /// Contains the fields you are interested in. + /// public HopDescriptor Vertices(ICollection vertices) { VerticesDescriptor = null; @@ -229,6 +249,9 @@ public HopDescriptor() : base() private Action VerticesDescriptorAction { get; set; } private Action[] VerticesDescriptorActions { get; set; } + /// + /// Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. + /// public HopDescriptor Connections(Elastic.Clients.Elasticsearch.Graph.Hop? connections) { ConnectionsDescriptor = null; @@ -253,6 +276,9 @@ public HopDescriptor Connections(Action configure) return Self; } + /// + /// An optional guiding query that constrains the Graph API as it explores connected terms. + /// public HopDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { QueryDescriptor = null; @@ -277,6 +303,9 @@ public HopDescriptor Query(Action configure) return Self; } + /// + /// Contains the fields you are interested in. + /// public HopDescriptor Vertices(ICollection vertices) { VerticesDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/VertexDefinition.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/VertexDefinition.g.cs index 52a2baadc19..3b67b039c63 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/VertexDefinition.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Graph/VertexDefinition.g.cs @@ -29,16 +29,39 @@ namespace Elastic.Clients.Elasticsearch.Graph; public sealed partial class VertexDefinition { + /// + /// Prevents the specified terms from being included in the results. + /// [JsonInclude, JsonPropertyName("exclude")] public ICollection? Exclude { get; set; } + + /// + /// Identifies a field in the documents of interest. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } + + /// + /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// [JsonInclude, JsonPropertyName("include")] public ICollection? Include { get; set; } + + /// + /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
This setting acts as a certainty threshold. + /// [JsonInclude, JsonPropertyName("min_doc_count")] public long? MinDocCount { get; set; } + + /// + /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// [JsonInclude, JsonPropertyName("shard_min_doc_count")] public long? ShardMinDocCount { get; set; } + + /// + /// Specifies the maximum number of vertex terms returned for each field. + /// [JsonInclude, JsonPropertyName("size")] public int? Size { get; set; } } @@ -61,24 +84,36 @@ public VertexDefinitionDescriptor() : base() private long? ShardMinDocCountValue { get; set; } private int? SizeValue { get; set; } + /// + /// Prevents the specified terms from being included in the results. + /// public VertexDefinitionDescriptor Exclude(ICollection? exclude) { ExcludeValue = exclude; return Self; } + /// + /// Identifies a field in the documents of interest. + /// public VertexDefinitionDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// Identifies a field in the documents of interest. + /// public VertexDefinitionDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// public VertexDefinitionDescriptor Include(ICollection? include) { IncludeDescriptor = null; @@ -115,18 +150,27 @@ public VertexDefinitionDescriptor Include(params Action + /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
This setting acts as a certainty threshold. + /// public VertexDefinitionDescriptor MinDocCount(long? minDocCount) { MinDocCountValue = minDocCount; return Self; } + /// + /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// public VertexDefinitionDescriptor ShardMinDocCount(long? shardMinDocCount) { ShardMinDocCountValue = shardMinDocCount; return Self; } + /// + /// Specifies the maximum number of vertex terms returned for each field. + /// public VertexDefinitionDescriptor Size(int? size) { SizeValue = size; @@ -215,30 +259,45 @@ public VertexDefinitionDescriptor() : base() private long? ShardMinDocCountValue { get; set; } private int? SizeValue { get; set; } + /// + /// Prevents the specified terms from being included in the results. + /// public VertexDefinitionDescriptor Exclude(ICollection? exclude) { ExcludeValue = exclude; return Self; } + /// + /// Identifies a field in the documents of interest. + /// public VertexDefinitionDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// Identifies a field in the documents of interest. + /// public VertexDefinitionDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Identifies a field in the documents of interest. + /// public VertexDefinitionDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Identifies the terms of interest that form the starting points from which you want to spider out. + /// public VertexDefinitionDescriptor Include(ICollection? include) { IncludeDescriptor = null; @@ -275,18 +334,27 @@ public VertexDefinitionDescriptor Include(params Action return Self; } + /// + /// Specifies how many documents must contain a pair of terms before it is considered to be a useful connection.
This setting acts as a certainty threshold. + /// public VertexDefinitionDescriptor MinDocCount(long? minDocCount) { MinDocCountValue = minDocCount; return Self; } + /// + /// Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. + /// public VertexDefinitionDescriptor ShardMinDocCount(long? shardMinDocCount) { ShardMinDocCountValue = shardMinDocCount; return Self; } + /// + /// Specifies the maximum number of vertex terms returned for each field. + /// public VertexDefinitionDescriptor Size(int? size) { SizeValue = size; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AddAction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AddAction.g.cs index 21550950462..bec6d32aa86 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AddAction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AddAction.g.cs @@ -29,26 +29,69 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class AddAction { + /// + /// Alias for the action.
Index alias names support date math. + /// [JsonInclude, JsonPropertyName("alias")] public Elastic.Clients.Elasticsearch.IndexAlias? Alias { get; set; } + + /// + /// Aliases for the action.
Index alias names support date math. + /// [JsonInclude, JsonPropertyName("aliases"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.IndexAlias))] public ICollection? Aliases { get; set; } + + /// + /// Query used to limit documents the alias can access. + /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; set; } + + /// + /// Data stream or index for the action.
Supports wildcards (`*`). + /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } + + /// + /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// [JsonInclude, JsonPropertyName("index_routing")] public Elastic.Clients.Elasticsearch.Routing? IndexRouting { get; set; } + + /// + /// Data streams or indices for the action.
Supports wildcards (`*`). + /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Indices? Indices { get; set; } + + /// + /// If `true`, the alias is hidden. + /// [JsonInclude, JsonPropertyName("is_hidden")] public bool? IsHidden { get; set; } + + /// + /// If `true`, sets the write index or data stream for the alias. + /// [JsonInclude, JsonPropertyName("is_write_index")] public bool? IsWriteIndex { get; set; } + + /// + /// If `true`, the alias must exist to perform the action. + /// [JsonInclude, JsonPropertyName("must_exist")] public bool? MustExist { get; set; } + + /// + /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } + + /// + /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// [JsonInclude, JsonPropertyName("search_routing")] public Elastic.Clients.Elasticsearch.Routing? SearchRouting { get; set; } @@ -77,6 +120,9 @@ public AddActionDescriptor() : base() private Elastic.Clients.Elasticsearch.Routing? RoutingValue { get; set; } private Elastic.Clients.Elasticsearch.Routing? SearchRoutingValue { get; set; } + /// + /// Query used to limit documents the alias can access. + /// public AddActionDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { FilterDescriptor = null; @@ -101,60 +147,90 @@ public AddActionDescriptor Filter(Action + /// Alias for the action.
Index alias names support date math. + /// public AddActionDescriptor Alias(Elastic.Clients.Elasticsearch.IndexAlias? alias) { AliasValue = alias; return Self; } + /// + /// Aliases for the action.
Index alias names support date math. + /// public AddActionDescriptor Aliases(ICollection? aliases) { AliasesValue = aliases; return Self; } + /// + /// Data stream or index for the action.
Supports wildcards (`*`). + /// public AddActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { IndexValue = index; return Self; } + /// + /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// public AddActionDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? indexRouting) { IndexRoutingValue = indexRouting; return Self; } + /// + /// Data streams or indices for the action.
Supports wildcards (`*`). + /// public AddActionDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { IndicesValue = indices; return Self; } + /// + /// If `true`, the alias is hidden. + /// public AddActionDescriptor IsHidden(bool? isHidden = true) { IsHiddenValue = isHidden; return Self; } + /// + /// If `true`, sets the write index or data stream for the alias. + /// public AddActionDescriptor IsWriteIndex(bool? isWriteIndex = true) { IsWriteIndexValue = isWriteIndex; return Self; } + /// + /// If `true`, the alias must exist to perform the action. + /// public AddActionDescriptor MustExist(bool? mustExist = true) { MustExistValue = mustExist; return Self; } + /// + /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// public AddActionDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { RoutingValue = routing; return Self; } + /// + /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// public AddActionDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Routing? searchRouting) { SearchRoutingValue = searchRouting; @@ -266,6 +342,9 @@ public AddActionDescriptor() : base() private Elastic.Clients.Elasticsearch.Routing? RoutingValue { get; set; } private Elastic.Clients.Elasticsearch.Routing? SearchRoutingValue { get; set; } + /// + /// Query used to limit documents the alias can access. + /// public AddActionDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { FilterDescriptor = null; @@ -290,60 +369,90 @@ public AddActionDescriptor Filter(Action configure) return Self; } + /// + /// Alias for the action.
Index alias names support date math. + /// public AddActionDescriptor Alias(Elastic.Clients.Elasticsearch.IndexAlias? alias) { AliasValue = alias; return Self; } + /// + /// Aliases for the action.
Index alias names support date math. + /// public AddActionDescriptor Aliases(ICollection? aliases) { AliasesValue = aliases; return Self; } + /// + /// Data stream or index for the action.
Supports wildcards (`*`). + /// public AddActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { IndexValue = index; return Self; } + /// + /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations.
Data stream aliases don’t support this parameter. + /// public AddActionDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? indexRouting) { IndexRoutingValue = indexRouting; return Self; } + /// + /// Data streams or indices for the action.
Supports wildcards (`*`). + /// public AddActionDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { IndicesValue = indices; return Self; } + /// + /// If `true`, the alias is hidden. + /// public AddActionDescriptor IsHidden(bool? isHidden = true) { IsHiddenValue = isHidden; return Self; } + /// + /// If `true`, sets the write index or data stream for the alias. + /// public AddActionDescriptor IsWriteIndex(bool? isWriteIndex = true) { IsWriteIndexValue = isWriteIndex; return Self; } + /// + /// If `true`, the alias must exist to perform the action. + /// public AddActionDescriptor MustExist(bool? mustExist = true) { MustExistValue = mustExist; return Self; } + /// + /// Value used to route indexing and search operations to a specific shard.
Data stream aliases don’t support this parameter. + /// public AddActionDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { RoutingValue = routing; return Self; } + /// + /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations.
Data stream aliases don’t support this parameter. + /// public AddActionDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Routing? searchRouting) { SearchRoutingValue = searchRouting; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Alias.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Alias.g.cs index b7e090f9ea3..6e48a4487fc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Alias.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/Alias.g.cs @@ -29,16 +29,39 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class Alias { + /// + /// Query used to limit documents the alias can access. + /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; set; } + + /// + /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations. + /// [JsonInclude, JsonPropertyName("index_routing")] public Elastic.Clients.Elasticsearch.Routing? IndexRouting { get; set; } + + /// + /// If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value. + /// [JsonInclude, JsonPropertyName("is_hidden")] public bool? IsHidden { get; set; } + + /// + /// If `true`, the index is the write index for the alias. + /// [JsonInclude, JsonPropertyName("is_write_index")] public bool? IsWriteIndex { get; set; } + + /// + /// Value used to route indexing and search operations to a specific shard. + /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } + + /// + /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations. + /// [JsonInclude, JsonPropertyName("search_routing")] public Elastic.Clients.Elasticsearch.Routing? SearchRouting { get; set; } } @@ -60,6 +83,9 @@ public AliasDescriptor() : base() private Elastic.Clients.Elasticsearch.Routing? RoutingValue { get; set; } private Elastic.Clients.Elasticsearch.Routing? SearchRoutingValue { get; set; } + /// + /// Query used to limit documents the alias can access. + /// public AliasDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { FilterDescriptor = null; @@ -84,30 +110,45 @@ public AliasDescriptor Filter(Action + /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations. + /// public AliasDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? indexRouting) { IndexRoutingValue = indexRouting; return Self; } + /// + /// If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value. + /// public AliasDescriptor IsHidden(bool? isHidden = true) { IsHiddenValue = isHidden; return Self; } + /// + /// If `true`, the index is the write index for the alias. + /// public AliasDescriptor IsWriteIndex(bool? isWriteIndex = true) { IsWriteIndexValue = isWriteIndex; return Self; } + /// + /// Value used to route indexing and search operations to a specific shard. + /// public AliasDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { RoutingValue = routing; return Self; } + /// + /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations. + /// public AliasDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Routing? searchRouting) { SearchRoutingValue = searchRouting; @@ -184,6 +225,9 @@ public AliasDescriptor() : base() private Elastic.Clients.Elasticsearch.Routing? RoutingValue { get; set; } private Elastic.Clients.Elasticsearch.Routing? SearchRoutingValue { get; set; } + /// + /// Query used to limit documents the alias can access. + /// public AliasDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query? filter) { FilterDescriptor = null; @@ -208,30 +252,45 @@ public AliasDescriptor Filter(Action configure) return Self; } + /// + /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations. + /// public AliasDescriptor IndexRouting(Elastic.Clients.Elasticsearch.Routing? indexRouting) { IndexRoutingValue = indexRouting; return Self; } + /// + /// If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value. + /// public AliasDescriptor IsHidden(bool? isHidden = true) { IsHiddenValue = isHidden; return Self; } + /// + /// If `true`, the index is the write index for the alias. + /// public AliasDescriptor IsWriteIndex(bool? isWriteIndex = true) { IsWriteIndexValue = isWriteIndex; return Self; } + /// + /// Value used to route indexing and search operations to a specific shard. + /// public AliasDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { RoutingValue = routing; return Self; } + /// + /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations. + /// public AliasDescriptor SearchRouting(Elastic.Clients.Elasticsearch.Routing? searchRouting) { SearchRoutingValue = searchRouting; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AliasDefinition.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AliasDefinition.g.cs index 25ff67dc29c..1fd430bcd7e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AliasDefinition.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/AliasDefinition.g.cs @@ -29,16 +29,39 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class AliasDefinition { + /// + /// Query used to limit documents the alias can access. + /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Filter { get; init; } + + /// + /// Value used to route indexing operations to a specific shard.
If specified, this overwrites the `routing` value for indexing operations. + /// [JsonInclude, JsonPropertyName("index_routing")] public string? IndexRouting { get; init; } + + /// + /// If `true`, the alias is hidden.
All indices for the alias must have the same `is_hidden` value. + /// [JsonInclude, JsonPropertyName("is_hidden")] public bool? IsHidden { get; init; } + + /// + /// If `true`, the index is the write index for the alias. + /// [JsonInclude, JsonPropertyName("is_write_index")] public bool? IsWriteIndex { get; init; } + + /// + /// Value used to route indexing and search operations to a specific shard. + /// [JsonInclude, JsonPropertyName("routing")] public string? Routing { get; init; } + + /// + /// Value used to route search operations to a specific shard.
If specified, this overwrites the `routing` value for search operations. + /// [JsonInclude, JsonPropertyName("search_routing")] public string? SearchRouting { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataLifecycleWithRollover.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataLifecycleWithRollover.g.cs index 27259fef3c3..f8ff935a180 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataLifecycleWithRollover.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataLifecycleWithRollover.g.cs @@ -32,8 +32,15 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; /// public sealed partial class DataLifecycleWithRollover { + /// + /// If defined, every document added to this data stream will be stored at least for this time frame.
Any time after this duration the document could be deleted.
When empty, every document in this data stream will be stored indefinitely. + /// [JsonInclude, JsonPropertyName("data_retention")] public Elastic.Clients.Elasticsearch.Duration? DataRetention { get; init; } + + /// + /// The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`.
This property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true.
The contents of this field are subject to change. + /// [JsonInclude, JsonPropertyName("rollover")] public Elastic.Clients.Elasticsearch.IndexManagement.DlmRolloverConditions? Rollover { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStream.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStream.g.cs index c87adcc16fa..ee6bf105812 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStream.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStream.g.cs @@ -29,30 +29,81 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DataStream { + /// + /// Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template.
If empty, the response omits this property. + /// [JsonInclude, JsonPropertyName("_meta")] public IReadOnlyDictionary? Meta { get; init; } + + /// + /// If `true`, the data stream allows custom routing on write request. + /// [JsonInclude, JsonPropertyName("allow_custom_routing")] public bool? AllowCustomRouting { get; init; } + + /// + /// Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1. + /// [JsonInclude, JsonPropertyName("generation")] public int Generation { get; init; } + + /// + /// If `true`, the data stream is hidden. + /// [JsonInclude, JsonPropertyName("hidden")] public bool Hidden { get; init; } + + /// + /// Name of the current ILM lifecycle policy in the stream’s matching index template.
This lifecycle policy is set in the `index.lifecycle.name` setting.
If the template does not include a lifecycle policy, this property is not included in the response.
NOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API. + /// [JsonInclude, JsonPropertyName("ilm_policy")] public string? IlmPolicy { get; init; } + + /// + /// Array of objects containing information about the data stream’s backing indices.
The last item in this array contains information about the stream’s current write index. + /// [JsonInclude, JsonPropertyName("indices")] public IReadOnlyCollection Indices { get; init; } + + /// + /// Contains the configuration for the data lifecycle management of this data stream. + /// [JsonInclude, JsonPropertyName("lifecycle")] public Elastic.Clients.Elasticsearch.IndexManagement.DataLifecycleWithRollover? Lifecycle { get; init; } + + /// + /// Name of the data stream. + /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } + + /// + /// If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings. + /// [JsonInclude, JsonPropertyName("replicated")] public bool? Replicated { get; init; } + + /// + /// Health status of the data stream.
This health status is based on the state of the primary and replica shards of the stream’s backing indices. + /// [JsonInclude, JsonPropertyName("status")] public Elastic.Clients.Elasticsearch.HealthStatus Status { get; init; } + + /// + /// If `true`, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction. + /// [JsonInclude, JsonPropertyName("system")] public bool? System { get; init; } + + /// + /// Name of the index template used to create the data stream’s backing indices.
The template’s index pattern must match the name of this data stream. + /// [JsonInclude, JsonPropertyName("template")] public string Template { get; init; } + + /// + /// Information about the `@timestamp` field in the data stream. + /// [JsonInclude, JsonPropertyName("timestamp_field")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamTimestampField TimestampField { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamIndex.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamIndex.g.cs index ccc71af0e35..45a6fc8ef89 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamIndex.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamIndex.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DataStreamIndex { + /// + /// Name of the backing index. + /// [JsonInclude, JsonPropertyName("index_name")] public string IndexName { get; init; } + + /// + /// Universally unique identifier (UUID) for the index. + /// [JsonInclude, JsonPropertyName("index_uuid")] public string IndexUuid { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamTimestampField.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamTimestampField.g.cs index 2532cf47379..137127633b8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamTimestampField.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamTimestampField.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DataStreamTimestampField { + /// + /// Name of the timestamp field for the data stream, which must be `@timestamp`. The `@timestamp` field must be included in every document indexed to the data stream. + /// [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexState.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexState.g.cs index 2a0bd20137b..d7a505e9843 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexState.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexState.g.cs @@ -41,7 +41,7 @@ public sealed partial class IndexState public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? Defaults { get; set; } /// - /// Data lifecycle applicable iff this is a data stream. + /// Data lifecycle applicable if this is a data stream. /// [JsonInclude, JsonPropertyName("lifecycle")] public Elastic.Clients.Elasticsearch.IndexManagement.DataLifecycle? Lifecycle { get; set; } @@ -162,7 +162,7 @@ public IndexStateDescriptor DataStream(Elastic.Clients.Elasticsearch. } /// - /// Data lifecycle applicable iff this is a data stream. + /// Data lifecycle applicable if this is a data stream. /// public IndexStateDescriptor Lifecycle(Elastic.Clients.Elasticsearch.IndexManagement.DataLifecycle? lifecycle) { @@ -382,7 +382,7 @@ public IndexStateDescriptor DataStream(Elastic.Clients.Elasticsearch.DataStreamN } /// - /// Data lifecycle applicable iff this is a data stream. + /// Data lifecycle applicable if this is a data stream. /// public IndexStateDescriptor Lifecycle(Elastic.Clients.Elasticsearch.IndexManagement.DataLifecycle? lifecycle) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplate.g.cs index 94476e1ab53..edda6535e03 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplate.g.cs @@ -29,20 +29,47 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class IndexTemplate { + /// + /// Optional user metadata about the index template. May have any contents.
This map is not automatically generated by Elasticsearch. + /// [JsonInclude, JsonPropertyName("_meta")] public IReadOnlyDictionary? Meta { get; init; } [JsonInclude, JsonPropertyName("allow_auto_create")] public bool? AllowAutoCreate { get; init; } + + /// + /// An ordered list of component template names.
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + /// [JsonInclude, JsonPropertyName("composed_of")] public IReadOnlyCollection ComposedOf { get; init; } + + /// + /// If this object is included, the template is used to create data streams and their backing indices.
Supports an empty object.
Data streams require a matching index template with a `data_stream` object. + /// [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateDataStreamConfiguration? DataStream { get; init; } + + /// + /// Name of the index template. + /// [JsonInclude, JsonPropertyName("index_patterns")] public IReadOnlyCollection IndexPatterns { get; init; } + + /// + /// Priority to determine index template precedence when a new data stream or index is created.
The index template with the highest priority is chosen.
If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
This number is not automatically generated by Elasticsearch. + /// [JsonInclude, JsonPropertyName("priority")] public long? Priority { get; init; } + + /// + /// Template to be applied.
It may optionally include an `aliases`, `mappings`, or `settings` configuration. + /// [JsonInclude, JsonPropertyName("template")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateSummary? Template { get; init; } + + /// + /// Version number used to manage index templates externally.
This number is not automatically generated by Elasticsearch. + /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateMapping.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateMapping.g.cs index 6dffac5514f..938aaaf6b26 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateMapping.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateMapping.g.cs @@ -29,12 +29,23 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class IndexTemplateMapping { + /// + /// Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + /// [JsonInclude, JsonPropertyName("aliases")] public IDictionary? Aliases { get; set; } [JsonInclude, JsonPropertyName("lifecycle")] public Elastic.Clients.Elasticsearch.IndexManagement.DataLifecycle? Lifecycle { get; set; } + + /// + /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping parameters. + /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Mapping.TypeMapping? Mappings { get; set; } + + /// + /// Configuration options for the index. + /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? Settings { get; set; } } @@ -58,6 +69,9 @@ public IndexTemplateMappingDescriptor() : base() private DataLifecycleDescriptor LifecycleDescriptor { get; set; } private Action LifecycleDescriptorAction { get; set; } + /// + /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping parameters. + /// public IndexTemplateMappingDescriptor Mappings(Elastic.Clients.Elasticsearch.Mapping.TypeMapping? mappings) { MappingsDescriptor = null; @@ -82,6 +96,9 @@ public IndexTemplateMappingDescriptor Mappings(Action + /// Configuration options for the index. + /// public IndexTemplateMappingDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? settings) { SettingsDescriptor = null; @@ -106,6 +123,9 @@ public IndexTemplateMappingDescriptor Settings(Action + /// Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + /// public IndexTemplateMappingDescriptor Aliases(Func, FluentDictionary> selector) { AliasesValue = selector?.Invoke(new FluentDictionary()); @@ -216,6 +236,9 @@ public IndexTemplateMappingDescriptor() : base() private DataLifecycleDescriptor LifecycleDescriptor { get; set; } private Action LifecycleDescriptorAction { get; set; } + /// + /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping parameters. + /// public IndexTemplateMappingDescriptor Mappings(Elastic.Clients.Elasticsearch.Mapping.TypeMapping? mappings) { MappingsDescriptor = null; @@ -240,6 +263,9 @@ public IndexTemplateMappingDescriptor Mappings(Action + /// Configuration options for the index. + /// public IndexTemplateMappingDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? settings) { SettingsDescriptor = null; @@ -264,6 +290,9 @@ public IndexTemplateMappingDescriptor Settings(Action c return Self; } + /// + /// Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + /// public IndexTemplateMappingDescriptor Aliases(Func, FluentDictionary> selector) { AliasesValue = selector?.Invoke(new FluentDictionary()); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateSummary.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateSummary.g.cs index aee201510ea..f4e34d3c92a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplateSummary.g.cs @@ -29,13 +29,24 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class IndexTemplateSummary { + /// + /// Aliases to add.
If the index template includes a `data_stream` object, these are data stream aliases.
Otherwise, these are index aliases.
Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + /// [JsonInclude, JsonPropertyName("aliases")] [ReadOnlyIndexNameDictionaryConverter(typeof(Elastic.Clients.Elasticsearch.IndexManagement.Alias))] public IReadOnlyDictionary? Aliases { get; init; } [JsonInclude, JsonPropertyName("lifecycle")] public Elastic.Clients.Elasticsearch.IndexManagement.DataLifecycleWithRollover? Lifecycle { get; init; } + + /// + /// Mapping for fields in the index.
If specified, this mapping can include field names, field data types, and mapping parameters. + /// [JsonInclude, JsonPropertyName("mappings")] public Elastic.Clients.Elasticsearch.Mapping.TypeMapping? Mappings { get; init; } + + /// + /// Configuration options for the index. + /// [JsonInclude, JsonPropertyName("settings")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? Settings { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveAction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveAction.g.cs index 496c5795a5d..14a88551964 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveAction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveAction.g.cs @@ -29,14 +29,33 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class RemoveAction { + /// + /// Alias for the action.
Index alias names support date math. + /// [JsonInclude, JsonPropertyName("alias")] public Elastic.Clients.Elasticsearch.IndexAlias? Alias { get; set; } + + /// + /// Aliases for the action.
Index alias names support date math. + /// [JsonInclude, JsonPropertyName("aliases"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.IndexAlias))] public ICollection? Aliases { get; set; } + + /// + /// Data stream or index for the action.
Supports wildcards (`*`). + /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } + + /// + /// Data streams or indices for the action.
Supports wildcards (`*`). + /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Indices? Indices { get; set; } + + /// + /// If `true`, the alias must exist to perform the action. + /// [JsonInclude, JsonPropertyName("must_exist")] public bool? MustExist { get; set; } @@ -57,30 +76,45 @@ public RemoveActionDescriptor() : base() private Elastic.Clients.Elasticsearch.Indices? IndicesValue { get; set; } private bool? MustExistValue { get; set; } + /// + /// Alias for the action.
Index alias names support date math. + /// public RemoveActionDescriptor Alias(Elastic.Clients.Elasticsearch.IndexAlias? alias) { AliasValue = alias; return Self; } + /// + /// Aliases for the action.
Index alias names support date math. + /// public RemoveActionDescriptor Aliases(ICollection? aliases) { AliasesValue = aliases; return Self; } + /// + /// Data stream or index for the action.
Supports wildcards (`*`). + /// public RemoveActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { IndexValue = index; return Self; } + /// + /// Data streams or indices for the action.
Supports wildcards (`*`). + /// public RemoveActionDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { IndicesValue = indices; return Self; } + /// + /// If `true`, the alias must exist to perform the action. + /// public RemoveActionDescriptor MustExist(bool? mustExist = true) { MustExistValue = mustExist; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveIndexAction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveIndexAction.g.cs index 0e23ad8dac4..149a252f99a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveIndexAction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/RemoveIndexAction.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class RemoveIndexAction { + /// + /// Data stream or index for the action.
Supports wildcards (`*`). + /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } + + /// + /// Data streams or indices for the action.
Supports wildcards (`*`). + /// [JsonInclude, JsonPropertyName("indices")] public Elastic.Clients.Elasticsearch.Indices? Indices { get; set; } + + /// + /// If `true`, the alias must exist to perform the action. + /// [JsonInclude, JsonPropertyName("must_exist")] public bool? MustExist { get; set; } @@ -51,18 +62,27 @@ public RemoveIndexActionDescriptor() : base() private Elastic.Clients.Elasticsearch.Indices? IndicesValue { get; set; } private bool? MustExistValue { get; set; } + /// + /// Data stream or index for the action.
Supports wildcards (`*`). + /// public RemoveIndexActionDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { IndexValue = index; return Self; } + /// + /// Data streams or indices for the action.
Supports wildcards (`*`). + /// public RemoveIndexActionDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { IndicesValue = indices; return Self; } + /// + /// If `true`, the alias must exist to perform the action. + /// public RemoveIndexActionDescriptor MustExist(bool? mustExist = true) { MustExistValue = mustExist; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AppendProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AppendProcessor.g.cs index 1da1c8b49f4..2b6c37aec2f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AppendProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AppendProcessor.g.cs @@ -29,10 +29,17 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class AppendProcessor { + /// + /// If `false`, the processor does not append values already present in the field. + /// [JsonInclude, JsonPropertyName("allow_duplicates")] public bool? AllowDuplicates { get; set; } [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to be appended to.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] @@ -43,6 +50,10 @@ public sealed partial class AppendProcessor public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The value to be appended. Supports template snippets. + /// [JsonInclude, JsonPropertyName("value")] public ICollection Value { get; set; } @@ -105,6 +116,9 @@ public AppendProcessorDescriptor OnFailure(params Action + /// If `false`, the processor does not append values already present in the field. + /// public AppendProcessorDescriptor AllowDuplicates(bool? allowDuplicates = true) { AllowDuplicatesValue = allowDuplicates; @@ -117,12 +131,18 @@ public AppendProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to be appended to.
Supports template snippets. + /// public AppendProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to be appended to.
Supports template snippets. + /// public AppendProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -147,6 +167,9 @@ public AppendProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The value to be appended. Supports template snippets. + /// public AppendProcessorDescriptor Value(ICollection value) { ValueValue = value; @@ -281,6 +304,9 @@ public AppendProcessorDescriptor OnFailure(params Action[] return Self; } + /// + /// If `false`, the processor does not append values already present in the field. + /// public AppendProcessorDescriptor AllowDuplicates(bool? allowDuplicates = true) { AllowDuplicatesValue = allowDuplicates; @@ -293,18 +319,27 @@ public AppendProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to be appended to.
Supports template snippets. + /// public AppendProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to be appended to.
Supports template snippets. + /// public AppendProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to be appended to.
Supports template snippets. + /// public AppendProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -329,6 +364,9 @@ public AppendProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The value to be appended. Supports template snippets. + /// public AppendProcessorDescriptor Value(ICollection value) { ValueValue = value; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AttachmentProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AttachmentProcessor.g.cs index 53d2844d66e..3fd43491d7a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AttachmentProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/AttachmentProcessor.g.cs @@ -31,26 +31,54 @@ public sealed partial class AttachmentProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to get the base64 encoded field from. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and field does not exist, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } + + /// + /// The number of chars being used for extraction to prevent huge fields.
Use `-1` for no limit. + /// [JsonInclude, JsonPropertyName("indexed_chars")] public long? IndexedChars { get; set; } + + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// [JsonInclude, JsonPropertyName("indexed_chars_field")] public Elastic.Clients.Elasticsearch.Field? IndexedCharsField { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// Array of properties to select to be stored.
Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. + /// [JsonInclude, JsonPropertyName("properties")] public ICollection? Properties { get; set; } + + /// + /// Field containing the name of the resource to decode.
If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// [JsonInclude, JsonPropertyName("resource_name")] public string? ResourceName { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field that will hold the attachment information. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -123,12 +151,18 @@ public AttachmentProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to get the base64 encoded field from. + /// public AttachmentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to get the base64 encoded field from. + /// public AttachmentProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -147,36 +181,54 @@ public AttachmentProcessorDescriptor IgnoreFailure(bool? ignoreFailur return Self; } + /// + /// If `true` and field does not exist, the processor quietly exits without modifying the document. + /// public AttachmentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// The number of chars being used for extraction to prevent huge fields.
Use `-1` for no limit. + /// public AttachmentProcessorDescriptor IndexedChars(long? indexedChars) { IndexedCharsValue = indexedChars; return Self; } + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// public AttachmentProcessorDescriptor IndexedCharsField(Elastic.Clients.Elasticsearch.Field? indexedCharsField) { IndexedCharsFieldValue = indexedCharsField; return Self; } + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// public AttachmentProcessorDescriptor IndexedCharsField(Expression> indexedCharsField) { IndexedCharsFieldValue = indexedCharsField; return Self; } + /// + /// Array of properties to select to be stored.
Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. + /// public AttachmentProcessorDescriptor Properties(ICollection? properties) { PropertiesValue = properties; return Self; } + /// + /// Field containing the name of the resource to decode.
If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// public AttachmentProcessorDescriptor ResourceName(string? resourceName) { ResourceNameValue = resourceName; @@ -189,12 +241,18 @@ public AttachmentProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field that will hold the attachment information. + /// public AttachmentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that will hold the attachment information. + /// public AttachmentProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -367,18 +425,27 @@ public AttachmentProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to get the base64 encoded field from. + /// public AttachmentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to get the base64 encoded field from. + /// public AttachmentProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to get the base64 encoded field from. + /// public AttachmentProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -397,42 +464,63 @@ public AttachmentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and field does not exist, the processor quietly exits without modifying the document. + /// public AttachmentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// The number of chars being used for extraction to prevent huge fields.
Use `-1` for no limit. + /// public AttachmentProcessorDescriptor IndexedChars(long? indexedChars) { IndexedCharsValue = indexedChars; return Self; } + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// public AttachmentProcessorDescriptor IndexedCharsField(Elastic.Clients.Elasticsearch.Field? indexedCharsField) { IndexedCharsFieldValue = indexedCharsField; return Self; } + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// public AttachmentProcessorDescriptor IndexedCharsField(Expression> indexedCharsField) { IndexedCharsFieldValue = indexedCharsField; return Self; } + /// + /// Field name from which you can overwrite the number of chars being used for extraction. + /// public AttachmentProcessorDescriptor IndexedCharsField(Expression> indexedCharsField) { IndexedCharsFieldValue = indexedCharsField; return Self; } + /// + /// Array of properties to select to be stored.
Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. + /// public AttachmentProcessorDescriptor Properties(ICollection? properties) { PropertiesValue = properties; return Self; } + /// + /// Field containing the name of the resource to decode.
If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + /// public AttachmentProcessorDescriptor ResourceName(string? resourceName) { ResourceNameValue = resourceName; @@ -445,18 +533,27 @@ public AttachmentProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field that will hold the attachment information. + /// public AttachmentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that will hold the attachment information. + /// public AttachmentProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that will hold the attachment information. + /// public AttachmentProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/BytesProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/BytesProcessor.g.cs index 4d5cdae8f05..0ec15628140 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/BytesProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/BytesProcessor.g.cs @@ -31,18 +31,30 @@ public sealed partial class BytesProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to convert. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -111,12 +123,18 @@ public BytesProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to convert. + /// public BytesProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to convert. + /// public BytesProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -135,6 +153,9 @@ public BytesProcessorDescriptor IgnoreFailure(bool? ignoreFailure = t return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public BytesProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -147,12 +168,18 @@ public BytesProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public BytesProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public BytesProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -297,18 +324,27 @@ public BytesProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to convert. + /// public BytesProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to convert. + /// public BytesProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to convert. + /// public BytesProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -327,6 +363,9 @@ public BytesProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public BytesProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -339,18 +378,27 @@ public BytesProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public BytesProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public BytesProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public BytesProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CircleProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CircleProcessor.g.cs index 9804fce8410..f41c17945f8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CircleProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CircleProcessor.g.cs @@ -31,22 +31,42 @@ public sealed partial class CircleProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + /// [JsonInclude, JsonPropertyName("error_distance")] public double ErrorDistance { get; set; } + + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`. + /// [JsonInclude, JsonPropertyName("shape_type")] public Elastic.Clients.Elasticsearch.Ingest.ShapeType ShapeType { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -117,18 +137,27 @@ public CircleProcessorDescriptor Description(string? description) return Self; } + /// + /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + /// public CircleProcessorDescriptor ErrorDistance(double errorDistance) { ErrorDistanceValue = errorDistance; return Self; } + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// public CircleProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// public CircleProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -147,12 +176,18 @@ public CircleProcessorDescriptor IgnoreFailure(bool? ignoreFailure = return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public CircleProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`. + /// public CircleProcessorDescriptor ShapeType(Elastic.Clients.Elasticsearch.Ingest.ShapeType shapeType) { ShapeTypeValue = shapeType; @@ -165,12 +200,18 @@ public CircleProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// public CircleProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// public CircleProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -321,24 +362,36 @@ public CircleProcessorDescriptor Description(string? description) return Self; } + /// + /// The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + /// public CircleProcessorDescriptor ErrorDistance(double errorDistance) { ErrorDistanceValue = errorDistance; return Self; } + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// public CircleProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// public CircleProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. + /// public CircleProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -357,12 +410,18 @@ public CircleProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public CircleProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`. + /// public CircleProcessorDescriptor ShapeType(Elastic.Clients.Elasticsearch.Ingest.ShapeType shapeType) { ShapeTypeValue = shapeType; @@ -375,18 +434,27 @@ public CircleProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// public CircleProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// public CircleProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the polygon shape to
By default, the field is updated in-place. + /// public CircleProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ConvertProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ConvertProcessor.g.cs index 596f124672b..9c96e396652 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ConvertProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ConvertProcessor.g.cs @@ -31,20 +31,36 @@ public sealed partial class ConvertProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field whose value is to be converted. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } + + /// + /// The type to convert the existing value to. + /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.Ingest.ConvertType Type { get; set; } @@ -114,12 +130,18 @@ public ConvertProcessorDescriptor Description(string? description) return Self; } + /// + /// The field whose value is to be converted. + /// public ConvertProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field whose value is to be converted. + /// public ConvertProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -138,6 +160,9 @@ public ConvertProcessorDescriptor IgnoreFailure(bool? ignoreFailure = return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public ConvertProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -150,18 +175,27 @@ public ConvertProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// public ConvertProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// public ConvertProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The type to convert the existing value to. + /// public ConvertProcessorDescriptor Type(Elastic.Clients.Elasticsearch.Ingest.ConvertType type) { TypeValue = type; @@ -309,18 +343,27 @@ public ConvertProcessorDescriptor Description(string? description) return Self; } + /// + /// The field whose value is to be converted. + /// public ConvertProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field whose value is to be converted. + /// public ConvertProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field whose value is to be converted. + /// public ConvertProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -339,6 +382,9 @@ public ConvertProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public ConvertProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -351,24 +397,36 @@ public ConvertProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// public ConvertProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// public ConvertProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the `field` is updated in-place. + /// public ConvertProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The type to convert the existing value to. + /// public ConvertProcessorDescriptor Type(Elastic.Clients.Elasticsearch.Ingest.ConvertType type) { TypeValue = type; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CsvProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CsvProcessor.g.cs index 03198cc9a2c..822929e3c32 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CsvProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/CsvProcessor.g.cs @@ -31,26 +31,54 @@ public sealed partial class CsvProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// Value used to fill empty fields.
Empty fields are skipped if this is not provided.
An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). + /// [JsonInclude, JsonPropertyName("empty_value")] public object? EmptyValue { get; set; } + + /// + /// The field to extract data from. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// Quote used in CSV, has to be single character string. + /// [JsonInclude, JsonPropertyName("quote")] public string? Quote { get; set; } + + /// + /// Separator used in CSV, has to be single character string. + /// [JsonInclude, JsonPropertyName("separator")] public string? Separator { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The array of fields to assign extracted values to. + /// [JsonInclude, JsonPropertyName("target_fields")] public Elastic.Clients.Elasticsearch.Fields TargetFields { get; set; } + + /// + /// Trim whitespaces in unquoted fields. + /// [JsonInclude, JsonPropertyName("trim")] public bool? Trim { get; set; } @@ -123,18 +151,27 @@ public CsvProcessorDescriptor Description(string? description) return Self; } + /// + /// Value used to fill empty fields.
Empty fields are skipped if this is not provided.
An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). + /// public CsvProcessorDescriptor EmptyValue(object? emptyValue) { EmptyValueValue = emptyValue; return Self; } + /// + /// The field to extract data from. + /// public CsvProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to extract data from. + /// public CsvProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -153,18 +190,27 @@ public CsvProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tru return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public CsvProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// Quote used in CSV, has to be single character string. + /// public CsvProcessorDescriptor Quote(string? quote) { QuoteValue = quote; return Self; } + /// + /// Separator used in CSV, has to be single character string. + /// public CsvProcessorDescriptor Separator(string? separator) { SeparatorValue = separator; @@ -177,12 +223,18 @@ public CsvProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The array of fields to assign extracted values to. + /// public CsvProcessorDescriptor TargetFields(Elastic.Clients.Elasticsearch.Fields targetFields) { TargetFieldsValue = targetFields; return Self; } + /// + /// Trim whitespaces in unquoted fields. + /// public CsvProcessorDescriptor Trim(bool? trim = true) { TrimValue = trim; @@ -351,24 +403,36 @@ public CsvProcessorDescriptor Description(string? description) return Self; } + /// + /// Value used to fill empty fields.
Empty fields are skipped if this is not provided.
An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). + /// public CsvProcessorDescriptor EmptyValue(object? emptyValue) { EmptyValueValue = emptyValue; return Self; } + /// + /// The field to extract data from. + /// public CsvProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to extract data from. + /// public CsvProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to extract data from. + /// public CsvProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -387,18 +451,27 @@ public CsvProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public CsvProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// Quote used in CSV, has to be single character string. + /// public CsvProcessorDescriptor Quote(string? quote) { QuoteValue = quote; return Self; } + /// + /// Separator used in CSV, has to be single character string. + /// public CsvProcessorDescriptor Separator(string? separator) { SeparatorValue = separator; @@ -411,12 +484,18 @@ public CsvProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The array of fields to assign extracted values to. + /// public CsvProcessorDescriptor TargetFields(Elastic.Clients.Elasticsearch.Fields targetFields) { TargetFieldsValue = targetFields; return Self; } + /// + /// Trim whitespaces in unquoted fields. + /// public CsvProcessorDescriptor Trim(bool? trim = true) { TrimValue = trim; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateIndexNameProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateIndexNameProcessor.g.cs index 608be84a75c..2b8cc759589 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateIndexNameProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateIndexNameProcessor.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class DateIndexNameProcessor { + /// + /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// [JsonInclude, JsonPropertyName("date_formats")] public ICollection DateFormats { get; set; } @@ -39,22 +42,42 @@ public sealed partial class DateIndexNameProcessor public string DateRounding { get; set; } [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to get the date or timestamp from. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// The format to be used when printing the parsed date into the index name.
A valid java time pattern is expected here.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("index_name_format")] public string? IndexNameFormat { get; set; } + + /// + /// A prefix of the index name to be prepended before the printed date.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("index_name_prefix")] public string? IndexNamePrefix { get; set; } + + /// + /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// [JsonInclude, JsonPropertyName("locale")] public string? Locale { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// [JsonInclude, JsonPropertyName("timezone")] public string? Timezone { get; set; } @@ -121,6 +144,9 @@ public DateIndexNameProcessorDescriptor OnFailure(params Action + /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// public DateIndexNameProcessorDescriptor DateFormats(ICollection dateFormats) { DateFormatsValue = dateFormats; @@ -142,12 +168,18 @@ public DateIndexNameProcessorDescriptor Description(string? descripti return Self; } + /// + /// The field to get the date or timestamp from. + /// public DateIndexNameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to get the date or timestamp from. + /// public DateIndexNameProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -166,18 +198,27 @@ public DateIndexNameProcessorDescriptor IgnoreFailure(bool? ignoreFai return Self; } + /// + /// The format to be used when printing the parsed date into the index name.
A valid java time pattern is expected here.
Supports template snippets. + /// public DateIndexNameProcessorDescriptor IndexNameFormat(string? indexNameFormat) { IndexNameFormatValue = indexNameFormat; return Self; } + /// + /// A prefix of the index name to be prepended before the printed date.
Supports template snippets. + /// public DateIndexNameProcessorDescriptor IndexNamePrefix(string? indexNamePrefix) { IndexNamePrefixValue = indexNamePrefix; return Self; } + /// + /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// public DateIndexNameProcessorDescriptor Locale(string? locale) { LocaleValue = locale; @@ -190,6 +231,9 @@ public DateIndexNameProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// public DateIndexNameProcessorDescriptor Timezone(string? timezone) { TimezoneValue = timezone; @@ -348,6 +392,9 @@ public DateIndexNameProcessorDescriptor OnFailure(params Action + /// An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// public DateIndexNameProcessorDescriptor DateFormats(ICollection dateFormats) { DateFormatsValue = dateFormats; @@ -369,18 +416,27 @@ public DateIndexNameProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to get the date or timestamp from. + /// public DateIndexNameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to get the date or timestamp from. + /// public DateIndexNameProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to get the date or timestamp from. + /// public DateIndexNameProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -399,18 +455,27 @@ public DateIndexNameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true return Self; } + /// + /// The format to be used when printing the parsed date into the index name.
A valid java time pattern is expected here.
Supports template snippets. + /// public DateIndexNameProcessorDescriptor IndexNameFormat(string? indexNameFormat) { IndexNameFormatValue = indexNameFormat; return Self; } + /// + /// A prefix of the index name to be prepended before the printed date.
Supports template snippets. + /// public DateIndexNameProcessorDescriptor IndexNamePrefix(string? indexNamePrefix) { IndexNamePrefixValue = indexNamePrefix; return Self; } + /// + /// The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + /// public DateIndexNameProcessorDescriptor Locale(string? locale) { LocaleValue = locale; @@ -423,6 +488,9 @@ public DateIndexNameProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + /// public DateIndexNameProcessorDescriptor Timezone(string? timezone) { TimezoneValue = timezone; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateProcessor.g.cs index c2b49c2f4f1..cc660104868 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DateProcessor.g.cs @@ -31,22 +31,42 @@ public sealed partial class DateProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to get the date from. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } + + /// + /// An array of the expected date formats.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// [JsonInclude, JsonPropertyName("formats")] public ICollection Formats { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// The locale to use when parsing the date, relevant when parsing month names or week days.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("locale")] public string? Locale { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field that will hold the parsed date. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } + + /// + /// The timezone to use when parsing the date.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("timezone")] public string? Timezone { get; set; } @@ -117,18 +137,27 @@ public DateProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to get the date from. + /// public DateProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to get the date from. + /// public DateProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// An array of the expected date formats.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// public DateProcessorDescriptor Formats(ICollection formats) { FormatsValue = formats; @@ -147,6 +176,9 @@ public DateProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr return Self; } + /// + /// The locale to use when parsing the date, relevant when parsing month names or week days.
Supports template snippets. + /// public DateProcessorDescriptor Locale(string? locale) { LocaleValue = locale; @@ -159,18 +191,27 @@ public DateProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field that will hold the parsed date. + /// public DateProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that will hold the parsed date. + /// public DateProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The timezone to use when parsing the date.
Supports template snippets. + /// public DateProcessorDescriptor Timezone(string? timezone) { TimezoneValue = timezone; @@ -325,24 +366,36 @@ public DateProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to get the date from. + /// public DateProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to get the date from. + /// public DateProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to get the date from. + /// public DateProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// An array of the expected date formats.
Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + /// public DateProcessorDescriptor Formats(ICollection formats) { FormatsValue = formats; @@ -361,6 +414,9 @@ public DateProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// The locale to use when parsing the date, relevant when parsing month names or week days.
Supports template snippets. + /// public DateProcessorDescriptor Locale(string? locale) { LocaleValue = locale; @@ -373,24 +429,36 @@ public DateProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field that will hold the parsed date. + /// public DateProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that will hold the parsed date. + /// public DateProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that will hold the parsed date. + /// public DateProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The timezone to use when parsing the date.
Supports template snippets. + /// public DateProcessorDescriptor Timezone(string? timezone) { TimezoneValue = timezone; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DissectProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DissectProcessor.g.cs index fd9eeb635bb..b4164216f18 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DissectProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DissectProcessor.g.cs @@ -29,20 +29,35 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class DissectProcessor { + /// + /// The character(s) that separate the appended fields. + /// [JsonInclude, JsonPropertyName("append_separator")] public string? AppendSeparator { get; set; } [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to dissect. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// The pattern to apply to the field. + /// [JsonInclude, JsonPropertyName("pattern")] public string Pattern { get; set; } [JsonInclude, JsonPropertyName("tag")] @@ -108,6 +123,9 @@ public DissectProcessorDescriptor OnFailure(params Action + /// The character(s) that separate the appended fields. + /// public DissectProcessorDescriptor AppendSeparator(string? appendSeparator) { AppendSeparatorValue = appendSeparator; @@ -120,12 +138,18 @@ public DissectProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to dissect. + /// public DissectProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to dissect. + /// public DissectProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -144,12 +168,18 @@ public DissectProcessorDescriptor IgnoreFailure(bool? ignoreFailure = return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public DissectProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// The pattern to apply to the field. + /// public DissectProcessorDescriptor Pattern(string pattern) { PatternValue = pattern; @@ -297,6 +327,9 @@ public DissectProcessorDescriptor OnFailure(params Action[] return Self; } + /// + /// The character(s) that separate the appended fields. + /// public DissectProcessorDescriptor AppendSeparator(string? appendSeparator) { AppendSeparatorValue = appendSeparator; @@ -309,18 +342,27 @@ public DissectProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to dissect. + /// public DissectProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to dissect. + /// public DissectProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to dissect. + /// public DissectProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -339,12 +381,18 @@ public DissectProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public DissectProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// The pattern to apply to the field. + /// public DissectProcessorDescriptor Pattern(string pattern) { PatternValue = pattern; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Document.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Document.g.cs index d249e5cca4e..33ace55d86c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Document.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Document.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class Document { + /// + /// Unique identifier for the document.
This ID must be unique within the `_index`. + /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } + + /// + /// Name of the index containing the document. + /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } + + /// + /// JSON body for the document. + /// [JsonInclude, JsonPropertyName("_source")] public object Source { get; set; } } @@ -49,18 +60,27 @@ public DocumentDescriptor() : base() private Elastic.Clients.Elasticsearch.IndexName? IndexValue { get; set; } private object SourceValue { get; set; } + /// + /// Unique identifier for the document.
This ID must be unique within the `_index`. + /// public DocumentDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { IdValue = id; return Self; } + /// + /// Name of the index containing the document. + /// public DocumentDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { IndexValue = index; return Self; } + /// + /// JSON body for the document. + /// public DocumentDescriptor Source(object source) { SourceValue = source; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DocumentSimulation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DocumentSimulation.g.cs index 74f47bda052..a920632745d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DocumentSimulation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DocumentSimulation.g.cs @@ -109,10 +109,25 @@ public override void Write(Utf8JsonWriter writer, DocumentSimulation value, Json /// public sealed partial class DocumentSimulation { + /// + /// Unique identifier for the document. This ID must be unique within the `_index`. + /// public string Id { get; init; } + + /// + /// Name of the index containing the document. + /// public string Index { get; init; } public Elastic.Clients.Elasticsearch.Ingest.IngestInfo Ingest { get; init; } + + /// + /// Value used to send the document to a specific primary shard. + /// public string? Routing { get; init; } + + /// + /// JSON body for the document. + /// public IReadOnlyDictionary Source { get; init; } [JsonConverter(typeof(StringifiedLongConverter))] public long? Version { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DotExpanderProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DotExpanderProcessor.g.cs index c584f4949bb..dc7544cd246 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DotExpanderProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DotExpanderProcessor.g.cs @@ -31,6 +31,10 @@ public sealed partial class DotExpanderProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] @@ -39,6 +43,10 @@ public sealed partial class DotExpanderProcessor public bool? IgnoreFailure { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// The field that contains the field to expand.
Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. + /// [JsonInclude, JsonPropertyName("path")] public string? Path { get; set; } [JsonInclude, JsonPropertyName("tag")] @@ -108,12 +116,18 @@ public DotExpanderProcessorDescriptor Description(string? description return Self; } + /// + /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// public DotExpanderProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// public DotExpanderProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -132,6 +146,9 @@ public DotExpanderProcessorDescriptor IgnoreFailure(bool? ignoreFailu return Self; } + /// + /// The field that contains the field to expand.
Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. + /// public DotExpanderProcessorDescriptor Path(string? path) { PathValue = path; @@ -275,18 +292,27 @@ public DotExpanderProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// public DotExpanderProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// public DotExpanderProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to expand into an object field.
If set to `*`, all top-level fields will be expanded. + /// public DotExpanderProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -305,6 +331,9 @@ public DotExpanderProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// The field that contains the field to expand.
Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. + /// public DotExpanderProcessorDescriptor Path(string? path) { PathValue = path; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/EnrichProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/EnrichProcessor.g.cs index 3eecae42646..95d63f90eb3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/EnrichProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/EnrichProcessor.g.cs @@ -31,26 +31,54 @@ public sealed partial class EnrichProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } + + /// + /// The maximum number of matched documents to include under the configured target field.
The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.
In order to avoid documents getting too large, the maximum allowed value is 128. + /// [JsonInclude, JsonPropertyName("max_matches")] public int? MaxMatches { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// If processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// [JsonInclude, JsonPropertyName("override")] public bool? Override { get; set; } + + /// + /// The name of the enrich policy to use. + /// [JsonInclude, JsonPropertyName("policy_name")] public string PolicyName { get; set; } + + /// + /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.
This option is only used for `geo_match` enrich policy types. + /// [JsonInclude, JsonPropertyName("shape_relation")] public Elastic.Clients.Elasticsearch.GeoShapeRelation? ShapeRelation { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field TargetField { get; set; } @@ -123,12 +151,18 @@ public EnrichProcessorDescriptor Description(string? description) return Self; } + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// public EnrichProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// public EnrichProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -147,30 +181,45 @@ public EnrichProcessorDescriptor IgnoreFailure(bool? ignoreFailure = return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public EnrichProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// The maximum number of matched documents to include under the configured target field.
The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.
In order to avoid documents getting too large, the maximum allowed value is 128. + /// public EnrichProcessorDescriptor MaxMatches(int? maxMatches) { MaxMatchesValue = maxMatches; return Self; } + /// + /// If processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// public EnrichProcessorDescriptor Override(bool? overrideValue = true) { OverrideValue = overrideValue; return Self; } + /// + /// The name of the enrich policy to use. + /// public EnrichProcessorDescriptor PolicyName(string policyName) { PolicyNameValue = policyName; return Self; } + /// + /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.
This option is only used for `geo_match` enrich policy types. + /// public EnrichProcessorDescriptor ShapeRelation(Elastic.Clients.Elasticsearch.GeoShapeRelation? shapeRelation) { ShapeRelationValue = shapeRelation; @@ -183,12 +232,18 @@ public EnrichProcessorDescriptor Tag(string? tag) return Self; } + /// + /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// public EnrichProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field targetField) { TargetFieldValue = targetField; return Self; } + /// + /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// public EnrichProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -353,18 +408,27 @@ public EnrichProcessorDescriptor Description(string? description) return Self; } + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// public EnrichProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// public EnrichProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field in the input document that matches the policies match_field used to retrieve the enrichment data.
Supports template snippets. + /// public EnrichProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -383,30 +447,45 @@ public EnrichProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public EnrichProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// The maximum number of matched documents to include under the configured target field.
The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object.
In order to avoid documents getting too large, the maximum allowed value is 128. + /// public EnrichProcessorDescriptor MaxMatches(int? maxMatches) { MaxMatchesValue = maxMatches; return Self; } + /// + /// If processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// public EnrichProcessorDescriptor Override(bool? overrideValue = true) { OverrideValue = overrideValue; return Self; } + /// + /// The name of the enrich policy to use. + /// public EnrichProcessorDescriptor PolicyName(string policyName) { PolicyNameValue = policyName; return Self; } + /// + /// A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.
This option is only used for `geo_match` enrich policy types. + /// public EnrichProcessorDescriptor ShapeRelation(Elastic.Clients.Elasticsearch.GeoShapeRelation? shapeRelation) { ShapeRelationValue = shapeRelation; @@ -419,18 +498,27 @@ public EnrichProcessorDescriptor Tag(string? tag) return Self; } + /// + /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// public EnrichProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field targetField) { TargetFieldValue = targetField; return Self; } + /// + /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// public EnrichProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy.
Supports template snippets. + /// public EnrichProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/FailProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/FailProcessor.g.cs index 0a603ce1600..82b0982f07a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/FailProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/FailProcessor.g.cs @@ -35,6 +35,10 @@ public sealed partial class FailProcessor public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// The error message thrown by the processor.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("message")] public string Message { get; set; } [JsonInclude, JsonPropertyName("on_failure")] @@ -117,6 +121,9 @@ public FailProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr return Self; } + /// + /// The error message thrown by the processor.
Supports template snippets. + /// public FailProcessorDescriptor Message(string message) { MessageValue = message; @@ -265,6 +272,9 @@ public FailProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// The error message thrown by the processor.
Supports template snippets. + /// public FailProcessorDescriptor Message(string message) { MessageValue = message; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ForeachProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ForeachProcessor.g.cs index 8a7a8a12431..ba32382e45d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ForeachProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/ForeachProcessor.g.cs @@ -31,16 +31,28 @@ public sealed partial class ForeachProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// Field containing array or object values. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// Ingest processor to run on each element. + /// [JsonInclude, JsonPropertyName("processor")] public Elastic.Clients.Elasticsearch.Ingest.Processor Processor { get; set; } [JsonInclude, JsonPropertyName("tag")] @@ -107,6 +119,9 @@ public ForeachProcessorDescriptor OnFailure(params Action + /// Ingest processor to run on each element. + /// public ForeachProcessorDescriptor Processor(Elastic.Clients.Elasticsearch.Ingest.Processor processor) { ProcessorDescriptor = null; @@ -137,12 +152,18 @@ public ForeachProcessorDescriptor Description(string? description) return Self; } + /// + /// Field containing array or object values. + /// public ForeachProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// Field containing array or object values. + /// public ForeachProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -161,6 +182,9 @@ public ForeachProcessorDescriptor IgnoreFailure(bool? ignoreFailure = return Self; } + /// + /// If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + /// public ForeachProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -317,6 +341,9 @@ public ForeachProcessorDescriptor OnFailure(params Action[] return Self; } + /// + /// Ingest processor to run on each element. + /// public ForeachProcessorDescriptor Processor(Elastic.Clients.Elasticsearch.Ingest.Processor processor) { ProcessorDescriptor = null; @@ -347,18 +374,27 @@ public ForeachProcessorDescriptor Description(string? description) return Self; } + /// + /// Field containing array or object values. + /// public ForeachProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// Field containing array or object values. + /// public ForeachProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Field containing array or object values. + /// public ForeachProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -377,6 +413,9 @@ public ForeachProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + /// public ForeachProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpProcessor.g.cs index dbb5d90a79c..19c2f4edd0f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GeoIpProcessor.g.cs @@ -29,26 +29,49 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class GeoIpProcessor { + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// [JsonInclude, JsonPropertyName("database_file")] public string? DatabaseFile { get; set; } [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to get the ip address from for the geographical lookup. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } + + /// + /// If `true`, only the first found geoip data will be returned, even if the field contains an array. + /// [JsonInclude, JsonPropertyName("first_only")] public bool? FirstOnly { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// Controls what properties are added to the `target_field` based on the geoip lookup. + /// [JsonInclude, JsonPropertyName("properties")] public ICollection? Properties { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -114,6 +137,9 @@ public GeoIpProcessorDescriptor OnFailure(params Action + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// public GeoIpProcessorDescriptor DatabaseFile(string? databaseFile) { DatabaseFileValue = databaseFile; @@ -126,18 +152,27 @@ public GeoIpProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to get the ip address from for the geographical lookup. + /// public GeoIpProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to get the ip address from for the geographical lookup. + /// public GeoIpProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// If `true`, only the first found geoip data will be returned, even if the field contains an array. + /// public GeoIpProcessorDescriptor FirstOnly(bool? firstOnly = true) { FirstOnlyValue = firstOnly; @@ -156,12 +191,18 @@ public GeoIpProcessorDescriptor IgnoreFailure(bool? ignoreFailure = t return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public GeoIpProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// Controls what properties are added to the `target_field` based on the geoip lookup. + /// public GeoIpProcessorDescriptor Properties(ICollection? properties) { PropertiesValue = properties; @@ -174,12 +215,18 @@ public GeoIpProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// public GeoIpProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// public GeoIpProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -339,6 +386,9 @@ public GeoIpProcessorDescriptor OnFailure(params Action[] c return Self; } + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// public GeoIpProcessorDescriptor DatabaseFile(string? databaseFile) { DatabaseFileValue = databaseFile; @@ -351,24 +401,36 @@ public GeoIpProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to get the ip address from for the geographical lookup. + /// public GeoIpProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to get the ip address from for the geographical lookup. + /// public GeoIpProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to get the ip address from for the geographical lookup. + /// public GeoIpProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// If `true`, only the first found geoip data will be returned, even if the field contains an array. + /// public GeoIpProcessorDescriptor FirstOnly(bool? firstOnly = true) { FirstOnlyValue = firstOnly; @@ -387,12 +449,18 @@ public GeoIpProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public GeoIpProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// Controls what properties are added to the `target_field` based on the geoip lookup. + /// public GeoIpProcessorDescriptor Properties(ICollection? properties) { PropertiesValue = properties; @@ -405,18 +473,27 @@ public GeoIpProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// public GeoIpProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// public GeoIpProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// public GeoIpProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GrokProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GrokProcessor.g.cs index 1d2e2f07d4b..bbc93cd7577 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GrokProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GrokProcessor.g.cs @@ -31,22 +31,42 @@ public sealed partial class GrokProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to use for grok expression parsing. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.
Patterns matching existing names will override the pre-existing definition. + /// [JsonInclude, JsonPropertyName("pattern_definitions")] public IDictionary? PatternDefinitions { get; set; } + + /// + /// An ordered list of grok expression to match and extract named captures with.
Returns on the first expression in the list that matches. + /// [JsonInclude, JsonPropertyName("patterns")] public ICollection Patterns { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + /// [JsonInclude, JsonPropertyName("trace_match")] public bool? TraceMatch { get; set; } @@ -117,12 +137,18 @@ public GrokProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to use for grok expression parsing. + /// public GrokProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to use for grok expression parsing. + /// public GrokProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -141,18 +167,27 @@ public GrokProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public GrokProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.
Patterns matching existing names will override the pre-existing definition. + /// public GrokProcessorDescriptor PatternDefinitions(Func, FluentDictionary> selector) { PatternDefinitionsValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// An ordered list of grok expression to match and extract named captures with.
Returns on the first expression in the list that matches. + /// public GrokProcessorDescriptor Patterns(ICollection patterns) { PatternsValue = patterns; @@ -165,6 +200,9 @@ public GrokProcessorDescriptor Tag(string? tag) return Self; } + /// + /// When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + /// public GrokProcessorDescriptor TraceMatch(bool? traceMatch = true) { TraceMatchValue = traceMatch; @@ -319,18 +357,27 @@ public GrokProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to use for grok expression parsing. + /// public GrokProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to use for grok expression parsing. + /// public GrokProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to use for grok expression parsing. + /// public GrokProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -349,18 +396,27 @@ public GrokProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public GrokProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor.
Patterns matching existing names will override the pre-existing definition. + /// public GrokProcessorDescriptor PatternDefinitions(Func, FluentDictionary> selector) { PatternDefinitionsValue = selector?.Invoke(new FluentDictionary()); return Self; } + /// + /// An ordered list of grok expression to match and extract named captures with.
Returns on the first expression in the list that matches. + /// public GrokProcessorDescriptor Patterns(ICollection patterns) { PatternsValue = patterns; @@ -373,6 +429,9 @@ public GrokProcessorDescriptor Tag(string? tag) return Self; } + /// + /// When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + /// public GrokProcessorDescriptor TraceMatch(bool? traceMatch = true) { TraceMatchValue = traceMatch; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GsubProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GsubProcessor.g.cs index 3e655c535eb..9b06772878c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GsubProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/GsubProcessor.g.cs @@ -31,22 +31,42 @@ public sealed partial class GsubProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to apply the replacement to. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// The pattern to be replaced. + /// [JsonInclude, JsonPropertyName("pattern")] public string Pattern { get; set; } + + /// + /// The string to replace the matching patterns with. + /// [JsonInclude, JsonPropertyName("replacement")] public string Replacement { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -117,12 +137,18 @@ public GsubProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to apply the replacement to. + /// public GsubProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to apply the replacement to. + /// public GsubProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -141,18 +167,27 @@ public GsubProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public GsubProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// The pattern to be replaced. + /// public GsubProcessorDescriptor Pattern(string pattern) { PatternValue = pattern; return Self; } + /// + /// The string to replace the matching patterns with. + /// public GsubProcessorDescriptor Replacement(string replacement) { ReplacementValue = replacement; @@ -165,12 +200,18 @@ public GsubProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// public GsubProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// public GsubProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -321,18 +362,27 @@ public GsubProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to apply the replacement to. + /// public GsubProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to apply the replacement to. + /// public GsubProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to apply the replacement to. + /// public GsubProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -351,18 +401,27 @@ public GsubProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public GsubProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// The pattern to be replaced. + /// public GsubProcessorDescriptor Pattern(string pattern) { PatternValue = pattern; return Self; } + /// + /// The string to replace the matching patterns with. + /// public GsubProcessorDescriptor Replacement(string replacement) { ReplacementValue = replacement; @@ -375,18 +434,27 @@ public GsubProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// public GsubProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// public GsubProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to
By default, the `field` is updated in-place. + /// public GsubProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigClassification.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigClassification.g.cs index dc41f825bf8..ab8943e591c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigClassification.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigClassification.g.cs @@ -29,14 +29,33 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class InferenceConfigClassification { + /// + /// Specifies the number of top class predictions to return. + /// [JsonInclude, JsonPropertyName("num_top_classes")] public int? NumTopClasses { get; set; } + + /// + /// Specifies the maximum number of feature importance values per document. + /// [JsonInclude, JsonPropertyName("num_top_feature_importance_values")] public int? NumTopFeatureImportanceValues { get; set; } + + /// + /// Specifies the type of the predicted field to write.
Valid values are: `string`, `number`, `boolean`. + /// [JsonInclude, JsonPropertyName("prediction_field_type")] public string? PredictionFieldType { get; set; } + + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// [JsonInclude, JsonPropertyName("results_field")] public Elastic.Clients.Elasticsearch.Field? ResultsField { get; set; } + + /// + /// Specifies the field to which the top classes are written. + /// [JsonInclude, JsonPropertyName("top_classes_results_field")] public Elastic.Clients.Elasticsearch.Field? TopClassesResultsField { get; set; } @@ -57,42 +76,63 @@ public InferenceConfigClassificationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? ResultsFieldValue { get; set; } private Elastic.Clients.Elasticsearch.Field? TopClassesResultsFieldValue { get; set; } + /// + /// Specifies the number of top class predictions to return. + /// public InferenceConfigClassificationDescriptor NumTopClasses(int? numTopClasses) { NumTopClassesValue = numTopClasses; return Self; } + /// + /// Specifies the maximum number of feature importance values per document. + /// public InferenceConfigClassificationDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { NumTopFeatureImportanceValuesValue = numTopFeatureImportanceValues; return Self; } + /// + /// Specifies the type of the predicted field to write.
Valid values are: `string`, `number`, `boolean`. + /// public InferenceConfigClassificationDescriptor PredictionFieldType(string? predictionFieldType) { PredictionFieldTypeValue = predictionFieldType; return Self; } + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// public InferenceConfigClassificationDescriptor ResultsField(Elastic.Clients.Elasticsearch.Field? resultsField) { ResultsFieldValue = resultsField; return Self; } + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// public InferenceConfigClassificationDescriptor ResultsField(Expression> resultsField) { ResultsFieldValue = resultsField; return Self; } + /// + /// Specifies the field to which the top classes are written. + /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Elastic.Clients.Elasticsearch.Field? topClassesResultsField) { TopClassesResultsFieldValue = topClassesResultsField; return Self; } + /// + /// Specifies the field to which the top classes are written. + /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Expression> topClassesResultsField) { TopClassesResultsFieldValue = topClassesResultsField; @@ -150,54 +190,81 @@ public InferenceConfigClassificationDescriptor() : base() private Elastic.Clients.Elasticsearch.Field? ResultsFieldValue { get; set; } private Elastic.Clients.Elasticsearch.Field? TopClassesResultsFieldValue { get; set; } + /// + /// Specifies the number of top class predictions to return. + /// public InferenceConfigClassificationDescriptor NumTopClasses(int? numTopClasses) { NumTopClassesValue = numTopClasses; return Self; } + /// + /// Specifies the maximum number of feature importance values per document. + /// public InferenceConfigClassificationDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { NumTopFeatureImportanceValuesValue = numTopFeatureImportanceValues; return Self; } + /// + /// Specifies the type of the predicted field to write.
Valid values are: `string`, `number`, `boolean`. + /// public InferenceConfigClassificationDescriptor PredictionFieldType(string? predictionFieldType) { PredictionFieldTypeValue = predictionFieldType; return Self; } + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// public InferenceConfigClassificationDescriptor ResultsField(Elastic.Clients.Elasticsearch.Field? resultsField) { ResultsFieldValue = resultsField; return Self; } + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// public InferenceConfigClassificationDescriptor ResultsField(Expression> resultsField) { ResultsFieldValue = resultsField; return Self; } + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// public InferenceConfigClassificationDescriptor ResultsField(Expression> resultsField) { ResultsFieldValue = resultsField; return Self; } + /// + /// Specifies the field to which the top classes are written. + /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Elastic.Clients.Elasticsearch.Field? topClassesResultsField) { TopClassesResultsFieldValue = topClassesResultsField; return Self; } + /// + /// Specifies the field to which the top classes are written. + /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Expression> topClassesResultsField) { TopClassesResultsFieldValue = topClassesResultsField; return Self; } + /// + /// Specifies the field to which the top classes are written. + /// public InferenceConfigClassificationDescriptor TopClassesResultsField(Expression> topClassesResultsField) { TopClassesResultsFieldValue = topClassesResultsField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigRegression.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigRegression.g.cs index c0a5edfef87..e3d9e4fd50c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigRegression.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceConfigRegression.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class InferenceConfigRegression { + /// + /// Specifies the maximum number of feature importance values per document. + /// [JsonInclude, JsonPropertyName("num_top_feature_importance_values")] public int? NumTopFeatureImportanceValues { get; set; } + + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// [JsonInclude, JsonPropertyName("results_field")] public Elastic.Clients.Elasticsearch.Field? ResultsField { get; set; } @@ -48,18 +55,27 @@ public InferenceConfigRegressionDescriptor() : base() private int? NumTopFeatureImportanceValuesValue { get; set; } private Elastic.Clients.Elasticsearch.Field? ResultsFieldValue { get; set; } + /// + /// Specifies the maximum number of feature importance values per document. + /// public InferenceConfigRegressionDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { NumTopFeatureImportanceValuesValue = numTopFeatureImportanceValues; return Self; } + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// public InferenceConfigRegressionDescriptor ResultsField(Elastic.Clients.Elasticsearch.Field? resultsField) { ResultsFieldValue = resultsField; return Self; } + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// public InferenceConfigRegressionDescriptor ResultsField(Expression> resultsField) { ResultsFieldValue = resultsField; @@ -96,24 +112,36 @@ public InferenceConfigRegressionDescriptor() : base() private int? NumTopFeatureImportanceValuesValue { get; set; } private Elastic.Clients.Elasticsearch.Field? ResultsFieldValue { get; set; } + /// + /// Specifies the maximum number of feature importance values per document. + /// public InferenceConfigRegressionDescriptor NumTopFeatureImportanceValues(int? numTopFeatureImportanceValues) { NumTopFeatureImportanceValuesValue = numTopFeatureImportanceValues; return Self; } + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// public InferenceConfigRegressionDescriptor ResultsField(Elastic.Clients.Elasticsearch.Field? resultsField) { ResultsFieldValue = resultsField; return Self; } + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// public InferenceConfigRegressionDescriptor ResultsField(Expression> resultsField) { ResultsFieldValue = resultsField; return Self; } + /// + /// The field that is added to incoming documents to contain the inference prediction. + /// public InferenceConfigRegressionDescriptor ResultsField(Expression> resultsField) { ResultsFieldValue = resultsField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceProcessor.g.cs index 98a05036569..82bae01052e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/InferenceProcessor.g.cs @@ -31,20 +31,36 @@ public sealed partial class InferenceProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// Maps the document field names to the known field names of the model.
This mapping takes precedence over any default mappings provided in the model configuration. + /// [JsonInclude, JsonPropertyName("field_map")] public IDictionary? FieldMap { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// Contains the inference type and its options. + /// [JsonInclude, JsonPropertyName("inference_config")] public Elastic.Clients.Elasticsearch.Ingest.InferenceConfig? InferenceConfig { get; set; } + + /// + /// The ID or alias for the trained model, or the ID of the deployment. + /// [JsonInclude, JsonPropertyName("model_id")] public Elastic.Clients.Elasticsearch.Id ModelId { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// Field added to incoming documents to contain results objects. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -74,6 +90,9 @@ public InferenceProcessorDescriptor() : base() private string? TagValue { get; set; } private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } + /// + /// Contains the inference type and its options. + /// public InferenceProcessorDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Ingest.InferenceConfig? inferenceConfig) { InferenceConfigDescriptor = null; @@ -140,6 +159,9 @@ public InferenceProcessorDescriptor Description(string? description) return Self; } + /// + /// Maps the document field names to the known field names of the model.
This mapping takes precedence over any default mappings provided in the model configuration. + /// public InferenceProcessorDescriptor FieldMap(Func, FluentDictionary> selector) { FieldMapValue = selector?.Invoke(new FluentDictionary()); @@ -158,6 +180,9 @@ public InferenceProcessorDescriptor IgnoreFailure(bool? ignoreFailure return Self; } + /// + /// The ID or alias for the trained model, or the ID of the deployment. + /// public InferenceProcessorDescriptor ModelId(Elastic.Clients.Elasticsearch.Id modelId) { ModelIdValue = modelId; @@ -170,12 +195,18 @@ public InferenceProcessorDescriptor Tag(string? tag) return Self; } + /// + /// Field added to incoming documents to contain results objects. + /// public InferenceProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// Field added to incoming documents to contain results objects. + /// public InferenceProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -297,6 +328,9 @@ public InferenceProcessorDescriptor() : base() private string? TagValue { get; set; } private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } + /// + /// Contains the inference type and its options. + /// public InferenceProcessorDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Ingest.InferenceConfig? inferenceConfig) { InferenceConfigDescriptor = null; @@ -363,6 +397,9 @@ public InferenceProcessorDescriptor Description(string? description) return Self; } + /// + /// Maps the document field names to the known field names of the model.
This mapping takes precedence over any default mappings provided in the model configuration. + /// public InferenceProcessorDescriptor FieldMap(Func, FluentDictionary> selector) { FieldMapValue = selector?.Invoke(new FluentDictionary()); @@ -381,6 +418,9 @@ public InferenceProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// The ID or alias for the trained model, or the ID of the deployment. + /// public InferenceProcessorDescriptor ModelId(Elastic.Clients.Elasticsearch.Id modelId) { ModelIdValue = modelId; @@ -393,18 +433,27 @@ public InferenceProcessorDescriptor Tag(string? tag) return Self; } + /// + /// Field added to incoming documents to contain results objects. + /// public InferenceProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// Field added to incoming documents to contain results objects. + /// public InferenceProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// Field added to incoming documents to contain results objects. + /// public InferenceProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JoinProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JoinProcessor.g.cs index 9bd305dca91..48ea73b4a1f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JoinProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JoinProcessor.g.cs @@ -31,6 +31,10 @@ public sealed partial class JoinProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// Field containing array values to join. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] @@ -39,10 +43,18 @@ public sealed partial class JoinProcessor public bool? IgnoreFailure { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// The separator character. + /// [JsonInclude, JsonPropertyName("separator")] public string Separator { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field to assign the joined value to.
By default, the field is updated in-place. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -111,12 +123,18 @@ public JoinProcessorDescriptor Description(string? description) return Self; } + /// + /// Field containing array values to join. + /// public JoinProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// Field containing array values to join. + /// public JoinProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -135,6 +153,9 @@ public JoinProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr return Self; } + /// + /// The separator character. + /// public JoinProcessorDescriptor Separator(string separator) { SeparatorValue = separator; @@ -147,12 +168,18 @@ public JoinProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the joined value to.
By default, the field is updated in-place. + /// public JoinProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the joined value to.
By default, the field is updated in-place. + /// public JoinProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -293,18 +320,27 @@ public JoinProcessorDescriptor Description(string? description) return Self; } + /// + /// Field containing array values to join. + /// public JoinProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// Field containing array values to join. + /// public JoinProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Field containing array values to join. + /// public JoinProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -323,6 +359,9 @@ public JoinProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// The separator character. + /// public JoinProcessorDescriptor Separator(string separator) { SeparatorValue = separator; @@ -335,18 +374,27 @@ public JoinProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the joined value to.
By default, the field is updated in-place. + /// public JoinProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the joined value to.
By default, the field is updated in-place. + /// public JoinProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the joined value to.
By default, the field is updated in-place. + /// public JoinProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JsonProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JsonProcessor.g.cs index dfb1f84df4d..7fb265620a1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JsonProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/JsonProcessor.g.cs @@ -29,14 +29,29 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class JsonProcessor { + /// + /// Flag that forces the parsed JSON to be added at the top level of the document.
`target_field` must not be set when this option is chosen. + /// [JsonInclude, JsonPropertyName("add_to_root")] public bool? AddToRoot { get; set; } + + /// + /// When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.
When set to `merge`, conflicting fields will be merged.
Only applicable `if add_to_root` is set to true. + /// [JsonInclude, JsonPropertyName("add_to_root_conflict_strategy")] public Elastic.Clients.Elasticsearch.Ingest.JsonProcessorConflictStrategy? AddToRootConflictStrategy { get; set; } + + /// + /// When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.
Instead, the last encountered value for any duplicate key wins. + /// [JsonInclude, JsonPropertyName("allow_duplicate_keys")] public bool? AllowDuplicateKeys { get; set; } [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to be parsed. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] @@ -47,6 +62,10 @@ public sealed partial class JsonProcessor public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -111,18 +130,27 @@ public JsonProcessorDescriptor OnFailure(params Action + /// Flag that forces the parsed JSON to be added at the top level of the document.
`target_field` must not be set when this option is chosen. + /// public JsonProcessorDescriptor AddToRoot(bool? addToRoot = true) { AddToRootValue = addToRoot; return Self; } + /// + /// When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.
When set to `merge`, conflicting fields will be merged.
Only applicable `if add_to_root` is set to true. + /// public JsonProcessorDescriptor AddToRootConflictStrategy(Elastic.Clients.Elasticsearch.Ingest.JsonProcessorConflictStrategy? addToRootConflictStrategy) { AddToRootConflictStrategyValue = addToRootConflictStrategy; return Self; } + /// + /// When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.
Instead, the last encountered value for any duplicate key wins. + /// public JsonProcessorDescriptor AllowDuplicateKeys(bool? allowDuplicateKeys = true) { AllowDuplicateKeysValue = allowDuplicateKeys; @@ -135,12 +163,18 @@ public JsonProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to be parsed. + /// public JsonProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to be parsed. + /// public JsonProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -165,12 +199,18 @@ public JsonProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// public JsonProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// public JsonProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -323,18 +363,27 @@ public JsonProcessorDescriptor OnFailure(params Action[] co return Self; } + /// + /// Flag that forces the parsed JSON to be added at the top level of the document.
`target_field` must not be set when this option is chosen. + /// public JsonProcessorDescriptor AddToRoot(bool? addToRoot = true) { AddToRootValue = addToRoot; return Self; } + /// + /// When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden.
When set to `merge`, conflicting fields will be merged.
Only applicable `if add_to_root` is set to true. + /// public JsonProcessorDescriptor AddToRootConflictStrategy(Elastic.Clients.Elasticsearch.Ingest.JsonProcessorConflictStrategy? addToRootConflictStrategy) { AddToRootConflictStrategyValue = addToRootConflictStrategy; return Self; } + /// + /// When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys.
Instead, the last encountered value for any duplicate key wins. + /// public JsonProcessorDescriptor AllowDuplicateKeys(bool? allowDuplicateKeys = true) { AllowDuplicateKeysValue = allowDuplicateKeys; @@ -347,18 +396,27 @@ public JsonProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to be parsed. + /// public JsonProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to be parsed. + /// public JsonProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to be parsed. + /// public JsonProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -383,18 +441,27 @@ public JsonProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// public JsonProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// public JsonProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that the converted structured object will be written into.
Any existing content in this field will be overwritten. + /// public JsonProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/KeyValueProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/KeyValueProcessor.g.cs index 16253ccf48c..bb69c09c495 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/KeyValueProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/KeyValueProcessor.g.cs @@ -31,34 +31,78 @@ public sealed partial class KeyValueProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// List of keys to exclude from document. + /// [JsonInclude, JsonPropertyName("exclude_keys")] public ICollection? ExcludeKeys { get; set; } + + /// + /// The field to be parsed.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } + + /// + /// Regex pattern to use for splitting key-value pairs. + /// [JsonInclude, JsonPropertyName("field_split")] public string FieldSplit { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } + + /// + /// List of keys to filter and insert into document.
Defaults to including all keys. + /// [JsonInclude, JsonPropertyName("include_keys")] public ICollection? IncludeKeys { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// Prefix to be added to extracted keys. + /// [JsonInclude, JsonPropertyName("prefix")] public string? Prefix { get; set; } + + /// + /// If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + /// [JsonInclude, JsonPropertyName("strip_brackets")] public bool? StripBrackets { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } + + /// + /// String of characters to trim from extracted keys. + /// [JsonInclude, JsonPropertyName("trim_key")] public string? TrimKey { get; set; } + + /// + /// String of characters to trim from extracted values. + /// [JsonInclude, JsonPropertyName("trim_value")] public string? TrimValue { get; set; } + + /// + /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// [JsonInclude, JsonPropertyName("value_split")] public string ValueSplit { get; set; } @@ -135,24 +179,36 @@ public KeyValueProcessorDescriptor Description(string? description) return Self; } + /// + /// List of keys to exclude from document. + /// public KeyValueProcessorDescriptor ExcludeKeys(ICollection? excludeKeys) { ExcludeKeysValue = excludeKeys; return Self; } + /// + /// The field to be parsed.
Supports template snippets. + /// public KeyValueProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to be parsed.
Supports template snippets. + /// public KeyValueProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Regex pattern to use for splitting key-value pairs. + /// public KeyValueProcessorDescriptor FieldSplit(string fieldSplit) { FieldSplitValue = fieldSplit; @@ -171,24 +227,36 @@ public KeyValueProcessorDescriptor IgnoreFailure(bool? ignoreFailure return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public KeyValueProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// List of keys to filter and insert into document.
Defaults to including all keys. + /// public KeyValueProcessorDescriptor IncludeKeys(ICollection? includeKeys) { IncludeKeysValue = includeKeys; return Self; } + /// + /// Prefix to be added to extracted keys. + /// public KeyValueProcessorDescriptor Prefix(string? prefix) { PrefixValue = prefix; return Self; } + /// + /// If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + /// public KeyValueProcessorDescriptor StripBrackets(bool? stripBrackets = true) { StripBracketsValue = stripBrackets; @@ -201,30 +269,45 @@ public KeyValueProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// public KeyValueProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// public KeyValueProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// String of characters to trim from extracted keys. + /// public KeyValueProcessorDescriptor TrimKey(string? trimKey) { TrimKeyValue = trimKey; return Self; } + /// + /// String of characters to trim from extracted values. + /// public KeyValueProcessorDescriptor TrimValue(string? trimValue) { TrimValueValue = trimValue; return Self; } + /// + /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// public KeyValueProcessorDescriptor ValueSplit(string valueSplit) { ValueSplitValue = valueSplit; @@ -417,30 +500,45 @@ public KeyValueProcessorDescriptor Description(string? description) return Self; } + /// + /// List of keys to exclude from document. + /// public KeyValueProcessorDescriptor ExcludeKeys(ICollection? excludeKeys) { ExcludeKeysValue = excludeKeys; return Self; } + /// + /// The field to be parsed.
Supports template snippets. + /// public KeyValueProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to be parsed.
Supports template snippets. + /// public KeyValueProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to be parsed.
Supports template snippets. + /// public KeyValueProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Regex pattern to use for splitting key-value pairs. + /// public KeyValueProcessorDescriptor FieldSplit(string fieldSplit) { FieldSplitValue = fieldSplit; @@ -459,24 +557,36 @@ public KeyValueProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public KeyValueProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// List of keys to filter and insert into document.
Defaults to including all keys. + /// public KeyValueProcessorDescriptor IncludeKeys(ICollection? includeKeys) { IncludeKeysValue = includeKeys; return Self; } + /// + /// Prefix to be added to extracted keys. + /// public KeyValueProcessorDescriptor Prefix(string? prefix) { PrefixValue = prefix; return Self; } + /// + /// If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + /// public KeyValueProcessorDescriptor StripBrackets(bool? stripBrackets = true) { StripBracketsValue = stripBrackets; @@ -489,36 +599,54 @@ public KeyValueProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// public KeyValueProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// public KeyValueProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to insert the extracted keys into.
Defaults to the root of the document.
Supports template snippets. + /// public KeyValueProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// String of characters to trim from extracted keys. + /// public KeyValueProcessorDescriptor TrimKey(string? trimKey) { TrimKeyValue = trimKey; return Self; } + /// + /// String of characters to trim from extracted values. + /// public KeyValueProcessorDescriptor TrimValue(string? trimValue) { TrimValueValue = trimValue; return Self; } + /// + /// Regex pattern to use for splitting the key from the value within a key-value pair. + /// public KeyValueProcessorDescriptor ValueSplit(string valueSplit) { ValueSplitValue = valueSplit; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/LowercaseProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/LowercaseProcessor.g.cs index d79b4613972..3480de8fd28 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/LowercaseProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/LowercaseProcessor.g.cs @@ -31,18 +31,30 @@ public sealed partial class LowercaseProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to make lowercase. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -111,12 +123,18 @@ public LowercaseProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to make lowercase. + /// public LowercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to make lowercase. + /// public LowercaseProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -135,6 +153,9 @@ public LowercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public LowercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -147,12 +168,18 @@ public LowercaseProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public LowercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public LowercaseProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -297,18 +324,27 @@ public LowercaseProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to make lowercase. + /// public LowercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to make lowercase. + /// public LowercaseProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to make lowercase. + /// public LowercaseProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -327,6 +363,9 @@ public LowercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public LowercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -339,18 +378,27 @@ public LowercaseProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public LowercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public LowercaseProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public LowercaseProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Pipeline.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Pipeline.g.cs index 78618a4a386..acaf2c1bba2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Pipeline.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Pipeline.g.cs @@ -29,12 +29,27 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class Pipeline { + /// + /// Description of the ingest pipeline. + /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// Processors to run immediately after a processor failure. + /// [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// Processors used to perform transformations on documents before indexing.
Processors run sequentially in the order specified. + /// [JsonInclude, JsonPropertyName("processors")] public ICollection? Processors { get; set; } + + /// + /// Version number used by external systems to track ingest pipelines. + /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } } @@ -58,6 +73,9 @@ public PipelineDescriptor() : base() private string? DescriptionValue { get; set; } private long? VersionValue { get; set; } + /// + /// Processors to run immediately after a processor failure. + /// public PipelineDescriptor OnFailure(ICollection? onFailure) { OnFailureDescriptor = null; @@ -94,6 +112,9 @@ public PipelineDescriptor OnFailure(params Action + /// Processors used to perform transformations on documents before indexing.
Processors run sequentially in the order specified. + /// public PipelineDescriptor Processors(ICollection? processors) { ProcessorsDescriptor = null; @@ -130,12 +151,18 @@ public PipelineDescriptor Processors(params Action + /// Description of the ingest pipeline. + /// public PipelineDescriptor Description(string? description) { DescriptionValue = description; return Self; } + /// + /// Version number used by external systems to track ingest pipelines. + /// public PipelineDescriptor Version(long? version) { VersionValue = version; @@ -242,6 +269,9 @@ public PipelineDescriptor() : base() private string? DescriptionValue { get; set; } private long? VersionValue { get; set; } + /// + /// Processors to run immediately after a processor failure. + /// public PipelineDescriptor OnFailure(ICollection? onFailure) { OnFailureDescriptor = null; @@ -278,6 +308,9 @@ public PipelineDescriptor OnFailure(params Action[] configu return Self; } + /// + /// Processors used to perform transformations on documents before indexing.
Processors run sequentially in the order specified. + /// public PipelineDescriptor Processors(ICollection? processors) { ProcessorsDescriptor = null; @@ -314,12 +347,18 @@ public PipelineDescriptor Processors(params Action[] config return Self; } + /// + /// Description of the ingest pipeline. + /// public PipelineDescriptor Description(string? description) { DescriptionValue = description; return Self; } + /// + /// Version number used by external systems to track ingest pipelines. + /// public PipelineDescriptor Version(long? version) { VersionValue = version; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/PipelineProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/PipelineProcessor.g.cs index 437b590cf53..70c5c441a12 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/PipelineProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/PipelineProcessor.g.cs @@ -35,8 +35,16 @@ public sealed partial class PipelineProcessor public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// Whether to ignore missing pipelines instead of failing. + /// [JsonInclude, JsonPropertyName("ignore_missing_pipeline")] public bool? IgnoreMissingPipeline { get; set; } + + /// + /// The name of the pipeline to execute.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("name")] public Elastic.Clients.Elasticsearch.Name Name { get; set; } [JsonInclude, JsonPropertyName("on_failure")] @@ -120,12 +128,18 @@ public PipelineProcessorDescriptor IgnoreFailure(bool? ignoreFailure return Self; } + /// + /// Whether to ignore missing pipelines instead of failing. + /// public PipelineProcessorDescriptor IgnoreMissingPipeline(bool? ignoreMissingPipeline = true) { IgnoreMissingPipelineValue = ignoreMissingPipeline; return Self; } + /// + /// The name of the pipeline to execute.
Supports template snippets. + /// public PipelineProcessorDescriptor Name(Elastic.Clients.Elasticsearch.Name name) { NameValue = name; @@ -281,12 +295,18 @@ public PipelineProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// Whether to ignore missing pipelines instead of failing. + /// public PipelineProcessorDescriptor IgnoreMissingPipeline(bool? ignoreMissingPipeline = true) { IgnoreMissingPipelineValue = ignoreMissingPipeline; return Self; } + /// + /// The name of the pipeline to execute.
Supports template snippets. + /// public PipelineProcessorDescriptor Name(Elastic.Clients.Elasticsearch.Name name) { NameValue = name; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RemoveProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RemoveProcessor.g.cs index 33bc8d513be..21cc3064479 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RemoveProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RemoveProcessor.g.cs @@ -31,12 +31,20 @@ public sealed partial class RemoveProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// Fields to be removed. Supports template snippets. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Fields Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] @@ -108,6 +116,9 @@ public RemoveProcessorDescriptor Description(string? description) return Self; } + /// + /// Fields to be removed. Supports template snippets. + /// public RemoveProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fields field) { FieldValue = field; @@ -126,6 +137,9 @@ public RemoveProcessorDescriptor IgnoreFailure(bool? ignoreFailure = return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public RemoveProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -269,6 +283,9 @@ public RemoveProcessorDescriptor Description(string? description) return Self; } + /// + /// Fields to be removed. Supports template snippets. + /// public RemoveProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Fields field) { FieldValue = field; @@ -287,6 +304,9 @@ public RemoveProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public RemoveProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RenameProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RenameProcessor.g.cs index 05d6f6025ff..ad4f971a9e8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RenameProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RenameProcessor.g.cs @@ -31,18 +31,30 @@ public sealed partial class RenameProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to be renamed.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The new name of the field.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field TargetField { get; set; } @@ -111,12 +123,18 @@ public RenameProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to be renamed.
Supports template snippets. + /// public RenameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to be renamed.
Supports template snippets. + /// public RenameProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -135,6 +153,9 @@ public RenameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public RenameProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -147,12 +168,18 @@ public RenameProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The new name of the field.
Supports template snippets. + /// public RenameProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The new name of the field.
Supports template snippets. + /// public RenameProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -293,18 +320,27 @@ public RenameProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to be renamed.
Supports template snippets. + /// public RenameProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to be renamed.
Supports template snippets. + /// public RenameProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to be renamed.
Supports template snippets. + /// public RenameProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -323,6 +359,9 @@ public RenameProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public RenameProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -335,18 +374,27 @@ public RenameProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The new name of the field.
Supports template snippets. + /// public RenameProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The new name of the field.
Supports template snippets. + /// public RenameProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The new name of the field.
Supports template snippets. + /// public RenameProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetProcessor.g.cs index 383d536b67e..a092d7ed188 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetProcessor.g.cs @@ -29,26 +29,49 @@ namespace Elastic.Clients.Elasticsearch.Ingest; public sealed partial class SetProcessor { + /// + /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// [JsonInclude, JsonPropertyName("copy_from")] public Elastic.Clients.Elasticsearch.Field? CopyFrom { get; set; } [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to insert, upsert, or update.
Supports template snippets. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } + + /// + /// If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_empty_value")] public bool? IgnoreEmptyValue { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// The media type for encoding `value`.
Applies only when value is a template snippet.
Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. + /// [JsonInclude, JsonPropertyName("media_type")] public string? MediaType { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// If `true` processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// [JsonInclude, JsonPropertyName("override")] public bool? Override { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The value to be set for the field.
Supports template snippets.
May specify only one of `value` or `copy_from`. + /// [JsonInclude, JsonPropertyName("value")] public object? Value { get; set; } @@ -114,12 +137,18 @@ public SetProcessorDescriptor OnFailure(params Action + /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// public SetProcessorDescriptor CopyFrom(Elastic.Clients.Elasticsearch.Field? copyFrom) { CopyFromValue = copyFrom; return Self; } + /// + /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// public SetProcessorDescriptor CopyFrom(Expression> copyFrom) { CopyFromValue = copyFrom; @@ -132,12 +161,18 @@ public SetProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to insert, upsert, or update.
Supports template snippets. + /// public SetProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to insert, upsert, or update.
Supports template snippets. + /// public SetProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -150,6 +185,9 @@ public SetProcessorDescriptor If(string? ifValue) return Self; } + /// + /// If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. + /// public SetProcessorDescriptor IgnoreEmptyValue(bool? ignoreEmptyValue = true) { IgnoreEmptyValueValue = ignoreEmptyValue; @@ -162,12 +200,18 @@ public SetProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tru return Self; } + /// + /// The media type for encoding `value`.
Applies only when value is a template snippet.
Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. + /// public SetProcessorDescriptor MediaType(string? mediaType) { MediaTypeValue = mediaType; return Self; } + /// + /// If `true` processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// public SetProcessorDescriptor Override(bool? overrideValue = true) { OverrideValue = overrideValue; @@ -180,6 +224,9 @@ public SetProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The value to be set for the field.
Supports template snippets.
May specify only one of `value` or `copy_from`. + /// public SetProcessorDescriptor Value(object? value) { ValueValue = value; @@ -339,18 +386,27 @@ public SetProcessorDescriptor OnFailure(params Action[] con return Self; } + /// + /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// public SetProcessorDescriptor CopyFrom(Elastic.Clients.Elasticsearch.Field? copyFrom) { CopyFromValue = copyFrom; return Self; } + /// + /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// public SetProcessorDescriptor CopyFrom(Expression> copyFrom) { CopyFromValue = copyFrom; return Self; } + /// + /// The origin field which will be copied to `field`, cannot set `value` simultaneously.
Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. + /// public SetProcessorDescriptor CopyFrom(Expression> copyFrom) { CopyFromValue = copyFrom; @@ -363,18 +419,27 @@ public SetProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to insert, upsert, or update.
Supports template snippets. + /// public SetProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to insert, upsert, or update.
Supports template snippets. + /// public SetProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to insert, upsert, or update.
Supports template snippets. + /// public SetProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -387,6 +452,9 @@ public SetProcessorDescriptor If(string? ifValue) return Self; } + /// + /// If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. + /// public SetProcessorDescriptor IgnoreEmptyValue(bool? ignoreEmptyValue = true) { IgnoreEmptyValueValue = ignoreEmptyValue; @@ -399,12 +467,18 @@ public SetProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// The media type for encoding `value`.
Applies only when value is a template snippet.
Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. + /// public SetProcessorDescriptor MediaType(string? mediaType) { MediaTypeValue = mediaType; return Self; } + /// + /// If `true` processor will update fields with pre-existing non-null-valued field.
When set to `false`, such fields will not be touched. + /// public SetProcessorDescriptor Override(bool? overrideValue = true) { OverrideValue = overrideValue; @@ -417,6 +491,9 @@ public SetProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The value to be set for the field.
Supports template snippets.
May specify only one of `value` or `copy_from`. + /// public SetProcessorDescriptor Value(object? value) { ValueValue = value; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetSecurityUserProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetSecurityUserProcessor.g.cs index 05dc571526e..c9a8066e784 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetSecurityUserProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SetSecurityUserProcessor.g.cs @@ -31,6 +31,10 @@ public sealed partial class SetSecurityUserProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to store the user information into. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] @@ -39,6 +43,10 @@ public sealed partial class SetSecurityUserProcessor public bool? IgnoreFailure { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// Controls what user related properties are added to the field. + /// [JsonInclude, JsonPropertyName("properties")] public ICollection? Properties { get; set; } [JsonInclude, JsonPropertyName("tag")] @@ -108,12 +116,18 @@ public SetSecurityUserProcessorDescriptor Description(string? descrip return Self; } + /// + /// The field to store the user information into. + /// public SetSecurityUserProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to store the user information into. + /// public SetSecurityUserProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -132,6 +146,9 @@ public SetSecurityUserProcessorDescriptor IgnoreFailure(bool? ignoreF return Self; } + /// + /// Controls what user related properties are added to the field. + /// public SetSecurityUserProcessorDescriptor Properties(ICollection? properties) { PropertiesValue = properties; @@ -275,18 +292,27 @@ public SetSecurityUserProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to store the user information into. + /// public SetSecurityUserProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to store the user information into. + /// public SetSecurityUserProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to store the user information into. + /// public SetSecurityUserProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -305,6 +331,9 @@ public SetSecurityUserProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr return Self; } + /// + /// Controls what user related properties are added to the field. + /// public SetSecurityUserProcessorDescriptor Properties(ICollection? properties) { PropertiesValue = properties; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SortProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SortProcessor.g.cs index df761a21ea0..f08d4cee88d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SortProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SortProcessor.g.cs @@ -31,6 +31,10 @@ public sealed partial class SortProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to be sorted. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] @@ -39,10 +43,18 @@ public sealed partial class SortProcessor public bool? IgnoreFailure { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// The sort order to use.
Accepts `"asc"` or `"desc"`. + /// [JsonInclude, JsonPropertyName("order")] public Elastic.Clients.Elasticsearch.SortOrder? Order { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -111,12 +123,18 @@ public SortProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to be sorted. + /// public SortProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to be sorted. + /// public SortProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -135,6 +153,9 @@ public SortProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr return Self; } + /// + /// The sort order to use.
Accepts `"asc"` or `"desc"`. + /// public SortProcessorDescriptor Order(Elastic.Clients.Elasticsearch.SortOrder? order) { OrderValue = order; @@ -147,12 +168,18 @@ public SortProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// public SortProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// public SortProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -297,18 +324,27 @@ public SortProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to be sorted. + /// public SortProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to be sorted. + /// public SortProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to be sorted. + /// public SortProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -327,6 +363,9 @@ public SortProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// The sort order to use.
Accepts `"asc"` or `"desc"`. + /// public SortProcessorDescriptor Order(Elastic.Clients.Elasticsearch.SortOrder? order) { OrderValue = order; @@ -339,18 +378,27 @@ public SortProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// public SortProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// public SortProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the sorted value to.
By default, the field is updated in-place. + /// public SortProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SplitProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SplitProcessor.g.cs index 3837a05821b..f64481f0a44 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SplitProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/SplitProcessor.g.cs @@ -31,22 +31,42 @@ public sealed partial class SplitProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to split. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } + + /// + /// Preserves empty trailing fields, if any. + /// [JsonInclude, JsonPropertyName("preserve_trailing")] public bool? PreserveTrailing { get; set; } + + /// + /// A regex which matches the separator, for example, `,` or `\s+`. + /// [JsonInclude, JsonPropertyName("separator")] public string Separator { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field to assign the split value to.
By default, the field is updated in-place. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -117,12 +137,18 @@ public SplitProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to split. + /// public SplitProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to split. + /// public SplitProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -141,18 +167,27 @@ public SplitProcessorDescriptor IgnoreFailure(bool? ignoreFailure = t return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public SplitProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// Preserves empty trailing fields, if any. + /// public SplitProcessorDescriptor PreserveTrailing(bool? preserveTrailing = true) { PreserveTrailingValue = preserveTrailing; return Self; } + /// + /// A regex which matches the separator, for example, `,` or `\s+`. + /// public SplitProcessorDescriptor Separator(string separator) { SeparatorValue = separator; @@ -165,12 +200,18 @@ public SplitProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the split value to.
By default, the field is updated in-place. + /// public SplitProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the split value to.
By default, the field is updated in-place. + /// public SplitProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -325,18 +366,27 @@ public SplitProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to split. + /// public SplitProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to split. + /// public SplitProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to split. + /// public SplitProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -355,18 +405,27 @@ public SplitProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public SplitProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; return Self; } + /// + /// Preserves empty trailing fields, if any. + /// public SplitProcessorDescriptor PreserveTrailing(bool? preserveTrailing = true) { PreserveTrailingValue = preserveTrailing; return Self; } + /// + /// A regex which matches the separator, for example, `,` or `\s+`. + /// public SplitProcessorDescriptor Separator(string separator) { SeparatorValue = separator; @@ -379,18 +438,27 @@ public SplitProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the split value to.
By default, the field is updated in-place. + /// public SplitProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the split value to.
By default, the field is updated in-place. + /// public SplitProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the split value to.
By default, the field is updated in-place. + /// public SplitProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/TrimProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/TrimProcessor.g.cs index 17b69083f84..e92aea2bb1e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/TrimProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/TrimProcessor.g.cs @@ -31,18 +31,30 @@ public sealed partial class TrimProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The string-valued field to trim whitespace from. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -111,12 +123,18 @@ public TrimProcessorDescriptor Description(string? description) return Self; } + /// + /// The string-valued field to trim whitespace from. + /// public TrimProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The string-valued field to trim whitespace from. + /// public TrimProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -135,6 +153,9 @@ public TrimProcessorDescriptor IgnoreFailure(bool? ignoreFailure = tr return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public TrimProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -147,12 +168,18 @@ public TrimProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// public TrimProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// public TrimProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -297,18 +324,27 @@ public TrimProcessorDescriptor Description(string? description) return Self; } + /// + /// The string-valued field to trim whitespace from. + /// public TrimProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The string-valued field to trim whitespace from. + /// public TrimProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The string-valued field to trim whitespace from. + /// public TrimProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -327,6 +363,9 @@ public TrimProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public TrimProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -339,18 +378,27 @@ public TrimProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// public TrimProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// public TrimProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the trimmed value to.
By default, the field is updated in-place. + /// public TrimProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UppercaseProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UppercaseProcessor.g.cs index 2cc7f5b74ae..0a58e10eb7e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UppercaseProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UppercaseProcessor.g.cs @@ -31,18 +31,30 @@ public sealed partial class UppercaseProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to make uppercase. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -111,12 +123,18 @@ public UppercaseProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to make uppercase. + /// public UppercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to make uppercase. + /// public UppercaseProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -135,6 +153,9 @@ public UppercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public UppercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -147,12 +168,18 @@ public UppercaseProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public UppercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public UppercaseProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -297,18 +324,27 @@ public UppercaseProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to make uppercase. + /// public UppercaseProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to make uppercase. + /// public UppercaseProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to make uppercase. + /// public UppercaseProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -327,6 +363,9 @@ public UppercaseProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public UppercaseProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -339,18 +378,27 @@ public UppercaseProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public UppercaseProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public UppercaseProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public UppercaseProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UrlDecodeProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UrlDecodeProcessor.g.cs index bddf7582a8c..3ba37ce8166 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UrlDecodeProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UrlDecodeProcessor.g.cs @@ -31,18 +31,30 @@ public sealed partial class UrlDecodeProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field to decode. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -111,12 +123,18 @@ public UrlDecodeProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to decode. + /// public UrlDecodeProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to decode. + /// public UrlDecodeProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -135,6 +153,9 @@ public UrlDecodeProcessorDescriptor IgnoreFailure(bool? ignoreFailure return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public UrlDecodeProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -147,12 +168,18 @@ public UrlDecodeProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public UrlDecodeProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public UrlDecodeProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -297,18 +324,27 @@ public UrlDecodeProcessorDescriptor Description(string? description) return Self; } + /// + /// The field to decode. + /// public UrlDecodeProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field to decode. + /// public UrlDecodeProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field to decode. + /// public UrlDecodeProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -327,6 +363,9 @@ public UrlDecodeProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + /// public UrlDecodeProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -339,18 +378,27 @@ public UrlDecodeProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public UrlDecodeProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public UrlDecodeProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field to assign the converted value to.
By default, the field is updated in-place. + /// public UrlDecodeProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UserAgentProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UserAgentProcessor.g.cs index f6f1d90e932..cad227505d3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UserAgentProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/UserAgentProcessor.g.cs @@ -31,22 +31,38 @@ public sealed partial class UserAgentProcessor { [JsonInclude, JsonPropertyName("description")] public string? Description { get; set; } + + /// + /// The field containing the user agent string. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } [JsonInclude, JsonPropertyName("if")] public string? If { get; set; } [JsonInclude, JsonPropertyName("ignore_failure")] public bool? IgnoreFailure { get; set; } + + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// [JsonInclude, JsonPropertyName("ignore_missing")] public bool? IgnoreMissing { get; set; } [JsonInclude, JsonPropertyName("on_failure")] public ICollection? OnFailure { get; set; } [JsonInclude, JsonPropertyName("options")] public ICollection? Options { get; set; } + + /// + /// The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + /// [JsonInclude, JsonPropertyName("regex_file")] public string? RegexFile { get; set; } [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + + /// + /// The field that will be filled with the user agent details. + /// [JsonInclude, JsonPropertyName("target_field")] public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } @@ -117,12 +133,18 @@ public UserAgentProcessorDescriptor Description(string? description) return Self; } + /// + /// The field containing the user agent string. + /// public UserAgentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field containing the user agent string. + /// public UserAgentProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -141,6 +163,9 @@ public UserAgentProcessorDescriptor IgnoreFailure(bool? ignoreFailure return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public UserAgentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -153,6 +178,9 @@ public UserAgentProcessorDescriptor Options(ICollection + /// The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + /// public UserAgentProcessorDescriptor RegexFile(string? regexFile) { RegexFileValue = regexFile; @@ -165,12 +193,18 @@ public UserAgentProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field that will be filled with the user agent details. + /// public UserAgentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that will be filled with the user agent details. + /// public UserAgentProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; @@ -329,18 +363,27 @@ public UserAgentProcessorDescriptor Description(string? description) return Self; } + /// + /// The field containing the user agent string. + /// public UserAgentProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// The field containing the user agent string. + /// public UserAgentProcessorDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The field containing the user agent string. + /// public UserAgentProcessorDescriptor Field(Expression> field) { FieldValue = field; @@ -359,6 +402,9 @@ public UserAgentProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) return Self; } + /// + /// If `true` and `field` does not exist, the processor quietly exits without modifying the document. + /// public UserAgentProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) { IgnoreMissingValue = ignoreMissing; @@ -371,6 +417,9 @@ public UserAgentProcessorDescriptor Options(ICollection + /// The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + /// public UserAgentProcessorDescriptor RegexFile(string? regexFile) { RegexFileValue = regexFile; @@ -383,18 +432,27 @@ public UserAgentProcessorDescriptor Tag(string? tag) return Self; } + /// + /// The field that will be filled with the user agent details. + /// public UserAgentProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Field? targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that will be filled with the user agent details. + /// public UserAgentProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; return Self; } + /// + /// The field that will be filled with the user agent details. + /// public UserAgentProcessorDescriptor TargetField(Expression> targetField) { TargetFieldValue = targetField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/InlineScript.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/InlineScript.g.cs index 0ddbe8872cb..107e40bcd21 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/InlineScript.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/InlineScript.g.cs @@ -29,12 +29,19 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class InlineScript { + /// + /// Specifies the language the script is written in. + /// [JsonInclude, JsonPropertyName("lang")] public Elastic.Clients.Elasticsearch.ScriptLanguage? Language { get; set; } [JsonInclude, JsonPropertyName("options")] public IDictionary? Options { get; set; } [JsonInclude, JsonPropertyName("params")] public IDictionary? Params { get; set; } + + /// + /// The script source. + /// [JsonInclude, JsonPropertyName("source")] public string Source { get; set; } } @@ -52,6 +59,9 @@ public InlineScriptDescriptor() : base() private IDictionary? ParamsValue { get; set; } private string SourceValue { get; set; } + /// + /// Specifies the language the script is written in. + /// public InlineScriptDescriptor Language(Elastic.Clients.Elasticsearch.ScriptLanguage? language) { LanguageValue = language; @@ -70,6 +80,9 @@ public InlineScriptDescriptor Params(Func, Flue return Self; } + /// + /// The script source. + /// public InlineScriptDescriptor Source(string source) { SourceValue = source; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/LatLonGeoLocation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/LatLonGeoLocation.g.cs index 8b68aa1add8..e0ee166ad6b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/LatLonGeoLocation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/LatLonGeoLocation.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class LatLonGeoLocation { + /// + /// Latitude + /// [JsonInclude, JsonPropertyName("lat")] public double Lat { get; set; } + + /// + /// Longitude + /// [JsonInclude, JsonPropertyName("lon")] public double Lon { get; set; } } @@ -46,12 +53,18 @@ public LatLonGeoLocationDescriptor() : base() private double LatValue { get; set; } private double LonValue { get; set; } + /// + /// Latitude + /// public LatLonGeoLocationDescriptor Lat(double lat) { LatValue = lat; return Self; } + /// + /// Longitude + /// public LatLonGeoLocationDescriptor Lon(double lon) { LonValue = lon; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RuntimeField.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RuntimeField.g.cs index 6238e52d240..95168f075f2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RuntimeField.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/RuntimeField.g.cs @@ -34,6 +34,10 @@ public sealed partial class RuntimeField /// [JsonInclude, JsonPropertyName("fetch_fields")] public ICollection? FetchFields { get; set; } + + /// + /// A custom format for `date` type runtime fields. + /// [JsonInclude, JsonPropertyName("format")] public string? Format { get; set; } @@ -42,6 +46,10 @@ public sealed partial class RuntimeField /// [JsonInclude, JsonPropertyName("input_field")] public Elastic.Clients.Elasticsearch.Field? InputField { get; set; } + + /// + /// Painless script executed at query time. + /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script? Script { get; set; } @@ -56,6 +64,10 @@ public sealed partial class RuntimeField /// [JsonInclude, JsonPropertyName("target_index")] public Elastic.Clients.Elasticsearch.IndexName? TargetIndex { get; set; } + + /// + /// Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`. + /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.Mapping.RuntimeFieldType Type { get; set; } } @@ -118,6 +130,9 @@ public RuntimeFieldDescriptor FetchFields(params Action + /// A custom format for `date` type runtime fields. + /// public RuntimeFieldDescriptor Format(string? format) { FormatValue = format; @@ -142,6 +157,9 @@ public RuntimeFieldDescriptor InputField(Expression + /// Painless script executed at query time. + /// public RuntimeFieldDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { ScriptValue = script; @@ -175,6 +193,9 @@ public RuntimeFieldDescriptor TargetIndex(Elastic.Clients.Elasticsear return Self; } + /// + /// Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`. + /// public RuntimeFieldDescriptor Type(Elastic.Clients.Elasticsearch.Mapping.RuntimeFieldType type) { TypeValue = type; @@ -309,6 +330,9 @@ public RuntimeFieldDescriptor FetchFields(params Action + /// A custom format for `date` type runtime fields. + /// public RuntimeFieldDescriptor Format(string? format) { FormatValue = format; @@ -342,6 +366,9 @@ public RuntimeFieldDescriptor InputField(Expression + /// Painless script executed at query time. + /// public RuntimeFieldDescriptor Script(Elastic.Clients.Elasticsearch.Script? script) { ScriptValue = script; @@ -384,6 +411,9 @@ public RuntimeFieldDescriptor TargetIndex(Elastic.Clients.Elasticsearch.IndexNam return Self; } + /// + /// Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`. + /// public RuntimeFieldDescriptor Type(Elastic.Clients.Elasticsearch.Mapping.RuntimeFieldType type) { TypeValue = type; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ml/FillMaskInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ml/FillMaskInferenceOptions.g.cs index 6b10b0bfdc3..b0d89248684 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ml/FillMaskInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ml/FillMaskInferenceOptions.g.cs @@ -32,6 +32,12 @@ namespace Elastic.Clients.Elasticsearch.Ml; /// public sealed partial class FillMaskInferenceOptions { + /// + /// The string/token which will be removed from incoming documents and replaced with the inference prediction(s).
In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer
has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests.
However, if this field is present in a request, its value must match the predefined value for that model/tokenizer,
otherwise the request will fail. + /// + [JsonInclude, JsonPropertyName("mask_token")] + public string? MaskToken { get; set; } + /// /// Specifies the number of top class predictions to return. Defaults to 0. /// @@ -64,12 +70,22 @@ public FillMaskInferenceOptionsDescriptor() : base() { } + private string? MaskTokenValue { get; set; } private int? NumTopClassesValue { get; set; } private string? ResultsFieldValue { get; set; } private Elastic.Clients.Elasticsearch.Ml.TokenizationConfig? TokenizationValue { get; set; } private TokenizationConfigDescriptor TokenizationDescriptor { get; set; } private Action TokenizationDescriptorAction { get; set; } + /// + /// The string/token which will be removed from incoming documents and replaced with the inference prediction(s).
In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer
has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests.
However, if this field is present in a request, its value must match the predefined value for that model/tokenizer,
otherwise the request will fail. + /// + public FillMaskInferenceOptionsDescriptor MaskToken(string? maskToken) + { + MaskTokenValue = maskToken; + return Self; + } + /// /// Specifies the number of top class predictions to return. Defaults to 0. /// @@ -118,6 +134,12 @@ public FillMaskInferenceOptionsDescriptor Tokenization(Action + /// Total number of entries added to the query cache across all shards assigned to selected nodes.
This number includes current and evicted entries. + /// [JsonInclude, JsonPropertyName("cache_count")] public int CacheCount { get; init; } + + /// + /// Total number of entries currently in the query cache across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("cache_size")] public int CacheSize { get; init; } + + /// + /// Total number of query cache evictions across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("evictions")] public int Evictions { get; init; } + + /// + /// Total count of query cache hits across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("hit_count")] public int HitCount { get; init; } + + /// + /// Total amount of memory used for the query cache across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("memory_size")] public Elastic.Clients.Elasticsearch.ByteSize? MemorySize { get; init; } + + /// + /// Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("memory_size_in_bytes")] public long MemorySizeInBytes { get; init; } + + /// + /// Total count of query cache misses across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("miss_count")] public int MissCount { get; init; } + + /// + /// Total count of hits and misses in the query cache across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("total_count")] public int TotalCount { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoolQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoolQuery.g.cs index de171d22f7b..0a2c39b9714 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoolQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoolQuery.g.cs @@ -33,14 +33,34 @@ public sealed partial class BoolQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// The clause (query) must appear in matching documents.
However, unlike `must`, the score of the query will be ignored. + /// [JsonInclude, JsonPropertyName("filter"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] public ICollection? Filter { get; set; } + + /// + /// Specifies the number or percentage of `should` clauses returned documents must match. + /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } + + /// + /// The clause (query) must appear in matching documents and will contribute to the score. + /// [JsonInclude, JsonPropertyName("must"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] public ICollection? Must { get; set; } + + /// + /// The clause (query) must not appear in the matching documents.
Because scoring is ignored, a score of `0` is returned for all documents. + /// [JsonInclude, JsonPropertyName("must_not"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] public ICollection? MustNot { get; set; } + + /// + /// The clause (query) should appear in the matching document. + /// [JsonInclude, JsonPropertyName("should"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] public ICollection? Should { get; set; } @@ -77,6 +97,9 @@ public BoolQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatchValue { get; set; } + /// + /// The clause (query) must appear in matching documents.
However, unlike `must`, the score of the query will be ignored. + /// public BoolQueryDescriptor Filter(ICollection? filter) { FilterDescriptor = null; @@ -113,6 +136,9 @@ public BoolQueryDescriptor Filter(params Action + /// The clause (query) must appear in matching documents and will contribute to the score. + /// public BoolQueryDescriptor Must(ICollection? must) { MustDescriptor = null; @@ -149,6 +175,9 @@ public BoolQueryDescriptor Must(params Action + /// The clause (query) must not appear in the matching documents.
Because scoring is ignored, a score of `0` is returned for all documents. + /// public BoolQueryDescriptor MustNot(ICollection? mustNot) { MustNotDescriptor = null; @@ -185,6 +214,9 @@ public BoolQueryDescriptor MustNot(params Action + /// The clause (query) should appear in the matching document. + /// public BoolQueryDescriptor Should(ICollection? should) { ShouldDescriptor = null; @@ -233,6 +265,9 @@ public BoolQueryDescriptor Boost(float? boost) return Self; } + /// + /// Specifies the number or percentage of `should` clauses returned documents must match. + /// public BoolQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; @@ -408,6 +443,9 @@ public BoolQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatchValue { get; set; } + /// + /// The clause (query) must appear in matching documents.
However, unlike `must`, the score of the query will be ignored. + /// public BoolQueryDescriptor Filter(ICollection? filter) { FilterDescriptor = null; @@ -444,6 +482,9 @@ public BoolQueryDescriptor Filter(params Action[] configure) return Self; } + /// + /// The clause (query) must appear in matching documents and will contribute to the score. + /// public BoolQueryDescriptor Must(ICollection? must) { MustDescriptor = null; @@ -480,6 +521,9 @@ public BoolQueryDescriptor Must(params Action[] configure) return Self; } + /// + /// The clause (query) must not appear in the matching documents.
Because scoring is ignored, a score of `0` is returned for all documents. + /// public BoolQueryDescriptor MustNot(ICollection? mustNot) { MustNotDescriptor = null; @@ -516,6 +560,9 @@ public BoolQueryDescriptor MustNot(params Action[] configure) return Self; } + /// + /// The clause (query) should appear in the matching document. + /// public BoolQueryDescriptor Should(ICollection? should) { ShouldDescriptor = null; @@ -564,6 +611,9 @@ public BoolQueryDescriptor Boost(float? boost) return Self; } + /// + /// Specifies the number or percentage of `should` clauses returned documents must match. + /// public BoolQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoostingQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoostingQuery.g.cs index 296cc2edf93..902c7005d99 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoostingQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/BoostingQuery.g.cs @@ -33,10 +33,22 @@ public sealed partial class BoostingQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Query used to decrease the relevance score of matching documents. + /// [JsonInclude, JsonPropertyName("negative")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Negative { get; set; } + + /// + /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. + /// [JsonInclude, JsonPropertyName("negative_boost")] public double NegativeBoost { get; set; } + + /// + /// Any returned documents must match this query. + /// [JsonInclude, JsonPropertyName("positive")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Positive { get; set; } @@ -63,6 +75,9 @@ public BoostingQueryDescriptor() : base() private float? BoostValue { get; set; } private double NegativeBoostValue { get; set; } + /// + /// Query used to decrease the relevance score of matching documents. + /// public BoostingQueryDescriptor Negative(Elastic.Clients.Elasticsearch.QueryDsl.Query negative) { NegativeDescriptor = null; @@ -87,6 +102,9 @@ public BoostingQueryDescriptor Negative(Action + /// Any returned documents must match this query. + /// public BoostingQueryDescriptor Positive(Elastic.Clients.Elasticsearch.QueryDsl.Query positive) { PositiveDescriptor = null; @@ -123,6 +141,9 @@ public BoostingQueryDescriptor Boost(float? boost) return Self; } + /// + /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. + /// public BoostingQueryDescriptor NegativeBoost(double negativeBoost) { NegativeBoostValue = negativeBoost; @@ -200,6 +221,9 @@ public BoostingQueryDescriptor() : base() private float? BoostValue { get; set; } private double NegativeBoostValue { get; set; } + /// + /// Query used to decrease the relevance score of matching documents. + /// public BoostingQueryDescriptor Negative(Elastic.Clients.Elasticsearch.QueryDsl.Query negative) { NegativeDescriptor = null; @@ -224,6 +248,9 @@ public BoostingQueryDescriptor Negative(Action configure) return Self; } + /// + /// Any returned documents must match this query. + /// public BoostingQueryDescriptor Positive(Elastic.Clients.Elasticsearch.QueryDsl.Query positive) { PositiveDescriptor = null; @@ -260,6 +287,9 @@ public BoostingQueryDescriptor Boost(float? boost) return Self; } + /// + /// Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. + /// public BoostingQueryDescriptor NegativeBoost(double negativeBoost) { NegativeBoostValue = negativeBoost; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/CombinedFieldsQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/CombinedFieldsQuery.g.cs index 048e0550ff5..d1cff88e2c9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/CombinedFieldsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/CombinedFieldsQuery.g.cs @@ -31,18 +31,42 @@ public sealed partial class CombinedFieldsQuery : SearchQuery { [JsonInclude, JsonPropertyName("_name")] public string? QueryName { get; set; } + + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// [JsonInclude, JsonPropertyName("auto_generate_synonyms_phrase_query")] public bool? AutoGenerateSynonymsPhraseQuery { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. + /// [JsonInclude, JsonPropertyName("fields")] public Fields Fields { get; set; } + + /// + /// Minimum number of clauses that must match for a document to be returned. + /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } + + /// + /// Boolean logic used to interpret text in the query value. + /// [JsonInclude, JsonPropertyName("operator")] public Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsOperator? Operator { get; set; } + + /// + /// Text to search for in the provided `fields`.
The `combined_fields` query analyzes the provided text before performing a search. + /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } + + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// [JsonInclude, JsonPropertyName("zero_terms_query")] public Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsZeroTerms? ZeroTermsQuery { get; set; } @@ -74,6 +98,9 @@ public CombinedFieldsQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// public CombinedFieldsQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { AutoGenerateSynonymsPhraseQueryValue = autoGenerateSynonymsPhraseQuery; @@ -86,30 +113,45 @@ public CombinedFieldsQueryDescriptor Boost(float? boost) return Self; } + /// + /// List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. + /// public CombinedFieldsQueryDescriptor Fields(Fields fields) { FieldsValue = fields; return Self; } + /// + /// Minimum number of clauses that must match for a document to be returned. + /// public CombinedFieldsQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Boolean logic used to interpret text in the query value. + /// public CombinedFieldsQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsOperator? op) { OperatorValue = op; return Self; } + /// + /// Text to search for in the provided `fields`.
The `combined_fields` query analyzes the provided text before performing a search. + /// public CombinedFieldsQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// public CombinedFieldsQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsZeroTerms? zeroTermsQuery) { ZeroTermsQueryValue = zeroTermsQuery; @@ -186,6 +228,9 @@ public CombinedFieldsQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// If true, match phrase queries are automatically created for multi-term synonyms. + /// public CombinedFieldsQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { AutoGenerateSynonymsPhraseQueryValue = autoGenerateSynonymsPhraseQuery; @@ -198,30 +243,45 @@ public CombinedFieldsQueryDescriptor Boost(float? boost) return Self; } + /// + /// List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. + /// public CombinedFieldsQueryDescriptor Fields(Fields fields) { FieldsValue = fields; return Self; } + /// + /// Minimum number of clauses that must match for a document to be returned. + /// public CombinedFieldsQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Boolean logic used to interpret text in the query value. + /// public CombinedFieldsQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsOperator? op) { OperatorValue = op; return Self; } + /// + /// Text to search for in the provided `fields`.
The `combined_fields` query analyzes the provided text before performing a search. + /// public CombinedFieldsQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// public CombinedFieldsQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.CombinedFieldsZeroTerms? zeroTermsQuery) { ZeroTermsQueryValue = zeroTermsQuery; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ConstantScoreQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ConstantScoreQuery.g.cs index 54c1e093e4e..2ce0a06f5d0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ConstantScoreQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ConstantScoreQuery.g.cs @@ -33,6 +33,10 @@ public sealed partial class ConstantScoreQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Filter query you wish to run. Any returned documents must match this query.
Filter queries do not calculate relevance scores.
To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Filter { get; set; } @@ -55,6 +59,9 @@ public ConstantScoreQueryDescriptor() : base() private string? QueryNameValue { get; set; } private float? BoostValue { get; set; } + /// + /// Filter query you wish to run. Any returned documents must match this query.
Filter queries do not calculate relevance scores.
To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// public ConstantScoreQueryDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query filter) { FilterDescriptor = null; @@ -140,6 +147,9 @@ public ConstantScoreQueryDescriptor() : base() private string? QueryNameValue { get; set; } private float? BoostValue { get; set; } + /// + /// Filter query you wish to run. Any returned documents must match this query.
Filter queries do not calculate relevance scores.
To speed up performance, Elasticsearch automatically caches frequently used filter queries. + /// public ConstantScoreQueryDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.Query filter) { FilterDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateRangeQuery.g.cs index 9099daa274a..c069a3924fb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateRangeQuery.g.cs @@ -210,13 +210,37 @@ public DateRangeQuery(Field field) public string? QueryName { get; set; } public float? Boost { get; set; } + + /// + /// Date format used to convert `date` values in the query. + /// public string? Format { get; set; } public Elastic.Clients.Elasticsearch.DateMath? From { get; set; } + + /// + /// Greater than. + /// public Elastic.Clients.Elasticsearch.DateMath? Gt { get; set; } + + /// + /// Greater than or equal to. + /// public Elastic.Clients.Elasticsearch.DateMath? Gte { get; set; } + + /// + /// Less than. + /// public Elastic.Clients.Elasticsearch.DateMath? Lt { get; set; } + + /// + /// Less than or equal to. + /// public Elastic.Clients.Elasticsearch.DateMath? Lte { get; set; } public Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? Relation { get; set; } + + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// public string? TimeZone { get; set; } public Elastic.Clients.Elasticsearch.DateMath? To { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -285,6 +309,9 @@ public DateRangeQueryDescriptor Field(Expression + /// Date format used to convert `date` values in the query. + /// public DateRangeQueryDescriptor Format(string? format) { FormatValue = format; @@ -297,24 +324,36 @@ public DateRangeQueryDescriptor From(Elastic.Clients.Elasticsearch.Da return Self; } + /// + /// Greater than. + /// public DateRangeQueryDescriptor Gt(Elastic.Clients.Elasticsearch.DateMath? gt) { GtValue = gt; return Self; } + /// + /// Greater than or equal to. + /// public DateRangeQueryDescriptor Gte(Elastic.Clients.Elasticsearch.DateMath? gte) { GteValue = gte; return Self; } + /// + /// Less than. + /// public DateRangeQueryDescriptor Lt(Elastic.Clients.Elasticsearch.DateMath? lt) { LtValue = lt; return Self; } + /// + /// Less than or equal to. + /// public DateRangeQueryDescriptor Lte(Elastic.Clients.Elasticsearch.DateMath? lte) { LteValue = lte; @@ -327,6 +366,9 @@ public DateRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearc return Self; } + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// public DateRangeQueryDescriptor TimeZone(string? timeZone) { TimeZoneValue = timeZone; @@ -475,6 +517,9 @@ public DateRangeQueryDescriptor Field(Expression + /// Date format used to convert `date` values in the query. + /// public DateRangeQueryDescriptor Format(string? format) { FormatValue = format; @@ -487,24 +532,36 @@ public DateRangeQueryDescriptor From(Elastic.Clients.Elasticsearch.DateMath? fro return Self; } + /// + /// Greater than. + /// public DateRangeQueryDescriptor Gt(Elastic.Clients.Elasticsearch.DateMath? gt) { GtValue = gt; return Self; } + /// + /// Greater than or equal to. + /// public DateRangeQueryDescriptor Gte(Elastic.Clients.Elasticsearch.DateMath? gte) { GteValue = gte; return Self; } + /// + /// Less than. + /// public DateRangeQueryDescriptor Lt(Elastic.Clients.Elasticsearch.DateMath? lt) { LtValue = lt; return Self; } + /// + /// Less than or equal to. + /// public DateRangeQueryDescriptor Lte(Elastic.Clients.Elasticsearch.DateMath? lte) { LteValue = lte; @@ -517,6 +574,9 @@ public DateRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryDsl. return Self; } + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. + /// public DateRangeQueryDescriptor TimeZone(string? timeZone) { TimeZoneValue = timeZone; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DisMaxQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DisMaxQuery.g.cs index 6e704ffb7fa..a6e6e09758f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DisMaxQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DisMaxQuery.g.cs @@ -33,8 +33,16 @@ public sealed partial class DisMaxQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// One or more query clauses.
Returned documents must match one or more of these queries.
If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// [JsonInclude, JsonPropertyName("queries")] public ICollection Queries { get; set; } + + /// + /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// [JsonInclude, JsonPropertyName("tie_breaker")] public double? TieBreaker { get; set; } @@ -59,6 +67,9 @@ public DisMaxQueryDescriptor() : base() private float? BoostValue { get; set; } private double? TieBreakerValue { get; set; } + /// + /// One or more query clauses.
Returned documents must match one or more of these queries.
If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// public DisMaxQueryDescriptor Queries(ICollection queries) { QueriesDescriptor = null; @@ -107,6 +118,9 @@ public DisMaxQueryDescriptor Boost(float? boost) return Self; } + /// + /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// public DisMaxQueryDescriptor TieBreaker(double? tieBreaker) { TieBreakerValue = tieBreaker; @@ -185,6 +199,9 @@ public DisMaxQueryDescriptor() : base() private float? BoostValue { get; set; } private double? TieBreakerValue { get; set; } + /// + /// One or more query clauses.
Returned documents must match one or more of these queries.
If a document matches multiple queries, Elasticsearch uses the highest relevance score. + /// public DisMaxQueryDescriptor Queries(ICollection queries) { QueriesDescriptor = null; @@ -233,6 +250,9 @@ public DisMaxQueryDescriptor Boost(float? boost) return Self; } + /// + /// Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + /// public DisMaxQueryDescriptor TieBreaker(double? tieBreaker) { TieBreakerValue = tieBreaker; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ExistsQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ExistsQuery.g.cs index 8a1ab57e9c2..081f0f9d6b8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ExistsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ExistsQuery.g.cs @@ -33,6 +33,10 @@ public sealed partial class ExistsQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Name of the field you wish to search. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -65,12 +69,18 @@ public ExistsQueryDescriptor Boost(float? boost) return Self; } + /// + /// Name of the field you wish to search. + /// public ExistsQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// Name of the field you wish to search. + /// public ExistsQueryDescriptor Field(Expression> field) { FieldValue = field; @@ -122,18 +132,27 @@ public ExistsQueryDescriptor Boost(float? boost) return Self; } + /// + /// Name of the field you wish to search. + /// public ExistsQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// Name of the field you wish to search. + /// public ExistsQueryDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Name of the field you wish to search. + /// public ExistsQueryDescriptor Field(Expression> field) { FieldValue = field; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldValueFactorScoreFunction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldValueFactorScoreFunction.g.cs index 532d15f8928..d88fe97a657 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldValueFactorScoreFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FieldValueFactorScoreFunction.g.cs @@ -29,12 +29,27 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class FieldValueFactorScoreFunction { + /// + /// Optional factor to multiply the field value with. + /// [JsonInclude, JsonPropertyName("factor")] public double? Factor { get; set; } + + /// + /// Field to be extracted from the document. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } + + /// + /// Value used if the document doesn’t have that field.
The modifier and factor are still applied to it as though it were read from the document. + /// [JsonInclude, JsonPropertyName("missing")] public double? Missing { get; set; } + + /// + /// Modifier to apply to the field value. + /// [JsonInclude, JsonPropertyName("modifier")] public Elastic.Clients.Elasticsearch.QueryDsl.FieldValueFactorModifier? Modifier { get; set; } @@ -54,30 +69,45 @@ public FieldValueFactorScoreFunctionDescriptor() : base() private double? MissingValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.FieldValueFactorModifier? ModifierValue { get; set; } + /// + /// Optional factor to multiply the field value with. + /// public FieldValueFactorScoreFunctionDescriptor Factor(double? factor) { FactorValue = factor; return Self; } + /// + /// Field to be extracted from the document. + /// public FieldValueFactorScoreFunctionDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// Field to be extracted from the document. + /// public FieldValueFactorScoreFunctionDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Value used if the document doesn’t have that field.
The modifier and factor are still applied to it as though it were read from the document. + /// public FieldValueFactorScoreFunctionDescriptor Missing(double? missing) { MissingValue = missing; return Self; } + /// + /// Modifier to apply to the field value. + /// public FieldValueFactorScoreFunctionDescriptor Modifier(Elastic.Clients.Elasticsearch.QueryDsl.FieldValueFactorModifier? modifier) { ModifierValue = modifier; @@ -124,36 +154,54 @@ public FieldValueFactorScoreFunctionDescriptor() : base() private double? MissingValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.FieldValueFactorModifier? ModifierValue { get; set; } + /// + /// Optional factor to multiply the field value with. + /// public FieldValueFactorScoreFunctionDescriptor Factor(double? factor) { FactorValue = factor; return Self; } + /// + /// Field to be extracted from the document. + /// public FieldValueFactorScoreFunctionDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// Field to be extracted from the document. + /// public FieldValueFactorScoreFunctionDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Field to be extracted from the document. + /// public FieldValueFactorScoreFunctionDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Value used if the document doesn’t have that field.
The modifier and factor are still applied to it as though it were read from the document. + /// public FieldValueFactorScoreFunctionDescriptor Missing(double? missing) { MissingValue = missing; return Self; } + /// + /// Modifier to apply to the field value. + /// public FieldValueFactorScoreFunctionDescriptor Modifier(Elastic.Clients.Elasticsearch.QueryDsl.FieldValueFactorModifier? modifier) { ModifierValue = modifier; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FunctionScoreQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FunctionScoreQuery.g.cs index f302fae4b1f..c33e5cb386c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FunctionScoreQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FunctionScoreQuery.g.cs @@ -33,16 +33,40 @@ public sealed partial class FunctionScoreQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Defines how he newly computed score is combined with the score of the query + /// [JsonInclude, JsonPropertyName("boost_mode")] public Elastic.Clients.Elasticsearch.QueryDsl.FunctionBoostMode? BoostMode { get; set; } + + /// + /// One or more functions that compute a new score for each document returned by the query. + /// [JsonInclude, JsonPropertyName("functions")] public ICollection? Functions { get; set; } + + /// + /// Restricts the new score to not exceed the provided limit. + /// [JsonInclude, JsonPropertyName("max_boost")] public double? MaxBoost { get; set; } + + /// + /// Excludes documents that do not meet the provided score threshold. + /// [JsonInclude, JsonPropertyName("min_score")] public double? MinScore { get; set; } + + /// + /// A query that determines the documents for which a new score is computed. + /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query? Query { get; set; } + + /// + /// Specifies how the computed scores are combined + /// [JsonInclude, JsonPropertyName("score_mode")] public Elastic.Clients.Elasticsearch.QueryDsl.FunctionScoreMode? ScoreMode { get; set; } @@ -73,6 +97,9 @@ public FunctionScoreQueryDescriptor() : base() private double? MinScoreValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.FunctionScoreMode? ScoreModeValue { get; set; } + /// + /// One or more functions that compute a new score for each document returned by the query. + /// public FunctionScoreQueryDescriptor Functions(ICollection? functions) { FunctionsDescriptor = null; @@ -109,6 +136,9 @@ public FunctionScoreQueryDescriptor Functions(params Action + /// A query that determines the documents for which a new score is computed. + /// public FunctionScoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { QueryDescriptor = null; @@ -145,24 +175,36 @@ public FunctionScoreQueryDescriptor Boost(float? boost) return Self; } + /// + /// Defines how he newly computed score is combined with the score of the query + /// public FunctionScoreQueryDescriptor BoostMode(Elastic.Clients.Elasticsearch.QueryDsl.FunctionBoostMode? boostMode) { BoostModeValue = boostMode; return Self; } + /// + /// Restricts the new score to not exceed the provided limit. + /// public FunctionScoreQueryDescriptor MaxBoost(double? maxBoost) { MaxBoostValue = maxBoost; return Self; } + /// + /// Excludes documents that do not meet the provided score threshold. + /// public FunctionScoreQueryDescriptor MinScore(double? minScore) { MinScoreValue = minScore; return Self; } + /// + /// Specifies how the computed scores are combined + /// public FunctionScoreQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl.FunctionScoreMode? scoreMode) { ScoreModeValue = scoreMode; @@ -281,6 +323,9 @@ public FunctionScoreQueryDescriptor() : base() private double? MinScoreValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.FunctionScoreMode? ScoreModeValue { get; set; } + /// + /// One or more functions that compute a new score for each document returned by the query. + /// public FunctionScoreQueryDescriptor Functions(ICollection? functions) { FunctionsDescriptor = null; @@ -317,6 +362,9 @@ public FunctionScoreQueryDescriptor Functions(params Action + /// A query that determines the documents for which a new score is computed. + /// public FunctionScoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query? query) { QueryDescriptor = null; @@ -353,24 +401,36 @@ public FunctionScoreQueryDescriptor Boost(float? boost) return Self; } + /// + /// Defines how he newly computed score is combined with the score of the query + /// public FunctionScoreQueryDescriptor BoostMode(Elastic.Clients.Elasticsearch.QueryDsl.FunctionBoostMode? boostMode) { BoostModeValue = boostMode; return Self; } + /// + /// Restricts the new score to not exceed the provided limit. + /// public FunctionScoreQueryDescriptor MaxBoost(double? maxBoost) { MaxBoostValue = maxBoost; return Self; } + /// + /// Excludes documents that do not meet the provided score threshold. + /// public FunctionScoreQueryDescriptor MinScore(double? minScore) { MinScoreValue = minScore; return Self; } + /// + /// Specifies how the computed scores are combined + /// public FunctionScoreQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl.FunctionScoreMode? scoreMode) { ScoreModeValue = scoreMode; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FuzzyQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FuzzyQuery.g.cs index b136b2a690a..b245938bc21 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FuzzyQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/FuzzyQuery.g.cs @@ -170,11 +170,35 @@ public FuzzyQuery(Field field) public string? QueryName { get; set; } public float? Boost { get; set; } + + /// + /// Maximum edit distance allowed for matching. + /// public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } + + /// + /// Maximum number of variations created. + /// public int? MaxExpansions { get; set; } + + /// + /// Number of beginning characters left unchanged when creating expansions. + /// public int? PrefixLength { get; set; } + + /// + /// Number of beginning characters left unchanged when creating expansions. + /// public string? Rewrite { get; set; } + + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + /// public bool? Transpositions { get; set; } + + /// + /// Term you wish to find in the provided field. + /// public object Value { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -239,36 +263,54 @@ public FuzzyQueryDescriptor Field(Expression + /// Maximum edit distance allowed for matching. + /// public FuzzyQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { FuzzinessValue = fuzziness; return Self; } + /// + /// Maximum number of variations created. + /// public FuzzyQueryDescriptor MaxExpansions(int? maxExpansions) { MaxExpansionsValue = maxExpansions; return Self; } + /// + /// Number of beginning characters left unchanged when creating expansions. + /// public FuzzyQueryDescriptor PrefixLength(int? prefixLength) { PrefixLengthValue = prefixLength; return Self; } + /// + /// Number of beginning characters left unchanged when creating expansions. + /// public FuzzyQueryDescriptor Rewrite(string? rewrite) { RewriteValue = rewrite; return Self; } + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + /// public FuzzyQueryDescriptor Transpositions(bool? transpositions = true) { TranspositionsValue = transpositions; return Self; } + /// + /// Term you wish to find in the provided field. + /// public FuzzyQueryDescriptor Value(object value) { ValueValue = value; @@ -386,36 +428,54 @@ public FuzzyQueryDescriptor Field(Expression> return Self; } + /// + /// Maximum edit distance allowed for matching. + /// public FuzzyQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { FuzzinessValue = fuzziness; return Self; } + /// + /// Maximum number of variations created. + /// public FuzzyQueryDescriptor MaxExpansions(int? maxExpansions) { MaxExpansionsValue = maxExpansions; return Self; } + /// + /// Number of beginning characters left unchanged when creating expansions. + /// public FuzzyQueryDescriptor PrefixLength(int? prefixLength) { PrefixLengthValue = prefixLength; return Self; } + /// + /// Number of beginning characters left unchanged when creating expansions. + /// public FuzzyQueryDescriptor Rewrite(string? rewrite) { RewriteValue = rewrite; return Self; } + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + /// public FuzzyQueryDescriptor Transpositions(bool? transpositions = true) { TranspositionsValue = transpositions; return Self; } + /// + /// Term you wish to find in the provided field. + /// public FuzzyQueryDescriptor Value(object value) { ValueValue = value; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoBoundingBoxQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoBoundingBoxQuery.g.cs index 797ff271083..5063b5a6545 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoBoundingBoxQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoBoundingBoxQuery.g.cs @@ -122,7 +122,15 @@ public sealed partial class GeoBoundingBoxQuery : SearchQuery public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.GeoBounds BoundingBox { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } + + /// + /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// public bool? IgnoreUnmapped { get; set; } + + /// + /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// public Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? ValidationMethod { get; set; } public static implicit operator Query(GeoBoundingBoxQuery geoBoundingBoxQuery) => QueryDsl.Query.GeoBoundingBox(geoBoundingBoxQuery); @@ -157,12 +165,18 @@ public GeoBoundingBoxQueryDescriptor Boost(float? boost) return Self; } + /// + /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// public GeoBoundingBoxQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { IgnoreUnmappedValue = ignoreUnmapped; return Self; } + /// + /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// public GeoBoundingBoxQueryDescriptor ValidationMethod(Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? validationMethod) { ValidationMethodValue = validationMethod; @@ -252,12 +266,18 @@ public GeoBoundingBoxQueryDescriptor Boost(float? boost) return Self; } + /// + /// Set to `true` to ignore an unmapped field and not match any documents for this query.
Set to `false` to throw an exception if the field is not mapped. + /// public GeoBoundingBoxQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { IgnoreUnmappedValue = ignoreUnmapped; return Self; } + /// + /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// public GeoBoundingBoxQueryDescriptor ValidationMethod(Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? validationMethod) { ValidationMethodValue = validationMethod; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDistanceQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDistanceQuery.g.cs index f2672c0d6d0..0db472596a1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDistanceQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/GeoDistanceQuery.g.cs @@ -53,7 +53,7 @@ public override GeoDistanceQuery Read(ref Utf8JsonReader reader, Type typeToConv if (property == "distance") { - variant.Distance = JsonSerializer.Deserialize(ref reader, options); + variant.Distance = JsonSerializer.Deserialize(ref reader, options); continue; } @@ -105,12 +105,8 @@ public override void Write(Utf8JsonWriter writer, GeoDistanceQuery value, JsonSe writer.WriteNumberValue(value.Boost.Value); } - if (value.Distance is not null) - { - writer.WritePropertyName("distance"); - JsonSerializer.Serialize(writer, value.Distance, options); - } - + writer.WritePropertyName("distance"); + JsonSerializer.Serialize(writer, value.Distance, options); if (value.DistanceType is not null) { writer.WritePropertyName("distance_type"); @@ -132,10 +128,22 @@ public sealed partial class GeoDistanceQuery : SearchQuery { public string? QueryName { get; set; } public float? Boost { get; set; } - public string? Distance { get; set; } + + /// + /// The radius of the circle centred on the specified location.
Points which fall into this circle are considered to be matches. + /// + public string Distance { get; set; } + + /// + /// How to compute the distance.
Set to `plane` for a faster calculation that's inaccurate on long distances and close to the poles. + /// public Elastic.Clients.Elasticsearch.GeoDistanceType? DistanceType { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } public Elastic.Clients.Elasticsearch.GeoLocation Location { get; set; } + + /// + /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// public Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? ValidationMethod { get; set; } public static implicit operator Query(GeoDistanceQuery geoDistanceQuery) => QueryDsl.Query.GeoDistance(geoDistanceQuery); @@ -153,7 +161,7 @@ public GeoDistanceQueryDescriptor() : base() private string? QueryNameValue { get; set; } private float? BoostValue { get; set; } - private string? DistanceValue { get; set; } + private string DistanceValue { get; set; } private Elastic.Clients.Elasticsearch.GeoDistanceType? DistanceTypeValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? ValidationMethodValue { get; set; } private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } @@ -171,18 +179,27 @@ public GeoDistanceQueryDescriptor Boost(float? boost) return Self; } - public GeoDistanceQueryDescriptor Distance(string? distance) + /// + /// The radius of the circle centred on the specified location.
Points which fall into this circle are considered to be matches. + /// + public GeoDistanceQueryDescriptor Distance(string distance) { DistanceValue = distance; return Self; } + /// + /// How to compute the distance.
Set to `plane` for a faster calculation that's inaccurate on long distances and close to the poles. + /// public GeoDistanceQueryDescriptor DistanceType(Elastic.Clients.Elasticsearch.GeoDistanceType? distanceType) { DistanceTypeValue = distanceType; return Self; } + /// + /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// public GeoDistanceQueryDescriptor ValidationMethod(Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? validationMethod) { ValidationMethodValue = validationMethod; @@ -229,12 +246,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(BoostValue.Value); } - if (DistanceValue is not null) - { - writer.WritePropertyName("distance"); - JsonSerializer.Serialize(writer, DistanceValue, options); - } - + writer.WritePropertyName("distance"); + JsonSerializer.Serialize(writer, DistanceValue, options); if (DistanceTypeValue is not null) { writer.WritePropertyName("distance_type"); @@ -261,7 +274,7 @@ public GeoDistanceQueryDescriptor() : base() private string? QueryNameValue { get; set; } private float? BoostValue { get; set; } - private string? DistanceValue { get; set; } + private string DistanceValue { get; set; } private Elastic.Clients.Elasticsearch.GeoDistanceType? DistanceTypeValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? ValidationMethodValue { get; set; } private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } @@ -279,18 +292,27 @@ public GeoDistanceQueryDescriptor Boost(float? boost) return Self; } - public GeoDistanceQueryDescriptor Distance(string? distance) + /// + /// The radius of the circle centred on the specified location.
Points which fall into this circle are considered to be matches. + /// + public GeoDistanceQueryDescriptor Distance(string distance) { DistanceValue = distance; return Self; } + /// + /// How to compute the distance.
Set to `plane` for a faster calculation that's inaccurate on long distances and close to the poles. + /// public GeoDistanceQueryDescriptor DistanceType(Elastic.Clients.Elasticsearch.GeoDistanceType? distanceType) { DistanceTypeValue = distanceType; return Self; } + /// + /// Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.
Set to `COERCE` to also try to infer correct latitude or longitude. + /// public GeoDistanceQueryDescriptor ValidationMethod(Elastic.Clients.Elasticsearch.QueryDsl.GeoValidationMethod? validationMethod) { ValidationMethodValue = validationMethod; @@ -343,12 +365,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(BoostValue.Value); } - if (DistanceValue is not null) - { - writer.WritePropertyName("distance"); - JsonSerializer.Serialize(writer, DistanceValue, options); - } - + writer.WritePropertyName("distance"); + JsonSerializer.Serialize(writer, DistanceValue, options); if (DistanceTypeValue is not null) { writer.WritePropertyName("distance_type"); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasChildQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasChildQuery.g.cs index 8c963542ee6..c27b4a1f057 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasChildQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasChildQuery.g.cs @@ -33,18 +33,46 @@ public sealed partial class HasChildQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } + + /// + /// If defined, each search hit will contain inner hits. + /// [JsonInclude, JsonPropertyName("inner_hits")] public Elastic.Clients.Elasticsearch.Core.Search.InnerHits? InnerHits { get; set; } + + /// + /// Maximum number of child documents that match the query allowed for a returned parent document.
If the parent document exceeds this limit, it is excluded from the search results. + /// [JsonInclude, JsonPropertyName("max_children")] public int? MaxChildren { get; set; } + + /// + /// Minimum number of child documents that match the query required to match the query for a returned parent document.
If the parent document does not meet this limit, it is excluded from the search results. + /// [JsonInclude, JsonPropertyName("min_children")] public int? MinChildren { get; set; } + + /// + /// Query you wish to run on child documents of the `type` field.
If a child document matches the search, the query returns the parent document. + /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } + + /// + /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// [JsonInclude, JsonPropertyName("score_mode")] public Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? ScoreMode { get; set; } + + /// + /// Name of the child relationship mapped for the `join` field. + /// [JsonInclude, JsonPropertyName("type")] public string Type { get; set; } @@ -75,6 +103,9 @@ public HasChildQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? ScoreModeValue { get; set; } private string TypeValue { get; set; } + /// + /// If defined, each search hit will contain inner hits. + /// public HasChildQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { InnerHitsDescriptor = null; @@ -99,6 +130,9 @@ public HasChildQueryDescriptor InnerHits(Action + /// Query you wish to run on child documents of the `type` field.
If a child document matches the search, the query returns the parent document. + /// public HasChildQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { QueryDescriptor = null; @@ -135,30 +169,45 @@ public HasChildQueryDescriptor Boost(float? boost) return Self; } + /// + /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// public HasChildQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { IgnoreUnmappedValue = ignoreUnmapped; return Self; } + /// + /// Maximum number of child documents that match the query allowed for a returned parent document.
If the parent document exceeds this limit, it is excluded from the search results. + /// public HasChildQueryDescriptor MaxChildren(int? maxChildren) { MaxChildrenValue = maxChildren; return Self; } + /// + /// Minimum number of child documents that match the query required to match the query for a returned parent document.
If the parent document does not meet this limit, it is excluded from the search results. + /// public HasChildQueryDescriptor MinChildren(int? minChildren) { MinChildrenValue = minChildren; return Self; } + /// + /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// public HasChildQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? scoreMode) { ScoreModeValue = scoreMode; return Self; } + /// + /// Name of the child relationship mapped for the `join` field. + /// public HasChildQueryDescriptor Type(string type) { TypeValue = type; @@ -264,6 +313,9 @@ public HasChildQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? ScoreModeValue { get; set; } private string TypeValue { get; set; } + /// + /// If defined, each search hit will contain inner hits. + /// public HasChildQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { InnerHitsDescriptor = null; @@ -288,6 +340,9 @@ public HasChildQueryDescriptor InnerHits(Action return Self; } + /// + /// Query you wish to run on child documents of the `type` field.
If a child document matches the search, the query returns the parent document. + /// public HasChildQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { QueryDescriptor = null; @@ -324,30 +379,45 @@ public HasChildQueryDescriptor Boost(float? boost) return Self; } + /// + /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// public HasChildQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { IgnoreUnmappedValue = ignoreUnmapped; return Self; } + /// + /// Maximum number of child documents that match the query allowed for a returned parent document.
If the parent document exceeds this limit, it is excluded from the search results. + /// public HasChildQueryDescriptor MaxChildren(int? maxChildren) { MaxChildrenValue = maxChildren; return Self; } + /// + /// Minimum number of child documents that match the query required to match the query for a returned parent document.
If the parent document does not meet this limit, it is excluded from the search results. + /// public HasChildQueryDescriptor MinChildren(int? minChildren) { MinChildrenValue = minChildren; return Self; } + /// + /// Indicates how scores for matching child documents affect the root parent document’s relevance score. + /// public HasChildQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? scoreMode) { ScoreModeValue = scoreMode; return Self; } + /// + /// Name of the child relationship mapped for the `join` field. + /// public HasChildQueryDescriptor Type(string type) { TypeValue = type; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasParentQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasParentQuery.g.cs index 4424beb1aca..87885d7c857 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasParentQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/HasParentQuery.g.cs @@ -33,14 +33,34 @@ public sealed partial class HasParentQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error.
You can use this parameter to query multiple indices that may not contain the `parent_type`. + /// [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } + + /// + /// If defined, each search hit will contain inner hits. + /// [JsonInclude, JsonPropertyName("inner_hits")] public Elastic.Clients.Elasticsearch.Core.Search.InnerHits? InnerHits { get; set; } + + /// + /// Name of the parent relationship mapped for the `join` field. + /// [JsonInclude, JsonPropertyName("parent_type")] public string ParentType { get; set; } + + /// + /// Query you wish to run on parent documents of the `parent_type` field.
If a parent document matches the search, the query returns its child documents. + /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } + + /// + /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// [JsonInclude, JsonPropertyName("score")] public bool? Score { get; set; } @@ -69,6 +89,9 @@ public HasParentQueryDescriptor() : base() private string ParentTypeValue { get; set; } private bool? ScoreValue { get; set; } + /// + /// If defined, each search hit will contain inner hits. + /// public HasParentQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { InnerHitsDescriptor = null; @@ -93,6 +116,9 @@ public HasParentQueryDescriptor InnerHits(Action + /// Query you wish to run on parent documents of the `parent_type` field.
If a parent document matches the search, the query returns its child documents. + /// public HasParentQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { QueryDescriptor = null; @@ -129,18 +155,27 @@ public HasParentQueryDescriptor Boost(float? boost) return Self; } + /// + /// Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error.
You can use this parameter to query multiple indices that may not contain the `parent_type`. + /// public HasParentQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { IgnoreUnmappedValue = ignoreUnmapped; return Self; } + /// + /// Name of the parent relationship mapped for the `join` field. + /// public HasParentQueryDescriptor ParentType(string parentType) { ParentTypeValue = parentType; return Self; } + /// + /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// public HasParentQueryDescriptor Score(bool? score = true) { ScoreValue = score; @@ -232,6 +267,9 @@ public HasParentQueryDescriptor() : base() private string ParentTypeValue { get; set; } private bool? ScoreValue { get; set; } + /// + /// If defined, each search hit will contain inner hits. + /// public HasParentQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { InnerHitsDescriptor = null; @@ -256,6 +294,9 @@ public HasParentQueryDescriptor InnerHits(Action + /// Query you wish to run on parent documents of the `parent_type` field.
If a parent document matches the search, the query returns its child documents. + /// public HasParentQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { QueryDescriptor = null; @@ -292,18 +333,27 @@ public HasParentQueryDescriptor Boost(float? boost) return Self; } + /// + /// Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error.
You can use this parameter to query multiple indices that may not contain the `parent_type`. + /// public HasParentQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { IgnoreUnmappedValue = ignoreUnmapped; return Self; } + /// + /// Name of the parent relationship mapped for the `join` field. + /// public HasParentQueryDescriptor ParentType(string parentType) { ParentTypeValue = parentType; return Self; } + /// + /// Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + /// public HasParentQueryDescriptor Score(bool? score = true) { ScoreValue = score; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IdsQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IdsQuery.g.cs index 45b6d125b35..ac7d9013185 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IdsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IdsQuery.g.cs @@ -33,6 +33,10 @@ public sealed partial class IdsQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// An array of document IDs. + /// [JsonInclude, JsonPropertyName("values")] public Elastic.Clients.Elasticsearch.Ids? Values { get; set; } @@ -65,6 +69,9 @@ public IdsQueryDescriptor Boost(float? boost) return Self; } + /// + /// An array of document IDs. + /// public IdsQueryDescriptor Values(Elastic.Clients.Elasticsearch.Ids? values) { ValuesValue = values; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAllOf.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAllOf.g.cs index 6da4dde6ffb..fe69ede394d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAllOf.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAllOf.g.cs @@ -29,12 +29,27 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IntervalsAllOf { + /// + /// Rule used to filter returned intervals. + /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? Filter { get; set; } + + /// + /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// [JsonInclude, JsonPropertyName("intervals")] public ICollection Intervals { get; set; } + + /// + /// Maximum number of positions between the matching terms.
Intervals produced by the rules further apart than this are not considered matches. + /// [JsonInclude, JsonPropertyName("max_gaps")] public int? MaxGaps { get; set; } + + /// + /// If `true`, intervals produced by the rules should appear in the order in which they are specified. + /// [JsonInclude, JsonPropertyName("ordered")] public bool? Ordered { get; set; } } @@ -57,6 +72,9 @@ public IntervalsAllOfDescriptor() : base() private int? MaxGapsValue { get; set; } private bool? OrderedValue { get; set; } + /// + /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// public IntervalsAllOfDescriptor Intervals(ICollection intervals) { IntervalsDescriptor = null; @@ -93,6 +111,9 @@ public IntervalsAllOfDescriptor Intervals(params Action + /// Rule used to filter returned intervals. + /// public IntervalsAllOfDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? filter) { FilterDescriptor = null; @@ -117,12 +138,18 @@ public IntervalsAllOfDescriptor Filter(Action + /// Maximum number of positions between the matching terms.
Intervals produced by the rules further apart than this are not considered matches. + /// public IntervalsAllOfDescriptor MaxGaps(int? maxGaps) { MaxGapsValue = maxGaps; return Self; } + /// + /// If `true`, intervals produced by the rules should appear in the order in which they are specified. + /// public IntervalsAllOfDescriptor Ordered(bool? ordered = true) { OrderedValue = ordered; @@ -213,6 +240,9 @@ public IntervalsAllOfDescriptor() : base() private int? MaxGapsValue { get; set; } private bool? OrderedValue { get; set; } + /// + /// An array of rules to combine. All rules must produce a match in a document for the overall source to match. + /// public IntervalsAllOfDescriptor Intervals(ICollection intervals) { IntervalsDescriptor = null; @@ -249,6 +279,9 @@ public IntervalsAllOfDescriptor Intervals(params Action[] c return Self; } + /// + /// Rule used to filter returned intervals. + /// public IntervalsAllOfDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? filter) { FilterDescriptor = null; @@ -273,12 +306,18 @@ public IntervalsAllOfDescriptor Filter(Action configu return Self; } + /// + /// Maximum number of positions between the matching terms.
Intervals produced by the rules further apart than this are not considered matches. + /// public IntervalsAllOfDescriptor MaxGaps(int? maxGaps) { MaxGapsValue = maxGaps; return Self; } + /// + /// If `true`, intervals produced by the rules should appear in the order in which they are specified. + /// public IntervalsAllOfDescriptor Ordered(bool? ordered = true) { OrderedValue = ordered; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAnyOf.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAnyOf.g.cs index c6adb242d46..086358509bb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAnyOf.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsAnyOf.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IntervalsAnyOf { + /// + /// Rule used to filter returned intervals. + /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? Filter { get; set; } + + /// + /// An array of rules to match. + /// [JsonInclude, JsonPropertyName("intervals")] public ICollection Intervals { get; set; } } @@ -51,6 +58,9 @@ public IntervalsAnyOfDescriptor() : base() private IntervalsFilterDescriptor FilterDescriptor { get; set; } private Action FilterDescriptorAction { get; set; } + /// + /// An array of rules to match. + /// public IntervalsAnyOfDescriptor Intervals(ICollection intervals) { IntervalsDescriptor = null; @@ -87,6 +97,9 @@ public IntervalsAnyOfDescriptor Intervals(params Action + /// Rule used to filter returned intervals. + /// public IntervalsAnyOfDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? filter) { FilterDescriptor = null; @@ -181,6 +194,9 @@ public IntervalsAnyOfDescriptor() : base() private IntervalsFilterDescriptor FilterDescriptor { get; set; } private Action FilterDescriptorAction { get; set; } + /// + /// An array of rules to match. + /// public IntervalsAnyOfDescriptor Intervals(ICollection intervals) { IntervalsDescriptor = null; @@ -217,6 +233,9 @@ public IntervalsAnyOfDescriptor Intervals(params Action[] c return Self; } + /// + /// Rule used to filter returned intervals. + /// public IntervalsAnyOfDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? filter) { FilterDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsFuzzy.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsFuzzy.g.cs index 74a648754a2..138be9590b6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsFuzzy.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsFuzzy.g.cs @@ -29,16 +29,39 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IntervalsFuzzy { + /// + /// Analyzer used to normalize the term. + /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } + + /// + /// Maximum edit distance allowed for matching. + /// [JsonInclude, JsonPropertyName("fuzziness")] public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } + + /// + /// Number of beginning characters left unchanged when creating expansions. + /// [JsonInclude, JsonPropertyName("prefix_length")] public int? PrefixLength { get; set; } + + /// + /// The term to match. + /// [JsonInclude, JsonPropertyName("term")] public string Term { get; set; } + + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// [JsonInclude, JsonPropertyName("transpositions")] public bool? Transpositions { get; set; } + + /// + /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// [JsonInclude, JsonPropertyName("use_field")] public Elastic.Clients.Elasticsearch.Field? UseField { get; set; } } @@ -58,42 +81,63 @@ public IntervalsFuzzyDescriptor() : base() private bool? TranspositionsValue { get; set; } private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } + /// + /// Analyzer used to normalize the term. + /// public IntervalsFuzzyDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// Maximum edit distance allowed for matching. + /// public IntervalsFuzzyDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { FuzzinessValue = fuzziness; return Self; } + /// + /// Number of beginning characters left unchanged when creating expansions. + /// public IntervalsFuzzyDescriptor PrefixLength(int? prefixLength) { PrefixLengthValue = prefixLength; return Self; } + /// + /// The term to match. + /// public IntervalsFuzzyDescriptor Term(string term) { TermValue = term; return Self; } + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// public IntervalsFuzzyDescriptor Transpositions(bool? transpositions = true) { TranspositionsValue = transpositions; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsFuzzyDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { UseFieldValue = useField; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsFuzzyDescriptor UseField(Expression> useField) { UseFieldValue = useField; @@ -154,48 +198,72 @@ public IntervalsFuzzyDescriptor() : base() private bool? TranspositionsValue { get; set; } private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } + /// + /// Analyzer used to normalize the term. + /// public IntervalsFuzzyDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// Maximum edit distance allowed for matching. + /// public IntervalsFuzzyDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { FuzzinessValue = fuzziness; return Self; } + /// + /// Number of beginning characters left unchanged when creating expansions. + /// public IntervalsFuzzyDescriptor PrefixLength(int? prefixLength) { PrefixLengthValue = prefixLength; return Self; } + /// + /// The term to match. + /// public IntervalsFuzzyDescriptor Term(string term) { TermValue = term; return Self; } + /// + /// Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// public IntervalsFuzzyDescriptor Transpositions(bool? transpositions = true) { TranspositionsValue = transpositions; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsFuzzyDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { UseFieldValue = useField; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsFuzzyDescriptor UseField(Expression> useField) { UseFieldValue = useField; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsFuzzyDescriptor UseField(Expression> useField) { UseFieldValue = useField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsMatch.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsMatch.g.cs index c62870e220b..731532e5152 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsMatch.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsMatch.g.cs @@ -29,16 +29,39 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IntervalsMatch { + /// + /// Analyzer used to analyze terms in the query. + /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } + + /// + /// An optional interval filter. + /// [JsonInclude, JsonPropertyName("filter")] public Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? Filter { get; set; } + + /// + /// Maximum number of positions between the matching terms.
Terms further apart than this are not considered matches. + /// [JsonInclude, JsonPropertyName("max_gaps")] public int? MaxGaps { get; set; } + + /// + /// If `true`, matching terms must appear in their specified order. + /// [JsonInclude, JsonPropertyName("ordered")] public bool? Ordered { get; set; } + + /// + /// Text you wish to find in the provided field. + /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } + + /// + /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// [JsonInclude, JsonPropertyName("use_field")] public Elastic.Clients.Elasticsearch.Field? UseField { get; set; } } @@ -60,12 +83,18 @@ public IntervalsMatchDescriptor() : base() private string QueryValue { get; set; } private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } + /// + /// Analyzer used to analyze terms in the query. + /// public IntervalsMatchDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// An optional interval filter. + /// public IntervalsMatchDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? filter) { FilterDescriptor = null; @@ -90,30 +119,45 @@ public IntervalsMatchDescriptor Filter(Action + /// Maximum number of positions between the matching terms.
Terms further apart than this are not considered matches. + /// public IntervalsMatchDescriptor MaxGaps(int? maxGaps) { MaxGapsValue = maxGaps; return Self; } + /// + /// If `true`, matching terms must appear in their specified order. + /// public IntervalsMatchDescriptor Ordered(bool? ordered = true) { OrderedValue = ordered; return Self; } + /// + /// Text you wish to find in the provided field. + /// public IntervalsMatchDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsMatchDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { UseFieldValue = useField; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsMatchDescriptor UseField(Expression> useField) { UseFieldValue = useField; @@ -186,12 +230,18 @@ public IntervalsMatchDescriptor() : base() private string QueryValue { get; set; } private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } + /// + /// Analyzer used to analyze terms in the query. + /// public IntervalsMatchDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// An optional interval filter. + /// public IntervalsMatchDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.IntervalsFilter? filter) { FilterDescriptor = null; @@ -216,36 +266,54 @@ public IntervalsMatchDescriptor Filter(Action configu return Self; } + /// + /// Maximum number of positions between the matching terms.
Terms further apart than this are not considered matches. + /// public IntervalsMatchDescriptor MaxGaps(int? maxGaps) { MaxGapsValue = maxGaps; return Self; } + /// + /// If `true`, matching terms must appear in their specified order. + /// public IntervalsMatchDescriptor Ordered(bool? ordered = true) { OrderedValue = ordered; return Self; } + /// + /// Text you wish to find in the provided field. + /// public IntervalsMatchDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsMatchDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { UseFieldValue = useField; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsMatchDescriptor UseField(Expression> useField) { UseFieldValue = useField; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsMatchDescriptor UseField(Expression> useField) { UseFieldValue = useField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsPrefix.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsPrefix.g.cs index 686802fe4aa..0cac465b432 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsPrefix.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsPrefix.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IntervalsPrefix { + /// + /// Analyzer used to analyze the `prefix`. + /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } + + /// + /// Beginning characters of terms you wish to find in the top-level field. + /// [JsonInclude, JsonPropertyName("prefix")] public string Prefix { get; set; } + + /// + /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// [JsonInclude, JsonPropertyName("use_field")] public Elastic.Clients.Elasticsearch.Field? UseField { get; set; } } @@ -49,24 +60,36 @@ public IntervalsPrefixDescriptor() : base() private string PrefixValue { get; set; } private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } + /// + /// Analyzer used to analyze the `prefix`. + /// public IntervalsPrefixDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// Beginning characters of terms you wish to find in the top-level field. + /// public IntervalsPrefixDescriptor Prefix(string prefix) { PrefixValue = prefix; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsPrefixDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { UseFieldValue = useField; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsPrefixDescriptor UseField(Expression> useField) { UseFieldValue = useField; @@ -106,30 +129,45 @@ public IntervalsPrefixDescriptor() : base() private string PrefixValue { get; set; } private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } + /// + /// Analyzer used to analyze the `prefix`. + /// public IntervalsPrefixDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// Beginning characters of terms you wish to find in the top-level field. + /// public IntervalsPrefixDescriptor Prefix(string prefix) { PrefixValue = prefix; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsPrefixDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { UseFieldValue = useField; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsPrefixDescriptor UseField(Expression> useField) { UseFieldValue = useField; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsPrefixDescriptor UseField(Expression> useField) { UseFieldValue = useField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsWildcard.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsWildcard.g.cs index 1006dcf371e..e5aeab699f5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsWildcard.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/IntervalsWildcard.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class IntervalsWildcard { + /// + /// Analyzer used to analyze the `pattern`.
Defaults to the top-level field's analyzer. + /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } + + /// + /// Wildcard pattern used to find matching terms. + /// [JsonInclude, JsonPropertyName("pattern")] public string Pattern { get; set; } + + /// + /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// [JsonInclude, JsonPropertyName("use_field")] public Elastic.Clients.Elasticsearch.Field? UseField { get; set; } } @@ -49,24 +60,36 @@ public IntervalsWildcardDescriptor() : base() private string PatternValue { get; set; } private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } + /// + /// Analyzer used to analyze the `pattern`.
Defaults to the top-level field's analyzer. + /// public IntervalsWildcardDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// Wildcard pattern used to find matching terms. + /// public IntervalsWildcardDescriptor Pattern(string pattern) { PatternValue = pattern; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsWildcardDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { UseFieldValue = useField; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsWildcardDescriptor UseField(Expression> useField) { UseFieldValue = useField; @@ -106,30 +129,45 @@ public IntervalsWildcardDescriptor() : base() private string PatternValue { get; set; } private Elastic.Clients.Elasticsearch.Field? UseFieldValue { get; set; } + /// + /// Analyzer used to analyze the `pattern`.
Defaults to the top-level field's analyzer. + /// public IntervalsWildcardDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// Wildcard pattern used to find matching terms. + /// public IntervalsWildcardDescriptor Pattern(string pattern) { PatternValue = pattern; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsWildcardDescriptor UseField(Elastic.Clients.Elasticsearch.Field? useField) { UseFieldValue = useField; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsWildcardDescriptor UseField(Expression> useField) { UseFieldValue = useField; return Self; } + /// + /// If specified, match intervals from this field rather than the top-level field.
The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. + /// public IntervalsWildcardDescriptor UseField(Expression> useField) { UseFieldValue = useField; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/LikeDocument.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/LikeDocument.g.cs index 050447bf682..541b2937532 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/LikeDocument.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/LikeDocument.g.cs @@ -29,10 +29,21 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class LikeDocument { + /// + /// ID of a document. + /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } + + /// + /// Index of a document. + /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } + + /// + /// A document not present in the index. + /// [JsonInclude, JsonPropertyName("doc")] public object? Doc { get; set; } [JsonInclude, JsonPropertyName("fields")] @@ -64,18 +75,27 @@ public LikeDocumentDescriptor() : base() private long? VersionValue { get; set; } private Elastic.Clients.Elasticsearch.VersionType? VersionTypeValue { get; set; } + /// + /// ID of a document. + /// public LikeDocumentDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { IdValue = id; return Self; } + /// + /// Index of a document. + /// public LikeDocumentDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { IndexValue = index; return Self; } + /// + /// A document not present in the index. + /// public LikeDocumentDescriptor Doc(object? doc) { DocValue = doc; @@ -184,18 +204,27 @@ public LikeDocumentDescriptor() : base() private long? VersionValue { get; set; } private Elastic.Clients.Elasticsearch.VersionType? VersionTypeValue { get; set; } + /// + /// ID of a document. + /// public LikeDocumentDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { IdValue = id; return Self; } + /// + /// Index of a document. + /// public LikeDocumentDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { IndexValue = index; return Self; } + /// + /// A document not present in the index. + /// public LikeDocumentDescriptor Doc(object? doc) { DocValue = doc; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchBoolPrefixQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchBoolPrefixQuery.g.cs index be101535f53..cd0a6354ccf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchBoolPrefixQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchBoolPrefixQuery.g.cs @@ -205,15 +205,51 @@ public MatchBoolPrefixQuery(Field field) } public string? QueryName { get; set; } + + /// + /// Analyzer used to convert the text in the query value into tokens. + /// public string? Analyzer { get; set; } public float? Boost { get; set; } + + /// + /// Maximum edit distance allowed for matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } + + /// + /// Method used to rewrite the query.
Can be applied to the term subqueries constructed for all terms but the final term. + /// public string? FuzzyRewrite { get; set; } + + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// public bool? FuzzyTranspositions { get; set; } + + /// + /// Maximum number of terms to which the query will expand.
Can be applied to the term subqueries constructed for all terms but the final term. + /// public int? MaxExpansions { get; set; } + + /// + /// Minimum number of clauses that must match for a document to be returned.
Applied to the constructed bool query. + /// public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } + + /// + /// Boolean logic used to interpret text in the query value.
Applied to the constructed bool query. + /// public Elastic.Clients.Elasticsearch.QueryDsl.Operator? Operator { get; set; } + + /// + /// Number of beginning characters left unchanged for fuzzy matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// public int? PrefixLength { get; set; } + + /// + /// Terms you wish to find in the provided field.
The last term is used in a prefix query. + /// public string Query { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -263,6 +299,9 @@ public MatchBoolPrefixQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// Analyzer used to convert the text in the query value into tokens. + /// public MatchBoolPrefixQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; @@ -287,48 +326,72 @@ public MatchBoolPrefixQueryDescriptor Field(Expression + /// Maximum edit distance allowed for matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// public MatchBoolPrefixQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { FuzzinessValue = fuzziness; return Self; } + /// + /// Method used to rewrite the query.
Can be applied to the term subqueries constructed for all terms but the final term. + /// public MatchBoolPrefixQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { FuzzyRewriteValue = fuzzyRewrite; return Self; } + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// public MatchBoolPrefixQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { FuzzyTranspositionsValue = fuzzyTranspositions; return Self; } + /// + /// Maximum number of terms to which the query will expand.
Can be applied to the term subqueries constructed for all terms but the final term. + /// public MatchBoolPrefixQueryDescriptor MaxExpansions(int? maxExpansions) { MaxExpansionsValue = maxExpansions; return Self; } + /// + /// Minimum number of clauses that must match for a document to be returned.
Applied to the constructed bool query. + /// public MatchBoolPrefixQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Boolean logic used to interpret text in the query value.
Applied to the constructed bool query. + /// public MatchBoolPrefixQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? op) { OperatorValue = op; return Self; } + /// + /// Number of beginning characters left unchanged for fuzzy matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// public MatchBoolPrefixQueryDescriptor PrefixLength(int? prefixLength) { PrefixLengthValue = prefixLength; return Self; } + /// + /// Terms you wish to find in the provided field.
The last term is used in a prefix query. + /// public MatchBoolPrefixQueryDescriptor Query(string query) { QueryValue = query; @@ -443,6 +506,9 @@ public MatchBoolPrefixQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// Analyzer used to convert the text in the query value into tokens. + /// public MatchBoolPrefixQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; @@ -473,48 +539,72 @@ public MatchBoolPrefixQueryDescriptor Field(Expression + /// Maximum edit distance allowed for matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// public MatchBoolPrefixQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { FuzzinessValue = fuzziness; return Self; } + /// + /// Method used to rewrite the query.
Can be applied to the term subqueries constructed for all terms but the final term. + /// public MatchBoolPrefixQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { FuzzyRewriteValue = fuzzyRewrite; return Self; } + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// public MatchBoolPrefixQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { FuzzyTranspositionsValue = fuzzyTranspositions; return Self; } + /// + /// Maximum number of terms to which the query will expand.
Can be applied to the term subqueries constructed for all terms but the final term. + /// public MatchBoolPrefixQueryDescriptor MaxExpansions(int? maxExpansions) { MaxExpansionsValue = maxExpansions; return Self; } + /// + /// Minimum number of clauses that must match for a document to be returned.
Applied to the constructed bool query. + /// public MatchBoolPrefixQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Boolean logic used to interpret text in the query value.
Applied to the constructed bool query. + /// public MatchBoolPrefixQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? op) { OperatorValue = op; return Self; } + /// + /// Number of beginning characters left unchanged for fuzzy matching.
Can be applied to the term subqueries constructed for all terms but the final term. + /// public MatchBoolPrefixQueryDescriptor PrefixLength(int? prefixLength) { PrefixLengthValue = prefixLength; return Self; } + /// + /// Terms you wish to find in the provided field.
The last term is used in a prefix query. + /// public MatchBoolPrefixQueryDescriptor Query(string query) { QueryValue = query; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhrasePrefixQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhrasePrefixQuery.g.cs index 812396cb38d..43dc39ce5f5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhrasePrefixQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhrasePrefixQuery.g.cs @@ -157,11 +157,31 @@ public MatchPhrasePrefixQuery(Field field) } public string? QueryName { get; set; } + + /// + /// Analyzer used to convert text in the query value into tokens. + /// public string? Analyzer { get; set; } public float? Boost { get; set; } + + /// + /// Maximum number of terms to which the last provided term of the query value will expand. + /// public int? MaxExpansions { get; set; } + + /// + /// Text you wish to find in the provided field. + /// public string Query { get; set; } + + /// + /// Maximum number of positions allowed between matching tokens. + /// public int? Slop { get; set; } + + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// public Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQuery { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -207,6 +227,9 @@ public MatchPhrasePrefixQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// Analyzer used to convert text in the query value into tokens. + /// public MatchPhrasePrefixQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; @@ -231,24 +254,36 @@ public MatchPhrasePrefixQueryDescriptor Field(Expression + /// Maximum number of terms to which the last provided term of the query value will expand. + /// public MatchPhrasePrefixQueryDescriptor MaxExpansions(int? maxExpansions) { MaxExpansionsValue = maxExpansions; return Self; } + /// + /// Text you wish to find in the provided field. + /// public MatchPhrasePrefixQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Maximum number of positions allowed between matching tokens. + /// public MatchPhrasePrefixQueryDescriptor Slop(int? slop) { SlopValue = slop; return Self; } + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// public MatchPhrasePrefixQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { ZeroTermsQueryValue = zeroTermsQuery; @@ -335,6 +370,9 @@ public MatchPhrasePrefixQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// Analyzer used to convert text in the query value into tokens. + /// public MatchPhrasePrefixQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; @@ -365,24 +403,36 @@ public MatchPhrasePrefixQueryDescriptor Field(Expression + /// Maximum number of terms to which the last provided term of the query value will expand. + /// public MatchPhrasePrefixQueryDescriptor MaxExpansions(int? maxExpansions) { MaxExpansionsValue = maxExpansions; return Self; } + /// + /// Text you wish to find in the provided field. + /// public MatchPhrasePrefixQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Maximum number of positions allowed between matching tokens. + /// public MatchPhrasePrefixQueryDescriptor Slop(int? slop) { SlopValue = slop; return Self; } + /// + /// Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. + /// public MatchPhrasePrefixQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { ZeroTermsQueryValue = zeroTermsQuery; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhraseQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhraseQuery.g.cs index e52fa0cd14f..d0e137b8a10 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhraseQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchPhraseQuery.g.cs @@ -145,10 +145,26 @@ public MatchPhraseQuery(Field field) } public string? QueryName { get; set; } + + /// + /// Analyzer used to convert the text in the query value into tokens. + /// public string? Analyzer { get; set; } public float? Boost { get; set; } + + /// + /// Query terms that are analyzed and turned into a phrase query. + /// public string Query { get; set; } + + /// + /// Maximum number of positions allowed between matching tokens. + /// public int? Slop { get; set; } + + /// + /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// public Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQuery { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -193,6 +209,9 @@ public MatchPhraseQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// Analyzer used to convert the text in the query value into tokens. + /// public MatchPhraseQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; @@ -217,18 +236,27 @@ public MatchPhraseQueryDescriptor Field(Expression + /// Query terms that are analyzed and turned into a phrase query. + /// public MatchPhraseQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Maximum number of positions allowed between matching tokens. + /// public MatchPhraseQueryDescriptor Slop(int? slop) { SlopValue = slop; return Self; } + /// + /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// public MatchPhraseQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { ZeroTermsQueryValue = zeroTermsQuery; @@ -308,6 +336,9 @@ public MatchPhraseQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// Analyzer used to convert the text in the query value into tokens. + /// public MatchPhraseQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; @@ -338,18 +369,27 @@ public MatchPhraseQueryDescriptor Field(Expression + /// Query terms that are analyzed and turned into a phrase query. + /// public MatchPhraseQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Maximum number of positions allowed between matching tokens. + /// public MatchPhraseQueryDescriptor Slop(int? slop) { SlopValue = slop; return Self; } + /// + /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// public MatchPhraseQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { ZeroTermsQueryValue = zeroTermsQuery; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchQuery.g.cs index 4334d164f6e..afa19135ea5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MatchQuery.g.cs @@ -241,18 +241,66 @@ public MatchQuery(Field field) } public string? QueryName { get; set; } + + /// + /// Analyzer used to convert the text in the query value into tokens. + /// public string? Analyzer { get; set; } + + /// + /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// public bool? AutoGenerateSynonymsPhraseQuery { get; set; } public float? Boost { get; set; } + + /// + /// Maximum edit distance allowed for matching. + /// public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } + + /// + /// Method used to rewrite the query. + /// public string? FuzzyRewrite { get; set; } + + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// public bool? FuzzyTranspositions { get; set; } + + /// + /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// public bool? Lenient { get; set; } + + /// + /// Maximum number of terms to which the query will expand. + /// public int? MaxExpansions { get; set; } + + /// + /// Minimum number of clauses that must match for a document to be returned. + /// public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } + + /// + /// Boolean logic used to interpret text in the query value. + /// public Elastic.Clients.Elasticsearch.QueryDsl.Operator? Operator { get; set; } + + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// public int? PrefixLength { get; set; } + + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// public string Query { get; set; } + + /// + /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// public Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQuery { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -305,12 +353,18 @@ public MatchQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// Analyzer used to convert the text in the query value into tokens. + /// public MatchQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// public MatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { AutoGenerateSynonymsPhraseQueryValue = autoGenerateSynonymsPhraseQuery; @@ -335,60 +389,90 @@ public MatchQueryDescriptor Field(Expression + /// Maximum edit distance allowed for matching. + /// public MatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { FuzzinessValue = fuzziness; return Self; } + /// + /// Method used to rewrite the query. + /// public MatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { FuzzyRewriteValue = fuzzyRewrite; return Self; } + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// public MatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { FuzzyTranspositionsValue = fuzzyTranspositions; return Self; } + /// + /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// public MatchQueryDescriptor Lenient(bool? lenient = true) { LenientValue = lenient; return Self; } + /// + /// Maximum number of terms to which the query will expand. + /// public MatchQueryDescriptor MaxExpansions(int? maxExpansions) { MaxExpansionsValue = maxExpansions; return Self; } + /// + /// Minimum number of clauses that must match for a document to be returned. + /// public MatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Boolean logic used to interpret text in the query value. + /// public MatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? op) { OperatorValue = op; return Self; } + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// public MatchQueryDescriptor PrefixLength(int? prefixLength) { PrefixLengthValue = prefixLength; return Self; } + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// public MatchQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// public MatchQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { ZeroTermsQueryValue = zeroTermsQuery; @@ -524,12 +608,18 @@ public MatchQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// Analyzer used to convert the text in the query value into tokens. + /// public MatchQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// public MatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { AutoGenerateSynonymsPhraseQueryValue = autoGenerateSynonymsPhraseQuery; @@ -560,60 +650,90 @@ public MatchQueryDescriptor Field(Expression> return Self; } + /// + /// Maximum edit distance allowed for matching. + /// public MatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { FuzzinessValue = fuzziness; return Self; } + /// + /// Method used to rewrite the query. + /// public MatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { FuzzyRewriteValue = fuzzyRewrite; return Self; } + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// public MatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { FuzzyTranspositionsValue = fuzzyTranspositions; return Self; } + /// + /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// public MatchQueryDescriptor Lenient(bool? lenient = true) { LenientValue = lenient; return Self; } + /// + /// Maximum number of terms to which the query will expand. + /// public MatchQueryDescriptor MaxExpansions(int? maxExpansions) { MaxExpansionsValue = maxExpansions; return Self; } + /// + /// Minimum number of clauses that must match for a document to be returned. + /// public MatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Boolean logic used to interpret text in the query value. + /// public MatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? op) { OperatorValue = op; return Self; } + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// public MatchQueryDescriptor PrefixLength(int? prefixLength) { PrefixLengthValue = prefixLength; return Self; } + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// public MatchQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// public MatchQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { ZeroTermsQueryValue = zeroTermsQuery; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MoreLikeThisQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MoreLikeThisQuery.g.cs index ff88b0b19d5..293cef031e8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MoreLikeThisQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MoreLikeThisQuery.g.cs @@ -31,41 +31,105 @@ public sealed partial class MoreLikeThisQuery : SearchQuery { [JsonInclude, JsonPropertyName("_name")] public string? QueryName { get; set; } + + /// + /// The analyzer that is used to analyze the free form text.
Defaults to the analyzer associated with the first field in fields. + /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Each term in the formed query could be further boosted by their tf-idf score.
This sets the boost factor to use when using this feature.
Defaults to deactivated (0). + /// [JsonInclude, JsonPropertyName("boost_terms")] public double? BoostTerms { get; set; } + + /// + /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). + /// [JsonInclude, JsonPropertyName("fail_on_unsupported_field")] public bool? FailOnUnsupportedField { get; set; } + + /// + /// A list of fields to fetch and analyze the text from.
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// [JsonInclude, JsonPropertyName("fields")] public Fields? Fields { get; set; } + + /// + /// Specifies whether the input documents should also be included in the search results returned. + /// [JsonInclude, JsonPropertyName("include")] public bool? Include { get; set; } + + /// + /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// [JsonInclude, JsonPropertyName("like"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Like))] public ICollection Like { get; set; } + + /// + /// The maximum document frequency above which the terms are ignored from the input document. + /// [JsonInclude, JsonPropertyName("max_doc_freq")] public int? MaxDocFreq { get; set; } + + /// + /// The maximum number of query terms that can be selected. + /// [JsonInclude, JsonPropertyName("max_query_terms")] public int? MaxQueryTerms { get; set; } + + /// + /// The maximum word length above which the terms are ignored.
Defaults to unbounded (`0`). + /// [JsonInclude, JsonPropertyName("max_word_length")] public int? MaxWordLength { get; set; } + + /// + /// The minimum document frequency below which the terms are ignored from the input document. + /// [JsonInclude, JsonPropertyName("min_doc_freq")] public int? MinDocFreq { get; set; } + + /// + /// The minimum term frequency below which the terms are ignored from the input document. + /// [JsonInclude, JsonPropertyName("min_term_freq")] public int? MinTermFreq { get; set; } + + /// + /// The minimum word length below which the terms are ignored. + /// [JsonInclude, JsonPropertyName("min_word_length")] public int? MinWordLength { get; set; } + + /// + /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } + + /// + /// Overrides the default analyzer. + /// [JsonInclude, JsonPropertyName("per_field_analyzer")] public IDictionary? PerFieldAnalyzer { get; set; } [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } + + /// + /// An array of stop words.
Any word in this set is ignored. + /// [JsonInclude, JsonPropertyName("stop_words")] [JsonConverter(typeof(StopWordsConverter))] public ICollection? StopWords { get; set; } + + /// + /// Used in combination with `like` to exclude documents that match a set of terms. + /// [JsonInclude, JsonPropertyName("unlike"), SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Like))] public ICollection? Unlike { get; set; } [JsonInclude, JsonPropertyName("version")] @@ -114,6 +178,9 @@ public MoreLikeThisQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// The analyzer that is used to analyze the free form text.
Defaults to the analyzer associated with the first field in fields. + /// public MoreLikeThisQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; @@ -126,78 +193,117 @@ public MoreLikeThisQueryDescriptor Boost(float? boost) return Self; } + /// + /// Each term in the formed query could be further boosted by their tf-idf score.
This sets the boost factor to use when using this feature.
Defaults to deactivated (0). + /// public MoreLikeThisQueryDescriptor BoostTerms(double? boostTerms) { BoostTermsValue = boostTerms; return Self; } + /// + /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). + /// public MoreLikeThisQueryDescriptor FailOnUnsupportedField(bool? failOnUnsupportedField = true) { FailOnUnsupportedFieldValue = failOnUnsupportedField; return Self; } + /// + /// A list of fields to fetch and analyze the text from.
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// public MoreLikeThisQueryDescriptor Fields(Fields? fields) { FieldsValue = fields; return Self; } + /// + /// Specifies whether the input documents should also be included in the search results returned. + /// public MoreLikeThisQueryDescriptor Include(bool? include = true) { IncludeValue = include; return Self; } + /// + /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// public MoreLikeThisQueryDescriptor Like(ICollection like) { LikeValue = like; return Self; } + /// + /// The maximum document frequency above which the terms are ignored from the input document. + /// public MoreLikeThisQueryDescriptor MaxDocFreq(int? maxDocFreq) { MaxDocFreqValue = maxDocFreq; return Self; } + /// + /// The maximum number of query terms that can be selected. + /// public MoreLikeThisQueryDescriptor MaxQueryTerms(int? maxQueryTerms) { MaxQueryTermsValue = maxQueryTerms; return Self; } + /// + /// The maximum word length above which the terms are ignored.
Defaults to unbounded (`0`). + /// public MoreLikeThisQueryDescriptor MaxWordLength(int? maxWordLength) { MaxWordLengthValue = maxWordLength; return Self; } + /// + /// The minimum document frequency below which the terms are ignored from the input document. + /// public MoreLikeThisQueryDescriptor MinDocFreq(int? minDocFreq) { MinDocFreqValue = minDocFreq; return Self; } + /// + /// The minimum term frequency below which the terms are ignored from the input document. + /// public MoreLikeThisQueryDescriptor MinTermFreq(int? minTermFreq) { MinTermFreqValue = minTermFreq; return Self; } + /// + /// The minimum word length below which the terms are ignored. + /// public MoreLikeThisQueryDescriptor MinWordLength(int? minWordLength) { MinWordLengthValue = minWordLength; return Self; } + /// + /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// public MoreLikeThisQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Overrides the default analyzer. + /// public MoreLikeThisQueryDescriptor PerFieldAnalyzer(Func, FluentDictionary> selector) { PerFieldAnalyzerValue = selector?.Invoke(new FluentDictionary()); @@ -210,12 +316,18 @@ public MoreLikeThisQueryDescriptor Routing(Elastic.Clients.Elasticsea return Self; } + /// + /// An array of stop words.
Any word in this set is ignored. + /// public MoreLikeThisQueryDescriptor StopWords(ICollection? stopWords) { StopWordsValue = stopWords; return Self; } + /// + /// Used in combination with `like` to exclude documents that match a set of terms. + /// public MoreLikeThisQueryDescriptor Unlike(ICollection? unlike) { UnlikeValue = unlike; @@ -399,6 +511,9 @@ public MoreLikeThisQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// The analyzer that is used to analyze the free form text.
Defaults to the analyzer associated with the first field in fields. + /// public MoreLikeThisQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; @@ -411,78 +526,117 @@ public MoreLikeThisQueryDescriptor Boost(float? boost) return Self; } + /// + /// Each term in the formed query could be further boosted by their tf-idf score.
This sets the boost factor to use when using this feature.
Defaults to deactivated (0). + /// public MoreLikeThisQueryDescriptor BoostTerms(double? boostTerms) { BoostTermsValue = boostTerms; return Self; } + /// + /// Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). + /// public MoreLikeThisQueryDescriptor FailOnUnsupportedField(bool? failOnUnsupportedField = true) { FailOnUnsupportedFieldValue = failOnUnsupportedField; return Self; } + /// + /// A list of fields to fetch and analyze the text from.
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// public MoreLikeThisQueryDescriptor Fields(Fields? fields) { FieldsValue = fields; return Self; } + /// + /// Specifies whether the input documents should also be included in the search results returned. + /// public MoreLikeThisQueryDescriptor Include(bool? include = true) { IncludeValue = include; return Self; } + /// + /// Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + /// public MoreLikeThisQueryDescriptor Like(ICollection like) { LikeValue = like; return Self; } + /// + /// The maximum document frequency above which the terms are ignored from the input document. + /// public MoreLikeThisQueryDescriptor MaxDocFreq(int? maxDocFreq) { MaxDocFreqValue = maxDocFreq; return Self; } + /// + /// The maximum number of query terms that can be selected. + /// public MoreLikeThisQueryDescriptor MaxQueryTerms(int? maxQueryTerms) { MaxQueryTermsValue = maxQueryTerms; return Self; } + /// + /// The maximum word length above which the terms are ignored.
Defaults to unbounded (`0`). + /// public MoreLikeThisQueryDescriptor MaxWordLength(int? maxWordLength) { MaxWordLengthValue = maxWordLength; return Self; } + /// + /// The minimum document frequency below which the terms are ignored from the input document. + /// public MoreLikeThisQueryDescriptor MinDocFreq(int? minDocFreq) { MinDocFreqValue = minDocFreq; return Self; } + /// + /// The minimum term frequency below which the terms are ignored from the input document. + /// public MoreLikeThisQueryDescriptor MinTermFreq(int? minTermFreq) { MinTermFreqValue = minTermFreq; return Self; } + /// + /// The minimum word length below which the terms are ignored. + /// public MoreLikeThisQueryDescriptor MinWordLength(int? minWordLength) { MinWordLengthValue = minWordLength; return Self; } + /// + /// After the disjunctive query has been formed, this parameter controls the number of terms that must match. + /// public MoreLikeThisQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Overrides the default analyzer. + /// public MoreLikeThisQueryDescriptor PerFieldAnalyzer(Func, FluentDictionary> selector) { PerFieldAnalyzerValue = selector?.Invoke(new FluentDictionary()); @@ -495,12 +649,18 @@ public MoreLikeThisQueryDescriptor Routing(Elastic.Clients.Elasticsearch.Routing return Self; } + /// + /// An array of stop words.
Any word in this set is ignored. + /// public MoreLikeThisQueryDescriptor StopWords(ICollection? stopWords) { StopWordsValue = stopWords; return Self; } + /// + /// Used in combination with `like` to exclude documents that match a set of terms. + /// public MoreLikeThisQueryDescriptor Unlike(ICollection? unlike) { UnlikeValue = unlike; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MultiMatchQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MultiMatchQuery.g.cs index 5d5e24caeb3..fb7d3b17848 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MultiMatchQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/MultiMatchQuery.g.cs @@ -31,38 +31,102 @@ public sealed partial class MultiMatchQuery : SearchQuery { [JsonInclude, JsonPropertyName("_name")] public string? QueryName { get; set; } + + /// + /// Analyzer used to convert the text in the query value into tokens. + /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } + + /// + /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// [JsonInclude, JsonPropertyName("auto_generate_synonyms_phrase_query")] public bool? AutoGenerateSynonymsPhraseQuery { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// The fields to be queried.
Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`. + /// [JsonInclude, JsonPropertyName("fields")] public Elastic.Clients.Elasticsearch.Fields? Fields { get; set; } + + /// + /// Maximum edit distance allowed for matching. + /// [JsonInclude, JsonPropertyName("fuzziness")] public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } + + /// + /// Method used to rewrite the query. + /// [JsonInclude, JsonPropertyName("fuzzy_rewrite")] public string? FuzzyRewrite { get; set; } + + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// [JsonInclude, JsonPropertyName("fuzzy_transpositions")] public bool? FuzzyTranspositions { get; set; } + + /// + /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// [JsonInclude, JsonPropertyName("lenient")] public bool? Lenient { get; set; } + + /// + /// Maximum number of terms to which the query will expand. + /// [JsonInclude, JsonPropertyName("max_expansions")] public int? MaxExpansions { get; set; } + + /// + /// Minimum number of clauses that must match for a document to be returned. + /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } + + /// + /// Boolean logic used to interpret text in the query value. + /// [JsonInclude, JsonPropertyName("operator")] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? Operator { get; set; } + + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// [JsonInclude, JsonPropertyName("prefix_length")] public int? PrefixLength { get; set; } + + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } + + /// + /// Maximum number of positions allowed between matching tokens. + /// [JsonInclude, JsonPropertyName("slop")] public int? Slop { get; set; } + + /// + /// Determines how scores for each per-term blended query and scores across groups are combined. + /// [JsonInclude, JsonPropertyName("tie_breaker")] public double? TieBreaker { get; set; } + + /// + /// How `the` multi_match query is executed internally. + /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? Type { get; set; } + + /// + /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// [JsonInclude, JsonPropertyName("zero_terms_query")] public Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? ZeroTermsQuery { get; set; } @@ -104,12 +168,18 @@ public MultiMatchQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// Analyzer used to convert the text in the query value into tokens. + /// public MultiMatchQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// public MultiMatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { AutoGenerateSynonymsPhraseQueryValue = autoGenerateSynonymsPhraseQuery; @@ -122,84 +192,126 @@ public MultiMatchQueryDescriptor Boost(float? boost) return Self; } + /// + /// The fields to be queried.
Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`. + /// public MultiMatchQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { FieldsValue = fields; return Self; } + /// + /// Maximum edit distance allowed for matching. + /// public MultiMatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { FuzzinessValue = fuzziness; return Self; } + /// + /// Method used to rewrite the query. + /// public MultiMatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { FuzzyRewriteValue = fuzzyRewrite; return Self; } + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// public MultiMatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { FuzzyTranspositionsValue = fuzzyTranspositions; return Self; } + /// + /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// public MultiMatchQueryDescriptor Lenient(bool? lenient = true) { LenientValue = lenient; return Self; } + /// + /// Maximum number of terms to which the query will expand. + /// public MultiMatchQueryDescriptor MaxExpansions(int? maxExpansions) { MaxExpansionsValue = maxExpansions; return Self; } + /// + /// Minimum number of clauses that must match for a document to be returned. + /// public MultiMatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Boolean logic used to interpret text in the query value. + /// public MultiMatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? op) { OperatorValue = op; return Self; } + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// public MultiMatchQueryDescriptor PrefixLength(int? prefixLength) { PrefixLengthValue = prefixLength; return Self; } + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// public MultiMatchQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Maximum number of positions allowed between matching tokens. + /// public MultiMatchQueryDescriptor Slop(int? slop) { SlopValue = slop; return Self; } + /// + /// Determines how scores for each per-term blended query and scores across groups are combined. + /// public MultiMatchQueryDescriptor TieBreaker(double? tieBreaker) { TieBreakerValue = tieBreaker; return Self; } + /// + /// How `the` multi_match query is executed internally. + /// public MultiMatchQueryDescriptor Type(Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? type) { TypeValue = type; return Self; } + /// + /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// public MultiMatchQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { ZeroTermsQueryValue = zeroTermsQuery; @@ -350,12 +462,18 @@ public MultiMatchQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// Analyzer used to convert the text in the query value into tokens. + /// public MultiMatchQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// public MultiMatchQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { AutoGenerateSynonymsPhraseQueryValue = autoGenerateSynonymsPhraseQuery; @@ -368,84 +486,126 @@ public MultiMatchQueryDescriptor Boost(float? boost) return Self; } + /// + /// The fields to be queried.
Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`. + /// public MultiMatchQueryDescriptor Fields(Elastic.Clients.Elasticsearch.Fields? fields) { FieldsValue = fields; return Self; } + /// + /// Maximum edit distance allowed for matching. + /// public MultiMatchQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { FuzzinessValue = fuzziness; return Self; } + /// + /// Method used to rewrite the query. + /// public MultiMatchQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { FuzzyRewriteValue = fuzzyRewrite; return Self; } + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
Can be applied to the term subqueries constructed for all terms but the final term. + /// public MultiMatchQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { FuzzyTranspositionsValue = fuzzyTranspositions; return Self; } + /// + /// If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + /// public MultiMatchQueryDescriptor Lenient(bool? lenient = true) { LenientValue = lenient; return Self; } + /// + /// Maximum number of terms to which the query will expand. + /// public MultiMatchQueryDescriptor MaxExpansions(int? maxExpansions) { MaxExpansionsValue = maxExpansions; return Self; } + /// + /// Minimum number of clauses that must match for a document to be returned. + /// public MultiMatchQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Boolean logic used to interpret text in the query value. + /// public MultiMatchQueryDescriptor Operator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? op) { OperatorValue = op; return Self; } + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// public MultiMatchQueryDescriptor PrefixLength(int? prefixLength) { PrefixLengthValue = prefixLength; return Self; } + /// + /// Text, number, boolean value or date you wish to find in the provided field. + /// public MultiMatchQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Maximum number of positions allowed between matching tokens. + /// public MultiMatchQueryDescriptor Slop(int? slop) { SlopValue = slop; return Self; } + /// + /// Determines how scores for each per-term blended query and scores across groups are combined. + /// public MultiMatchQueryDescriptor TieBreaker(double? tieBreaker) { TieBreakerValue = tieBreaker; return Self; } + /// + /// How `the` multi_match query is executed internally. + /// public MultiMatchQueryDescriptor Type(Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? type) { TypeValue = type; return Self; } + /// + /// Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. + /// public MultiMatchQueryDescriptor ZeroTermsQuery(Elastic.Clients.Elasticsearch.QueryDsl.ZeroTermsQuery? zeroTermsQuery) { ZeroTermsQueryValue = zeroTermsQuery; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NestedQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NestedQuery.g.cs index 2c88e1b3ba3..5277e8c2a55 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NestedQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NestedQuery.g.cs @@ -33,14 +33,34 @@ public sealed partial class NestedQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } + + /// + /// If defined, each search hit will contain inner hits. + /// [JsonInclude, JsonPropertyName("inner_hits")] public Elastic.Clients.Elasticsearch.Core.Search.InnerHits? InnerHits { get; set; } + + /// + /// Path to the nested object you wish to search. + /// [JsonInclude, JsonPropertyName("path")] public Elastic.Clients.Elasticsearch.Field Path { get; set; } + + /// + /// Query you wish to run on nested objects in the path. + /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } + + /// + /// How scores for matching child objects affect the root parent document’s relevance score. + /// [JsonInclude, JsonPropertyName("score_mode")] public Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? ScoreMode { get; set; } @@ -69,6 +89,9 @@ public NestedQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Field PathValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? ScoreModeValue { get; set; } + /// + /// If defined, each search hit will contain inner hits. + /// public NestedQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { InnerHitsDescriptor = null; @@ -93,6 +116,9 @@ public NestedQueryDescriptor InnerHits(Action + /// Query you wish to run on nested objects in the path. + /// public NestedQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { QueryDescriptor = null; @@ -129,24 +155,36 @@ public NestedQueryDescriptor Boost(float? boost) return Self; } + /// + /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// public NestedQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { IgnoreUnmappedValue = ignoreUnmapped; return Self; } + /// + /// Path to the nested object you wish to search. + /// public NestedQueryDescriptor Path(Elastic.Clients.Elasticsearch.Field path) { PathValue = path; return Self; } + /// + /// Path to the nested object you wish to search. + /// public NestedQueryDescriptor Path(Expression> path) { PathValue = path; return Self; } + /// + /// How scores for matching child objects affect the root parent document’s relevance score. + /// public NestedQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? scoreMode) { ScoreModeValue = scoreMode; @@ -238,6 +276,9 @@ public NestedQueryDescriptor() : base() private Elastic.Clients.Elasticsearch.Field PathValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? ScoreModeValue { get; set; } + /// + /// If defined, each search hit will contain inner hits. + /// public NestedQueryDescriptor InnerHits(Elastic.Clients.Elasticsearch.Core.Search.InnerHits? innerHits) { InnerHitsDescriptor = null; @@ -262,6 +303,9 @@ public NestedQueryDescriptor InnerHits(Action c return Self; } + /// + /// Query you wish to run on nested objects in the path. + /// public NestedQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { QueryDescriptor = null; @@ -298,30 +342,45 @@ public NestedQueryDescriptor Boost(float? boost) return Self; } + /// + /// Indicates whether to ignore an unmapped path and not return any documents instead of an error. + /// public NestedQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { IgnoreUnmappedValue = ignoreUnmapped; return Self; } + /// + /// Path to the nested object you wish to search. + /// public NestedQueryDescriptor Path(Elastic.Clients.Elasticsearch.Field path) { PathValue = path; return Self; } + /// + /// Path to the nested object you wish to search. + /// public NestedQueryDescriptor Path(Expression> path) { PathValue = path; return Self; } + /// + /// Path to the nested object you wish to search. + /// public NestedQueryDescriptor Path(Expression> path) { PathValue = path; return Self; } + /// + /// How scores for matching child objects affect the root parent document’s relevance score. + /// public NestedQueryDescriptor ScoreMode(Elastic.Clients.Elasticsearch.QueryDsl.ChildScoreMode? scoreMode) { ScoreModeValue = scoreMode; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs index a5ca062b67a..fe9bb03c0d5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs @@ -187,9 +187,25 @@ public NumberRangeQuery(Field field) public string? QueryName { get; set; } public float? Boost { get; set; } public double? From { get; set; } + + /// + /// Greater than. + /// public double? Gt { get; set; } + + /// + /// Greater than or equal to. + /// public double? Gte { get; set; } + + /// + /// Less than. + /// public double? Lt { get; set; } + + /// + /// Less than or equal to. + /// public double? Lte { get; set; } public Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? Relation { get; set; } public double? To { get; set; } @@ -263,24 +279,36 @@ public NumberRangeQueryDescriptor From(double? from) return Self; } + /// + /// Greater than. + /// public NumberRangeQueryDescriptor Gt(double? gt) { GtValue = gt; return Self; } + /// + /// Greater than or equal to. + /// public NumberRangeQueryDescriptor Gte(double? gte) { GteValue = gte; return Self; } + /// + /// Less than. + /// public NumberRangeQueryDescriptor Lt(double? lt) { LtValue = lt; return Self; } + /// + /// Less than or equal to. + /// public NumberRangeQueryDescriptor Lte(double? lte) { LteValue = lte; @@ -427,24 +455,36 @@ public NumberRangeQueryDescriptor From(double? from) return Self; } + /// + /// Greater than. + /// public NumberRangeQueryDescriptor Gt(double? gt) { GtValue = gt; return Self; } + /// + /// Greater than or equal to. + /// public NumberRangeQueryDescriptor Gte(double? gte) { GteValue = gte; return Self; } + /// + /// Less than. + /// public NumberRangeQueryDescriptor Lt(double? lt) { LtValue = lt; return Self; } + /// + /// Less than or equal to. + /// public NumberRangeQueryDescriptor Lte(double? lte) { LteValue = lte; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ParentIdQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ParentIdQuery.g.cs index 7a7a6bac75d..7d32964305d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ParentIdQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ParentIdQuery.g.cs @@ -33,10 +33,22 @@ public sealed partial class ParentIdQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// ID of the parent document. + /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } + + /// + /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// [JsonInclude, JsonPropertyName("ignore_unmapped")] public bool? IgnoreUnmapped { get; set; } + + /// + /// Name of the child relationship mapped for the `join` field. + /// [JsonInclude, JsonPropertyName("type")] public string? Type { get; set; } @@ -71,18 +83,27 @@ public ParentIdQueryDescriptor Boost(float? boost) return Self; } + /// + /// ID of the parent document. + /// public ParentIdQueryDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { IdValue = id; return Self; } + /// + /// Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + /// public ParentIdQueryDescriptor IgnoreUnmapped(bool? ignoreUnmapped = true) { IgnoreUnmappedValue = ignoreUnmapped; return Self; } + /// + /// Name of the child relationship mapped for the `join` field. + /// public ParentIdQueryDescriptor Type(string? type) { TypeValue = type; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PercolateQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PercolateQuery.g.cs index 8405c0bd1ce..3d2117d9189 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PercolateQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PercolateQuery.g.cs @@ -33,22 +33,58 @@ public sealed partial class PercolateQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// The source of the document being percolated. + /// [JsonInclude, JsonPropertyName("document")] public object? Document { get; set; } + + /// + /// An array of sources of the documents being percolated. + /// [JsonInclude, JsonPropertyName("documents")] public ICollection? Documents { get; set; } + + /// + /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } + + /// + /// The ID of a stored document to percolate. + /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id? Id { get; set; } + + /// + /// The index of a stored document to percolate. + /// [JsonInclude, JsonPropertyName("index")] public Elastic.Clients.Elasticsearch.IndexName? Index { get; set; } + + /// + /// The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. + /// [JsonInclude, JsonPropertyName("name")] public string? Name { get; set; } + + /// + /// Preference used to fetch document to percolate. + /// [JsonInclude, JsonPropertyName("preference")] public string? Preference { get; set; } + + /// + /// Routing used to fetch document to percolate. + /// [JsonInclude, JsonPropertyName("routing")] public Elastic.Clients.Elasticsearch.Routing? Routing { get; set; } + + /// + /// The expected version of a stored document to percolate. + /// [JsonInclude, JsonPropertyName("version")] public long? Version { get; set; } @@ -89,60 +125,90 @@ public PercolateQueryDescriptor Boost(float? boost) return Self; } + /// + /// The source of the document being percolated. + /// public PercolateQueryDescriptor Document(object? document) { DocumentValue = document; return Self; } + /// + /// An array of sources of the documents being percolated. + /// public PercolateQueryDescriptor Documents(ICollection? documents) { DocumentsValue = documents; return Self; } + /// + /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// public PercolateQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// public PercolateQueryDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The ID of a stored document to percolate. + /// public PercolateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { IdValue = id; return Self; } + /// + /// The index of a stored document to percolate. + /// public PercolateQueryDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { IndexValue = index; return Self; } + /// + /// The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. + /// public PercolateQueryDescriptor Name(string? name) { NameValue = name; return Self; } + /// + /// Preference used to fetch document to percolate. + /// public PercolateQueryDescriptor Preference(string? preference) { PreferenceValue = preference; return Self; } + /// + /// Routing used to fetch document to percolate. + /// public PercolateQueryDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { RoutingValue = routing; return Self; } + /// + /// The expected version of a stored document to percolate. + /// public PercolateQueryDescriptor Version(long? version) { VersionValue = version; @@ -250,66 +316,99 @@ public PercolateQueryDescriptor Boost(float? boost) return Self; } + /// + /// The source of the document being percolated. + /// public PercolateQueryDescriptor Document(object? document) { DocumentValue = document; return Self; } + /// + /// An array of sources of the documents being percolated. + /// public PercolateQueryDescriptor Documents(ICollection? documents) { DocumentsValue = documents; return Self; } + /// + /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// public PercolateQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// public PercolateQueryDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Field that holds the indexed queries. The field must use the `percolator` mapping type. + /// public PercolateQueryDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// The ID of a stored document to percolate. + /// public PercolateQueryDescriptor Id(Elastic.Clients.Elasticsearch.Id? id) { IdValue = id; return Self; } + /// + /// The index of a stored document to percolate. + /// public PercolateQueryDescriptor Index(Elastic.Clients.Elasticsearch.IndexName? index) { IndexValue = index; return Self; } + /// + /// The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. + /// public PercolateQueryDescriptor Name(string? name) { NameValue = name; return Self; } + /// + /// Preference used to fetch document to percolate. + /// public PercolateQueryDescriptor Preference(string? preference) { PreferenceValue = preference; return Self; } + /// + /// Routing used to fetch document to percolate. + /// public PercolateQueryDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) { RoutingValue = routing; return Self; } + /// + /// The expected version of a stored document to percolate. + /// public PercolateQueryDescriptor Version(long? version) { VersionValue = version; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedDoc.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedDoc.g.cs index c6396626291..230c586db5d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedDoc.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedDoc.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class PinnedDoc { + /// + /// The unique document ID. + /// [JsonInclude, JsonPropertyName("_id")] public Elastic.Clients.Elasticsearch.Id Id { get; set; } + + /// + /// The index that contains the document. + /// [JsonInclude, JsonPropertyName("_index")] public Elastic.Clients.Elasticsearch.IndexName Index { get; set; } } @@ -46,12 +53,18 @@ public PinnedDocDescriptor() : base() private Elastic.Clients.Elasticsearch.Id IdValue { get; set; } private Elastic.Clients.Elasticsearch.IndexName IndexValue { get; set; } + /// + /// The unique document ID. + /// public PinnedDocDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { IdValue = id; return Self; } + /// + /// The index that contains the document. + /// public PinnedDocDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) { IndexValue = index; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedQuery.g.cs index 6cc8ef9b470..7d97a67bf1b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PinnedQuery.g.cs @@ -52,6 +52,10 @@ internal PinnedQuery(string variantName, object variant) public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// [JsonInclude, JsonPropertyName("organic")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Organic { get; set; } @@ -203,6 +207,9 @@ private PinnedQueryDescriptor Set(object variant, string variantName) private string? QueryNameValue { get; set; } private float? BoostValue { get; set; } + /// + /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// public PinnedQueryDescriptor Organic(Elastic.Clients.Elasticsearch.QueryDsl.Query organic) { OrganicDescriptor = null; @@ -324,6 +331,9 @@ private PinnedQueryDescriptor Set(object variant, string variantName) private string? QueryNameValue { get; set; } private float? BoostValue { get; set; } + /// + /// Any choice of query used to rank documents which will be ranked below the "pinned" documents. + /// public PinnedQueryDescriptor Organic(Elastic.Clients.Elasticsearch.QueryDsl.Query organic) { OrganicDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PrefixQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PrefixQuery.g.cs index fcf9b00d4da..23dadc62704 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PrefixQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/PrefixQuery.g.cs @@ -134,8 +134,20 @@ public PrefixQuery(Field field) public string? QueryName { get; set; } public float? Boost { get; set; } + + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping. + /// public bool? CaseInsensitive { get; set; } + + /// + /// Method used to rewrite the query. + /// public string? Rewrite { get; set; } + + /// + /// Beginning characters of terms you wish to find in the provided field. + /// public string Value { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -185,6 +197,9 @@ public PrefixQueryDescriptor Boost(float? boost) return Self; } + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping. + /// public PrefixQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { CaseInsensitiveValue = caseInsensitive; @@ -203,12 +218,18 @@ public PrefixQueryDescriptor Field(Expression + /// Method used to rewrite the query. + /// public PrefixQueryDescriptor Rewrite(string? rewrite) { RewriteValue = rewrite; return Self; } + /// + /// Beginning characters of terms you wish to find in the provided field. + /// public PrefixQueryDescriptor Value(string value) { ValueValue = value; @@ -287,6 +308,9 @@ public PrefixQueryDescriptor Boost(float? boost) return Self; } + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping. + /// public PrefixQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { CaseInsensitiveValue = caseInsensitive; @@ -311,12 +335,18 @@ public PrefixQueryDescriptor Field(Expression return Self; } + /// + /// Method used to rewrite the query. + /// public PrefixQueryDescriptor Rewrite(string? rewrite) { RewriteValue = rewrite; return Self; } + /// + /// Beginning characters of terms you wish to find in the provided field. + /// public PrefixQueryDescriptor Value(string value) { ValueValue = value; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Query.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Query.g.cs index 177596ff045..b459e87744b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Query.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Query.g.cs @@ -85,6 +85,7 @@ internal void WrapVariant(string variantName, SearchQuery variant) public static Query RankFeature(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureQuery rankFeatureQuery) => new Query("rank_feature", rankFeatureQuery); public static Query RawJson(Elastic.Clients.Elasticsearch.QueryDsl.RawJsonQuery rawJsonQuery) => new Query("raw_json", rawJsonQuery); public static Query Regexp(Elastic.Clients.Elasticsearch.QueryDsl.RegexpQuery regexpQuery) => new Query("regexp", regexpQuery); + public static Query RuleQuery(Elastic.Clients.Elasticsearch.QueryDsl.RuleQuery ruleQuery) => new Query("rule_query", ruleQuery); public static Query Script(Elastic.Clients.Elasticsearch.QueryDsl.ScriptQuery scriptQuery) => new Query("script", scriptQuery); public static Query ScriptScore(Elastic.Clients.Elasticsearch.QueryDsl.ScriptScoreQuery scriptScoreQuery) => new Query("script_score", scriptScoreQuery); public static Query SimpleQueryString(Elastic.Clients.Elasticsearch.QueryDsl.SimpleQueryStringQuery simpleQueryStringQuery) => new Query("simple_query_string", simpleQueryStringQuery); @@ -359,6 +360,13 @@ public override Query Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSe return new Query(propertyName, variant); } + if (propertyName == "rule_query") + { + var variant = JsonSerializer.Deserialize(ref reader, options); + reader.Read(); + return new Query(propertyName, variant); + } + if (propertyName == "script") { var variant = JsonSerializer.Deserialize(ref reader, options); @@ -597,6 +605,9 @@ public override void Write(Utf8JsonWriter writer, Query value, JsonSerializerOpt case "regexp": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.QueryDsl.RegexpQuery)value.Variant, options); break; + case "rule_query": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.QueryDsl.RuleQuery)value.Variant, options); + break; case "script": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.QueryDsl.ScriptQuery)value.Variant, options); break; @@ -753,6 +764,8 @@ private QueryDescriptor Set(object variant, string variantName) public QueryDescriptor RawJson(Elastic.Clients.Elasticsearch.QueryDsl.RawJsonQuery rawJsonQuery) => Set(rawJsonQuery, "raw_json"); public QueryDescriptor Regexp(RegexpQuery regexpQuery) => Set(regexpQuery, "regexp"); public QueryDescriptor Regexp(Action> configure) => Set(configure, "regexp"); + public QueryDescriptor RuleQuery(RuleQuery ruleQuery) => Set(ruleQuery, "rule_query"); + public QueryDescriptor RuleQuery(Action> configure) => Set(configure, "rule_query"); public QueryDescriptor Script(ScriptQuery scriptQuery) => Set(scriptQuery, "script"); public QueryDescriptor Script(Action configure) => Set(configure, "script"); public QueryDescriptor ScriptScore(ScriptScoreQuery scriptScoreQuery) => Set(scriptScoreQuery, "script_score"); @@ -943,6 +956,9 @@ private QueryDescriptor Set(object variant, string variantName) public QueryDescriptor Regexp(RegexpQuery regexpQuery) => Set(regexpQuery, "regexp"); public QueryDescriptor Regexp(Action configure) => Set(configure, "regexp"); public QueryDescriptor Regexp(Action> configure) => Set(configure, "regexp"); + public QueryDescriptor RuleQuery(RuleQuery ruleQuery) => Set(ruleQuery, "rule_query"); + public QueryDescriptor RuleQuery(Action configure) => Set(configure, "rule_query"); + public QueryDescriptor RuleQuery(Action> configure) => Set(configure, "rule_query"); public QueryDescriptor Script(ScriptQuery scriptQuery) => Set(scriptQuery, "script"); public QueryDescriptor Script(Action configure) => Set(configure, "script"); public QueryDescriptor ScriptScore(ScriptScoreQuery scriptScoreQuery) => Set(scriptScoreQuery, "script_score"); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/QueryStringQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/QueryStringQuery.g.cs index 4d880f23f43..c1971acf4d9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/QueryStringQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/QueryStringQuery.g.cs @@ -31,56 +31,152 @@ public sealed partial class QueryStringQuery : SearchQuery { [JsonInclude, JsonPropertyName("_name")] public string? QueryName { get; set; } + + /// + /// If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + /// [JsonInclude, JsonPropertyName("allow_leading_wildcard")] public bool? AllowLeadingWildcard { get; set; } + + /// + /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// [JsonInclude, JsonPropertyName("analyze_wildcard")] public bool? AnalyzeWildcard { get; set; } + + /// + /// Analyzer used to convert text in the query string into tokens. + /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } + + /// + /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// [JsonInclude, JsonPropertyName("auto_generate_synonyms_phrase_query")] public bool? AutoGenerateSynonymsPhraseQuery { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// [JsonInclude, JsonPropertyName("default_field")] public Elastic.Clients.Elasticsearch.Field? DefaultField { get; set; } + + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// [JsonInclude, JsonPropertyName("default_operator")] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get; set; } + + /// + /// If `true`, enable position increments in queries constructed from a `query_string` search. + /// [JsonInclude, JsonPropertyName("enable_position_increments")] public bool? EnablePositionIncrements { get; set; } [JsonInclude, JsonPropertyName("escape")] public bool? Escape { get; set; } + + /// + /// Array of fields to search. Supports wildcards (`*`). + /// [JsonInclude, JsonPropertyName("fields")] public Fields? Fields { get; set; } + + /// + /// Maximum edit distance allowed for fuzzy matching. + /// [JsonInclude, JsonPropertyName("fuzziness")] public Elastic.Clients.Elasticsearch.Fuzziness? Fuzziness { get; set; } + + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// [JsonInclude, JsonPropertyName("fuzzy_max_expansions")] public int? FuzzyMaxExpansions { get; set; } + + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// [JsonInclude, JsonPropertyName("fuzzy_prefix_length")] public int? FuzzyPrefixLength { get; set; } + + /// + /// Method used to rewrite the query. + /// [JsonInclude, JsonPropertyName("fuzzy_rewrite")] public string? FuzzyRewrite { get; set; } + + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// [JsonInclude, JsonPropertyName("fuzzy_transpositions")] public bool? FuzzyTranspositions { get; set; } + + /// + /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// [JsonInclude, JsonPropertyName("lenient")] public bool? Lenient { get; set; } + + /// + /// Maximum number of automaton states required for the query. + /// [JsonInclude, JsonPropertyName("max_determinized_states")] public int? MaxDeterminizedStates { get; set; } + + /// + /// Minimum number of clauses that must match for a document to be returned. + /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } + + /// + /// Maximum number of positions allowed between matching tokens for phrases. + /// [JsonInclude, JsonPropertyName("phrase_slop")] public double? PhraseSlop { get; set; } + + /// + /// Query string you wish to parse and use for search. + /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } + + /// + /// Analyzer used to convert quoted text in the query string into tokens.
For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + /// [JsonInclude, JsonPropertyName("quote_analyzer")] public string? QuoteAnalyzer { get; set; } + + /// + /// Suffix appended to quoted text in the query string.
You can use this suffix to use a different analysis method for exact matches. + /// [JsonInclude, JsonPropertyName("quote_field_suffix")] public string? QuoteFieldSuffix { get; set; } + + /// + /// Method used to rewrite the query. + /// [JsonInclude, JsonPropertyName("rewrite")] public string? Rewrite { get; set; } + + /// + /// How to combine the queries generated from the individual search terms in the resulting `dis_max` query. + /// [JsonInclude, JsonPropertyName("tie_breaker")] public double? TieBreaker { get; set; } + + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// [JsonInclude, JsonPropertyName("time_zone")] public string? TimeZone { get; set; } + + /// + /// Determines how the query matches and scores documents. + /// [JsonInclude, JsonPropertyName("type")] public Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? Type { get; set; } @@ -131,24 +227,36 @@ public QueryStringQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + /// public QueryStringQueryDescriptor AllowLeadingWildcard(bool? allowLeadingWildcard = true) { AllowLeadingWildcardValue = allowLeadingWildcard; return Self; } + /// + /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// public QueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) { AnalyzeWildcardValue = analyzeWildcard; return Self; } + /// + /// Analyzer used to convert text in the query string into tokens. + /// public QueryStringQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// public QueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { AutoGenerateSynonymsPhraseQueryValue = autoGenerateSynonymsPhraseQuery; @@ -161,24 +269,36 @@ public QueryStringQueryDescriptor Boost(float? boost) return Self; } + /// + /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// public QueryStringQueryDescriptor DefaultField(Elastic.Clients.Elasticsearch.Field? defaultField) { DefaultFieldValue = defaultField; return Self; } + /// + /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// public QueryStringQueryDescriptor DefaultField(Expression> defaultField) { DefaultFieldValue = defaultField; return Self; } + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// public QueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? defaultOperator) { DefaultOperatorValue = defaultOperator; return Self; } + /// + /// If `true`, enable position increments in queries constructed from a `query_string` search. + /// public QueryStringQueryDescriptor EnablePositionIncrements(bool? enablePositionIncrements = true) { EnablePositionIncrementsValue = enablePositionIncrements; @@ -191,102 +311,153 @@ public QueryStringQueryDescriptor Escape(bool? escape = true) return Self; } + /// + /// Array of fields to search. Supports wildcards (`*`). + /// public QueryStringQueryDescriptor Fields(Fields? fields) { FieldsValue = fields; return Self; } + /// + /// Maximum edit distance allowed for fuzzy matching. + /// public QueryStringQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { FuzzinessValue = fuzziness; return Self; } + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// public QueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) { FuzzyMaxExpansionsValue = fuzzyMaxExpansions; return Self; } + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// public QueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) { FuzzyPrefixLengthValue = fuzzyPrefixLength; return Self; } + /// + /// Method used to rewrite the query. + /// public QueryStringQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { FuzzyRewriteValue = fuzzyRewrite; return Self; } + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// public QueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { FuzzyTranspositionsValue = fuzzyTranspositions; return Self; } + /// + /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// public QueryStringQueryDescriptor Lenient(bool? lenient = true) { LenientValue = lenient; return Self; } + /// + /// Maximum number of automaton states required for the query. + /// public QueryStringQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { MaxDeterminizedStatesValue = maxDeterminizedStates; return Self; } + /// + /// Minimum number of clauses that must match for a document to be returned. + /// public QueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Maximum number of positions allowed between matching tokens for phrases. + /// public QueryStringQueryDescriptor PhraseSlop(double? phraseSlop) { PhraseSlopValue = phraseSlop; return Self; } + /// + /// Query string you wish to parse and use for search. + /// public QueryStringQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Analyzer used to convert quoted text in the query string into tokens.
For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + /// public QueryStringQueryDescriptor QuoteAnalyzer(string? quoteAnalyzer) { QuoteAnalyzerValue = quoteAnalyzer; return Self; } + /// + /// Suffix appended to quoted text in the query string.
You can use this suffix to use a different analysis method for exact matches. + /// public QueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) { QuoteFieldSuffixValue = quoteFieldSuffix; return Self; } + /// + /// Method used to rewrite the query. + /// public QueryStringQueryDescriptor Rewrite(string? rewrite) { RewriteValue = rewrite; return Self; } + /// + /// How to combine the queries generated from the individual search terms in the resulting `dis_max` query. + /// public QueryStringQueryDescriptor TieBreaker(double? tieBreaker) { TieBreakerValue = tieBreaker; return Self; } + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// public QueryStringQueryDescriptor TimeZone(string? timeZone) { TimeZoneValue = timeZone; return Self; } + /// + /// Determines how the query matches and scores documents. + /// public QueryStringQueryDescriptor Type(Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? type) { TypeValue = type; @@ -500,24 +671,36 @@ public QueryStringQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + /// public QueryStringQueryDescriptor AllowLeadingWildcard(bool? allowLeadingWildcard = true) { AllowLeadingWildcardValue = allowLeadingWildcard; return Self; } + /// + /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// public QueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) { AnalyzeWildcardValue = analyzeWildcard; return Self; } + /// + /// Analyzer used to convert text in the query string into tokens. + /// public QueryStringQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// If `true`, match phrase queries are automatically created for multi-term synonyms. + /// public QueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { AutoGenerateSynonymsPhraseQueryValue = autoGenerateSynonymsPhraseQuery; @@ -530,30 +713,45 @@ public QueryStringQueryDescriptor Boost(float? boost) return Self; } + /// + /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// public QueryStringQueryDescriptor DefaultField(Elastic.Clients.Elasticsearch.Field? defaultField) { DefaultFieldValue = defaultField; return Self; } + /// + /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// public QueryStringQueryDescriptor DefaultField(Expression> defaultField) { DefaultFieldValue = defaultField; return Self; } + /// + /// Default field to search if no field is provided in the query string.
Supports wildcards (`*`).
Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + /// public QueryStringQueryDescriptor DefaultField(Expression> defaultField) { DefaultFieldValue = defaultField; return Self; } + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// public QueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? defaultOperator) { DefaultOperatorValue = defaultOperator; return Self; } + /// + /// If `true`, enable position increments in queries constructed from a `query_string` search. + /// public QueryStringQueryDescriptor EnablePositionIncrements(bool? enablePositionIncrements = true) { EnablePositionIncrementsValue = enablePositionIncrements; @@ -566,102 +764,153 @@ public QueryStringQueryDescriptor Escape(bool? escape = true) return Self; } + /// + /// Array of fields to search. Supports wildcards (`*`). + /// public QueryStringQueryDescriptor Fields(Fields? fields) { FieldsValue = fields; return Self; } + /// + /// Maximum edit distance allowed for fuzzy matching. + /// public QueryStringQueryDescriptor Fuzziness(Elastic.Clients.Elasticsearch.Fuzziness? fuzziness) { FuzzinessValue = fuzziness; return Self; } + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// public QueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) { FuzzyMaxExpansionsValue = fuzzyMaxExpansions; return Self; } + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// public QueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) { FuzzyPrefixLengthValue = fuzzyPrefixLength; return Self; } + /// + /// Method used to rewrite the query. + /// public QueryStringQueryDescriptor FuzzyRewrite(string? fuzzyRewrite) { FuzzyRewriteValue = fuzzyRewrite; return Self; } + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// public QueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { FuzzyTranspositionsValue = fuzzyTranspositions; return Self; } + /// + /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// public QueryStringQueryDescriptor Lenient(bool? lenient = true) { LenientValue = lenient; return Self; } + /// + /// Maximum number of automaton states required for the query. + /// public QueryStringQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { MaxDeterminizedStatesValue = maxDeterminizedStates; return Self; } + /// + /// Minimum number of clauses that must match for a document to be returned. + /// public QueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Maximum number of positions allowed between matching tokens for phrases. + /// public QueryStringQueryDescriptor PhraseSlop(double? phraseSlop) { PhraseSlopValue = phraseSlop; return Self; } + /// + /// Query string you wish to parse and use for search. + /// public QueryStringQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Analyzer used to convert quoted text in the query string into tokens.
For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + /// public QueryStringQueryDescriptor QuoteAnalyzer(string? quoteAnalyzer) { QuoteAnalyzerValue = quoteAnalyzer; return Self; } + /// + /// Suffix appended to quoted text in the query string.
You can use this suffix to use a different analysis method for exact matches. + /// public QueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) { QuoteFieldSuffixValue = quoteFieldSuffix; return Self; } + /// + /// Method used to rewrite the query. + /// public QueryStringQueryDescriptor Rewrite(string? rewrite) { RewriteValue = rewrite; return Self; } + /// + /// How to combine the queries generated from the individual search terms in the resulting `dis_max` query. + /// public QueryStringQueryDescriptor TieBreaker(double? tieBreaker) { TieBreakerValue = tieBreaker; return Self; } + /// + /// Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. + /// public QueryStringQueryDescriptor TimeZone(string? timeZone) { TimeZoneValue = timeZone; return Self; } + /// + /// Determines how the query matches and scores documents. + /// public QueryStringQueryDescriptor Type(Elastic.Clients.Elasticsearch.QueryDsl.TextQueryType? type) { TypeValue = type; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionLogarithm.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionLogarithm.g.cs index d7dc4bc6ad7..48de8b00f02 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionLogarithm.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionLogarithm.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class RankFeatureFunctionLogarithm { + /// + /// Configurable scaling factor. + /// [JsonInclude, JsonPropertyName("scaling_factor")] public float ScalingFactor { get; set; } } @@ -43,6 +46,9 @@ public RankFeatureFunctionLogarithmDescriptor() : base() private float ScalingFactorValue { get; set; } + /// + /// Configurable scaling factor. + /// public RankFeatureFunctionLogarithmDescriptor ScalingFactor(float scalingFactor) { ScalingFactorValue = scalingFactor; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSaturation.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSaturation.g.cs index bda1106eced..dcccf522bba 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSaturation.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSaturation.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class RankFeatureFunctionSaturation { + /// + /// Configurable pivot value so that the result will be less than 0.5. + /// [JsonInclude, JsonPropertyName("pivot")] public float? Pivot { get; set; } } @@ -43,6 +46,9 @@ public RankFeatureFunctionSaturationDescriptor() : base() private float? PivotValue { get; set; } + /// + /// Configurable pivot value so that the result will be less than 0.5. + /// public RankFeatureFunctionSaturationDescriptor Pivot(float? pivot) { PivotValue = pivot; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSigmoid.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSigmoid.g.cs index 3a62f0da30f..27afda9e52b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSigmoid.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureFunctionSigmoid.g.cs @@ -29,8 +29,15 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class RankFeatureFunctionSigmoid { + /// + /// Configurable Exponent. + /// [JsonInclude, JsonPropertyName("exponent")] public float Exponent { get; set; } + + /// + /// Configurable pivot value so that the result will be less than 0.5. + /// [JsonInclude, JsonPropertyName("pivot")] public float Pivot { get; set; } } @@ -46,12 +53,18 @@ public RankFeatureFunctionSigmoidDescriptor() : base() private float ExponentValue { get; set; } private float PivotValue { get; set; } + /// + /// Configurable Exponent. + /// public RankFeatureFunctionSigmoidDescriptor Exponent(float exponent) { ExponentValue = exponent; return Self; } + /// + /// Configurable pivot value so that the result will be less than 0.5. + /// public RankFeatureFunctionSigmoidDescriptor Pivot(float pivot) { PivotValue = pivot; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureQuery.g.cs index 3af3c3703fc..e32fdc9fd30 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RankFeatureQuery.g.cs @@ -33,14 +33,34 @@ public sealed partial class RankFeatureQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// [JsonInclude, JsonPropertyName("field")] public Elastic.Clients.Elasticsearch.Field Field { get; set; } + + /// + /// Linear function used to boost relevance scores based on the value of the rank feature `field`. + /// [JsonInclude, JsonPropertyName("linear")] public Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionLinear? Linear { get; set; } + + /// + /// Logarithmic function used to boost relevance scores based on the value of the rank feature `field`. + /// [JsonInclude, JsonPropertyName("log")] public Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionLogarithm? Log { get; set; } + + /// + /// Saturation function used to boost relevance scores based on the value of the rank feature `field`. + /// [JsonInclude, JsonPropertyName("saturation")] public Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionSaturation? Saturation { get; set; } + + /// + /// Sigmoid function used to boost relevance scores based on the value of the rank feature `field`. + /// [JsonInclude, JsonPropertyName("sigmoid")] public Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionSigmoid? Sigmoid { get; set; } @@ -85,18 +105,27 @@ public RankFeatureQueryDescriptor Boost(float? boost) return Self; } + /// + /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// public RankFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// public RankFeatureQueryDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Linear function used to boost relevance scores based on the value of the rank feature `field`. + /// public RankFeatureQueryDescriptor Linear(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionLinear? linear) { LinearDescriptor = null; @@ -121,6 +150,9 @@ public RankFeatureQueryDescriptor Linear(Action + /// Logarithmic function used to boost relevance scores based on the value of the rank feature `field`. + /// public RankFeatureQueryDescriptor Log(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionLogarithm? log) { LogDescriptor = null; @@ -145,6 +177,9 @@ public RankFeatureQueryDescriptor Log(Action + /// Saturation function used to boost relevance scores based on the value of the rank feature `field`. + /// public RankFeatureQueryDescriptor Saturation(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionSaturation? saturation) { SaturationDescriptor = null; @@ -169,6 +204,9 @@ public RankFeatureQueryDescriptor Saturation(Action + /// Sigmoid function used to boost relevance scores based on the value of the rank feature `field`. + /// public RankFeatureQueryDescriptor Sigmoid(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionSigmoid? sigmoid) { SigmoidDescriptor = null; @@ -314,24 +352,36 @@ public RankFeatureQueryDescriptor Boost(float? boost) return Self; } + /// + /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// public RankFeatureQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) { FieldValue = field; return Self; } + /// + /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// public RankFeatureQueryDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// `rank_feature` or `rank_features` field used to boost relevance scores. + /// public RankFeatureQueryDescriptor Field(Expression> field) { FieldValue = field; return Self; } + /// + /// Linear function used to boost relevance scores based on the value of the rank feature `field`. + /// public RankFeatureQueryDescriptor Linear(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionLinear? linear) { LinearDescriptor = null; @@ -356,6 +406,9 @@ public RankFeatureQueryDescriptor Linear(Action + /// Logarithmic function used to boost relevance scores based on the value of the rank feature `field`. + /// public RankFeatureQueryDescriptor Log(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionLogarithm? log) { LogDescriptor = null; @@ -380,6 +433,9 @@ public RankFeatureQueryDescriptor Log(Action + /// Saturation function used to boost relevance scores based on the value of the rank feature `field`. + /// public RankFeatureQueryDescriptor Saturation(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionSaturation? saturation) { SaturationDescriptor = null; @@ -404,6 +460,9 @@ public RankFeatureQueryDescriptor Saturation(Action + /// Sigmoid function used to boost relevance scores based on the value of the rank feature `field`. + /// public RankFeatureQueryDescriptor Sigmoid(Elastic.Clients.Elasticsearch.QueryDsl.RankFeatureFunctionSigmoid? sigmoid) { SigmoidDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RegexpQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RegexpQuery.g.cs index a12af3134b6..62326137731 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RegexpQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RegexpQuery.g.cs @@ -158,10 +158,30 @@ public RegexpQuery(Field field) public string? QueryName { get; set; } public float? Boost { get; set; } + + /// + /// Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.
When `false`, case sensitivity of matching depends on the underlying field’s mapping. + /// public bool? CaseInsensitive { get; set; } + + /// + /// Enables optional operators for the regular expression. + /// public string? Flags { get; set; } + + /// + /// Maximum number of automaton states required for the query. + /// public int? MaxDeterminizedStates { get; set; } + + /// + /// Method used to rewrite the query. + /// public string? Rewrite { get; set; } + + /// + /// Regular expression for terms you wish to find in the provided field. + /// public string Value { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -213,6 +233,9 @@ public RegexpQueryDescriptor Boost(float? boost) return Self; } + /// + /// Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.
When `false`, case sensitivity of matching depends on the underlying field’s mapping. + /// public RegexpQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { CaseInsensitiveValue = caseInsensitive; @@ -231,24 +254,36 @@ public RegexpQueryDescriptor Field(Expression + /// Enables optional operators for the regular expression. + /// public RegexpQueryDescriptor Flags(string? flags) { FlagsValue = flags; return Self; } + /// + /// Maximum number of automaton states required for the query. + /// public RegexpQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { MaxDeterminizedStatesValue = maxDeterminizedStates; return Self; } + /// + /// Method used to rewrite the query. + /// public RegexpQueryDescriptor Rewrite(string? rewrite) { RewriteValue = rewrite; return Self; } + /// + /// Regular expression for terms you wish to find in the provided field. + /// public RegexpQueryDescriptor Value(string value) { ValueValue = value; @@ -341,6 +376,9 @@ public RegexpQueryDescriptor Boost(float? boost) return Self; } + /// + /// Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.
When `false`, case sensitivity of matching depends on the underlying field’s mapping. + /// public RegexpQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { CaseInsensitiveValue = caseInsensitive; @@ -365,24 +403,36 @@ public RegexpQueryDescriptor Field(Expression return Self; } + /// + /// Enables optional operators for the regular expression. + /// public RegexpQueryDescriptor Flags(string? flags) { FlagsValue = flags; return Self; } + /// + /// Maximum number of automaton states required for the query. + /// public RegexpQueryDescriptor MaxDeterminizedStates(int? maxDeterminizedStates) { MaxDeterminizedStatesValue = maxDeterminizedStates; return Self; } + /// + /// Method used to rewrite the query. + /// public RegexpQueryDescriptor Rewrite(string? rewrite) { RewriteValue = rewrite; return Self; } + /// + /// Regular expression for terms you wish to find in the provided field. + /// public RegexpQueryDescriptor Value(string value) { ValueValue = value; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RuleQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RuleQuery.g.cs new file mode 100644 index 00000000000..f565c688a99 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/RuleQuery.g.cs @@ -0,0 +1,252 @@ +// Licensed to Elasticsearch B.V under one or more agreements. +// Elasticsearch B.V licenses this file to you under the Apache 2.0 License. +// See the LICENSE file in the project root for more information. +// +// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗ +// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝ +// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗ +// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝ +// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗ +// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝ +// ------------------------------------------------ +// +// This file is automatically generated. +// Please do not edit these files manually. +// +// ------------------------------------------------ + +#nullable restore + +using Elastic.Clients.Elasticsearch.Fluent; +using Elastic.Clients.Elasticsearch.Serialization; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.QueryDsl; + +public sealed partial class RuleQuery : SearchQuery +{ + [JsonInclude, JsonPropertyName("_name")] + public string? QueryName { get; set; } + [JsonInclude, JsonPropertyName("boost")] + public float? Boost { get; set; } + [JsonInclude, JsonPropertyName("match_criteria")] + public object MatchCriteria { get; set; } + [JsonInclude, JsonPropertyName("organic")] + public Elastic.Clients.Elasticsearch.QueryDsl.Query Organic { get; set; } + [JsonInclude, JsonPropertyName("ruleset_id")] + public Elastic.Clients.Elasticsearch.Id RulesetId { get; set; } + + public static implicit operator Query(RuleQuery ruleQuery) => QueryDsl.Query.RuleQuery(ruleQuery); + + internal override void InternalWrapInContainer(Query container) => container.WrapVariant("rule_query", this); +} + +public sealed partial class RuleQueryDescriptor : SerializableDescriptor> +{ + internal RuleQueryDescriptor(Action> configure) => configure.Invoke(this); + + public RuleQueryDescriptor() : base() + { + } + + private Elastic.Clients.Elasticsearch.QueryDsl.Query OrganicValue { get; set; } + private QueryDescriptor OrganicDescriptor { get; set; } + private Action> OrganicDescriptorAction { get; set; } + private string? QueryNameValue { get; set; } + private float? BoostValue { get; set; } + private object MatchCriteriaValue { get; set; } + private Elastic.Clients.Elasticsearch.Id RulesetIdValue { get; set; } + + public RuleQueryDescriptor Organic(Elastic.Clients.Elasticsearch.QueryDsl.Query organic) + { + OrganicDescriptor = null; + OrganicDescriptorAction = null; + OrganicValue = organic; + return Self; + } + + public RuleQueryDescriptor Organic(QueryDescriptor descriptor) + { + OrganicValue = null; + OrganicDescriptorAction = null; + OrganicDescriptor = descriptor; + return Self; + } + + public RuleQueryDescriptor Organic(Action> configure) + { + OrganicValue = null; + OrganicDescriptor = null; + OrganicDescriptorAction = configure; + return Self; + } + + public RuleQueryDescriptor QueryName(string? queryName) + { + QueryNameValue = queryName; + return Self; + } + + public RuleQueryDescriptor Boost(float? boost) + { + BoostValue = boost; + return Self; + } + + public RuleQueryDescriptor MatchCriteria(object matchCriteria) + { + MatchCriteriaValue = matchCriteria; + return Self; + } + + public RuleQueryDescriptor RulesetId(Elastic.Clients.Elasticsearch.Id rulesetId) + { + RulesetIdValue = rulesetId; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (OrganicDescriptor is not null) + { + writer.WritePropertyName("organic"); + JsonSerializer.Serialize(writer, OrganicDescriptor, options); + } + else if (OrganicDescriptorAction is not null) + { + writer.WritePropertyName("organic"); + JsonSerializer.Serialize(writer, new QueryDescriptor(OrganicDescriptorAction), options); + } + else + { + writer.WritePropertyName("organic"); + JsonSerializer.Serialize(writer, OrganicValue, options); + } + + if (!string.IsNullOrEmpty(QueryNameValue)) + { + writer.WritePropertyName("_name"); + writer.WriteStringValue(QueryNameValue); + } + + if (BoostValue.HasValue) + { + writer.WritePropertyName("boost"); + writer.WriteNumberValue(BoostValue.Value); + } + + writer.WritePropertyName("match_criteria"); + JsonSerializer.Serialize(writer, MatchCriteriaValue, options); + writer.WritePropertyName("ruleset_id"); + JsonSerializer.Serialize(writer, RulesetIdValue, options); + writer.WriteEndObject(); + } +} + +public sealed partial class RuleQueryDescriptor : SerializableDescriptor +{ + internal RuleQueryDescriptor(Action configure) => configure.Invoke(this); + + public RuleQueryDescriptor() : base() + { + } + + private Elastic.Clients.Elasticsearch.QueryDsl.Query OrganicValue { get; set; } + private QueryDescriptor OrganicDescriptor { get; set; } + private Action OrganicDescriptorAction { get; set; } + private string? QueryNameValue { get; set; } + private float? BoostValue { get; set; } + private object MatchCriteriaValue { get; set; } + private Elastic.Clients.Elasticsearch.Id RulesetIdValue { get; set; } + + public RuleQueryDescriptor Organic(Elastic.Clients.Elasticsearch.QueryDsl.Query organic) + { + OrganicDescriptor = null; + OrganicDescriptorAction = null; + OrganicValue = organic; + return Self; + } + + public RuleQueryDescriptor Organic(QueryDescriptor descriptor) + { + OrganicValue = null; + OrganicDescriptorAction = null; + OrganicDescriptor = descriptor; + return Self; + } + + public RuleQueryDescriptor Organic(Action configure) + { + OrganicValue = null; + OrganicDescriptor = null; + OrganicDescriptorAction = configure; + return Self; + } + + public RuleQueryDescriptor QueryName(string? queryName) + { + QueryNameValue = queryName; + return Self; + } + + public RuleQueryDescriptor Boost(float? boost) + { + BoostValue = boost; + return Self; + } + + public RuleQueryDescriptor MatchCriteria(object matchCriteria) + { + MatchCriteriaValue = matchCriteria; + return Self; + } + + public RuleQueryDescriptor RulesetId(Elastic.Clients.Elasticsearch.Id rulesetId) + { + RulesetIdValue = rulesetId; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (OrganicDescriptor is not null) + { + writer.WritePropertyName("organic"); + JsonSerializer.Serialize(writer, OrganicDescriptor, options); + } + else if (OrganicDescriptorAction is not null) + { + writer.WritePropertyName("organic"); + JsonSerializer.Serialize(writer, new QueryDescriptor(OrganicDescriptorAction), options); + } + else + { + writer.WritePropertyName("organic"); + JsonSerializer.Serialize(writer, OrganicValue, options); + } + + if (!string.IsNullOrEmpty(QueryNameValue)) + { + writer.WritePropertyName("_name"); + writer.WriteStringValue(QueryNameValue); + } + + if (BoostValue.HasValue) + { + writer.WritePropertyName("boost"); + writer.WriteNumberValue(BoostValue.Value); + } + + writer.WritePropertyName("match_criteria"); + JsonSerializer.Serialize(writer, MatchCriteriaValue, options); + writer.WritePropertyName("ruleset_id"); + JsonSerializer.Serialize(writer, RulesetIdValue, options); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptQuery.g.cs index ab82f3c8f05..b989c0a78b8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptQuery.g.cs @@ -33,6 +33,10 @@ public sealed partial class ScriptQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Contains a script to run as a query.
This script must return a boolean value, `true` or `false`. + /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script Script { get; set; } @@ -65,6 +69,9 @@ public ScriptQueryDescriptor Boost(float? boost) return Self; } + /// + /// Contains a script to run as a query.
This script must return a boolean value, `true` or `false`. + /// public ScriptQueryDescriptor Script(Elastic.Clients.Elasticsearch.Script script) { ScriptValue = script; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreFunction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreFunction.g.cs index e202ba99a79..fed8aec5667 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreFunction.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreFunction.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; public sealed partial class ScriptScoreFunction { + /// + /// A script that computes a score. + /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script Script { get; set; } @@ -45,6 +48,9 @@ public ScriptScoreFunctionDescriptor() : base() private Elastic.Clients.Elasticsearch.Script ScriptValue { get; set; } + /// + /// A script that computes a score. + /// public ScriptScoreFunctionDescriptor Script(Elastic.Clients.Elasticsearch.Script script) { ScriptValue = script; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreQuery.g.cs index 8be0131e620..e15966f273d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/ScriptScoreQuery.g.cs @@ -33,10 +33,22 @@ public sealed partial class ScriptScoreQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Documents with a score lower than this floating point number are excluded from the search results. + /// [JsonInclude, JsonPropertyName("min_score")] public float? MinScore { get; set; } + + /// + /// Query used to return documents. + /// [JsonInclude, JsonPropertyName("query")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Query { get; set; } + + /// + /// Script used to compute the score of documents returned by the query.
Important: final relevance scores from the `script_score` query cannot be negative. + /// [JsonInclude, JsonPropertyName("script")] public Elastic.Clients.Elasticsearch.Script Script { get; set; } @@ -61,6 +73,9 @@ public ScriptScoreQueryDescriptor() : base() private float? MinScoreValue { get; set; } private Elastic.Clients.Elasticsearch.Script ScriptValue { get; set; } + /// + /// Query used to return documents. + /// public ScriptScoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { QueryDescriptor = null; @@ -97,12 +112,18 @@ public ScriptScoreQueryDescriptor Boost(float? boost) return Self; } + /// + /// Documents with a score lower than this floating point number are excluded from the search results. + /// public ScriptScoreQueryDescriptor MinScore(float? minScore) { MinScoreValue = minScore; return Self; } + /// + /// Script used to compute the score of documents returned by the query.
Important: final relevance scores from the `script_score` query cannot be negative. + /// public ScriptScoreQueryDescriptor Script(Elastic.Clients.Elasticsearch.Script script) { ScriptValue = script; @@ -168,6 +189,9 @@ public ScriptScoreQueryDescriptor() : base() private float? MinScoreValue { get; set; } private Elastic.Clients.Elasticsearch.Script ScriptValue { get; set; } + /// + /// Query used to return documents. + /// public ScriptScoreQueryDescriptor Query(Elastic.Clients.Elasticsearch.QueryDsl.Query query) { QueryDescriptor = null; @@ -204,12 +228,18 @@ public ScriptScoreQueryDescriptor Boost(float? boost) return Self; } + /// + /// Documents with a score lower than this floating point number are excluded from the search results. + /// public ScriptScoreQueryDescriptor MinScore(float? minScore) { MinScoreValue = minScore; return Self; } + /// + /// Script used to compute the score of documents returned by the query.
Important: final relevance scores from the `script_score` query cannot be negative. + /// public ScriptScoreQueryDescriptor Script(Elastic.Clients.Elasticsearch.Script script) { ScriptValue = script; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SimpleQueryStringQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SimpleQueryStringQuery.g.cs index 17ad5e1bed7..1a0d737a61e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SimpleQueryStringQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SimpleQueryStringQuery.g.cs @@ -31,32 +31,84 @@ public sealed partial class SimpleQueryStringQuery : SearchQuery { [JsonInclude, JsonPropertyName("_name")] public string? QueryName { get; set; } + + /// + /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// [JsonInclude, JsonPropertyName("analyze_wildcard")] public bool? AnalyzeWildcard { get; set; } + + /// + /// Analyzer used to convert text in the query string into tokens. + /// [JsonInclude, JsonPropertyName("analyzer")] public string? Analyzer { get; set; } + + /// + /// If `true`, the parser creates a match_phrase query for each multi-position token. + /// [JsonInclude, JsonPropertyName("auto_generate_synonyms_phrase_query")] public bool? AutoGenerateSynonymsPhraseQuery { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// [JsonInclude, JsonPropertyName("default_operator")] public Elastic.Clients.Elasticsearch.QueryDsl.Operator? DefaultOperator { get; set; } + + /// + /// Array of fields you wish to search.
Accepts wildcard expressions.
You also can boost relevance scores for matches to particular fields using a caret (`^`) notation.
Defaults to the `index.query.default_field index` setting, which has a default value of `*`. + /// [JsonInclude, JsonPropertyName("fields")] public Fields? Fields { get; set; } + + /// + /// List of enabled operators for the simple query string syntax. + /// [JsonInclude, JsonPropertyName("flags")] public Elastic.Clients.Elasticsearch.QueryDsl.SimpleQueryStringFlags? Flags { get; set; } + + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// [JsonInclude, JsonPropertyName("fuzzy_max_expansions")] public int? FuzzyMaxExpansions { get; set; } + + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// [JsonInclude, JsonPropertyName("fuzzy_prefix_length")] public int? FuzzyPrefixLength { get; set; } + + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// [JsonInclude, JsonPropertyName("fuzzy_transpositions")] public bool? FuzzyTranspositions { get; set; } + + /// + /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// [JsonInclude, JsonPropertyName("lenient")] public bool? Lenient { get; set; } + + /// + /// Minimum number of clauses that must match for a document to be returned. + /// [JsonInclude, JsonPropertyName("minimum_should_match")] public Elastic.Clients.Elasticsearch.MinimumShouldMatch? MinimumShouldMatch { get; set; } + + /// + /// Query string in the simple query string syntax you wish to parse and use for search. + /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } + + /// + /// Suffix appended to quoted text in the query string. + /// [JsonInclude, JsonPropertyName("quote_field_suffix")] public string? QuoteFieldSuffix { get; set; } @@ -95,18 +147,27 @@ public SimpleQueryStringQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// public SimpleQueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) { AnalyzeWildcardValue = analyzeWildcard; return Self; } + /// + /// Analyzer used to convert text in the query string into tokens. + /// public SimpleQueryStringQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// If `true`, the parser creates a match_phrase query for each multi-position token. + /// public SimpleQueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { AutoGenerateSynonymsPhraseQueryValue = autoGenerateSynonymsPhraseQuery; @@ -119,60 +180,90 @@ public SimpleQueryStringQueryDescriptor Boost(float? boost) return Self; } + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// public SimpleQueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? defaultOperator) { DefaultOperatorValue = defaultOperator; return Self; } + /// + /// Array of fields you wish to search.
Accepts wildcard expressions.
You also can boost relevance scores for matches to particular fields using a caret (`^`) notation.
Defaults to the `index.query.default_field index` setting, which has a default value of `*`. + /// public SimpleQueryStringQueryDescriptor Fields(Fields? fields) { FieldsValue = fields; return Self; } + /// + /// List of enabled operators for the simple query string syntax. + /// public SimpleQueryStringQueryDescriptor Flags(Elastic.Clients.Elasticsearch.QueryDsl.SimpleQueryStringFlags? flags) { FlagsValue = flags; return Self; } + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// public SimpleQueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) { FuzzyMaxExpansionsValue = fuzzyMaxExpansions; return Self; } + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// public SimpleQueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) { FuzzyPrefixLengthValue = fuzzyPrefixLength; return Self; } + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// public SimpleQueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { FuzzyTranspositionsValue = fuzzyTranspositions; return Self; } + /// + /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// public SimpleQueryStringQueryDescriptor Lenient(bool? lenient = true) { LenientValue = lenient; return Self; } + /// + /// Minimum number of clauses that must match for a document to be returned. + /// public SimpleQueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Query string in the simple query string syntax you wish to parse and use for search. + /// public SimpleQueryStringQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Suffix appended to quoted text in the query string. + /// public SimpleQueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) { QuoteFieldSuffixValue = quoteFieldSuffix; @@ -302,18 +393,27 @@ public SimpleQueryStringQueryDescriptor QueryName(string? queryName) return Self; } + /// + /// If `true`, the query attempts to analyze wildcard terms in the query string. + /// public SimpleQueryStringQueryDescriptor AnalyzeWildcard(bool? analyzeWildcard = true) { AnalyzeWildcardValue = analyzeWildcard; return Self; } + /// + /// Analyzer used to convert text in the query string into tokens. + /// public SimpleQueryStringQueryDescriptor Analyzer(string? analyzer) { AnalyzerValue = analyzer; return Self; } + /// + /// If `true`, the parser creates a match_phrase query for each multi-position token. + /// public SimpleQueryStringQueryDescriptor AutoGenerateSynonymsPhraseQuery(bool? autoGenerateSynonymsPhraseQuery = true) { AutoGenerateSynonymsPhraseQueryValue = autoGenerateSynonymsPhraseQuery; @@ -326,60 +426,90 @@ public SimpleQueryStringQueryDescriptor Boost(float? boost) return Self; } + /// + /// Default boolean logic used to interpret text in the query string if no operators are specified. + /// public SimpleQueryStringQueryDescriptor DefaultOperator(Elastic.Clients.Elasticsearch.QueryDsl.Operator? defaultOperator) { DefaultOperatorValue = defaultOperator; return Self; } + /// + /// Array of fields you wish to search.
Accepts wildcard expressions.
You also can boost relevance scores for matches to particular fields using a caret (`^`) notation.
Defaults to the `index.query.default_field index` setting, which has a default value of `*`. + /// public SimpleQueryStringQueryDescriptor Fields(Fields? fields) { FieldsValue = fields; return Self; } + /// + /// List of enabled operators for the simple query string syntax. + /// public SimpleQueryStringQueryDescriptor Flags(Elastic.Clients.Elasticsearch.QueryDsl.SimpleQueryStringFlags? flags) { FlagsValue = flags; return Self; } + /// + /// Maximum number of terms to which the query expands for fuzzy matching. + /// public SimpleQueryStringQueryDescriptor FuzzyMaxExpansions(int? fuzzyMaxExpansions) { FuzzyMaxExpansionsValue = fuzzyMaxExpansions; return Self; } + /// + /// Number of beginning characters left unchanged for fuzzy matching. + /// public SimpleQueryStringQueryDescriptor FuzzyPrefixLength(int? fuzzyPrefixLength) { FuzzyPrefixLengthValue = fuzzyPrefixLength; return Self; } + /// + /// If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + /// public SimpleQueryStringQueryDescriptor FuzzyTranspositions(bool? fuzzyTranspositions = true) { FuzzyTranspositionsValue = fuzzyTranspositions; return Self; } + /// + /// If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + /// public SimpleQueryStringQueryDescriptor Lenient(bool? lenient = true) { LenientValue = lenient; return Self; } + /// + /// Minimum number of clauses that must match for a document to be returned. + /// public SimpleQueryStringQueryDescriptor MinimumShouldMatch(Elastic.Clients.Elasticsearch.MinimumShouldMatch? minimumShouldMatch) { MinimumShouldMatchValue = minimumShouldMatch; return Self; } + /// + /// Query string in the simple query string syntax you wish to parse and use for search. + /// public SimpleQueryStringQueryDescriptor Query(string query) { QueryValue = query; return Self; } + /// + /// Suffix appended to quoted text in the query string. + /// public SimpleQueryStringQueryDescriptor QuoteFieldSuffix(string? quoteFieldSuffix) { QuoteFieldSuffixValue = quoteFieldSuffix; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanContainingQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanContainingQuery.g.cs index 5667eacc824..bcc25ebd8c3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanContainingQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanContainingQuery.g.cs @@ -31,10 +31,18 @@ public sealed partial class SpanContainingQuery : SearchQuery { [JsonInclude, JsonPropertyName("_name")] public string? QueryName { get; set; } + + /// + /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// [JsonInclude, JsonPropertyName("big")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Big { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// [JsonInclude, JsonPropertyName("little")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Little { get; set; } @@ -58,6 +66,9 @@ public SpanContainingQueryDescriptor() : base() private string? QueryNameValue { get; set; } private float? BoostValue { get; set; } + /// + /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// public SpanContainingQueryDescriptor Big(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery big) { BigDescriptor = null; @@ -82,6 +93,9 @@ public SpanContainingQueryDescriptor Big(Action + /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// public SpanContainingQueryDescriptor Little(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery little) { LittleDescriptor = null; @@ -186,6 +200,9 @@ public SpanContainingQueryDescriptor() : base() private string? QueryNameValue { get; set; } private float? BoostValue { get; set; } + /// + /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// public SpanContainingQueryDescriptor Big(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery big) { BigDescriptor = null; @@ -210,6 +227,9 @@ public SpanContainingQueryDescriptor Big(Action configure) return Self; } + /// + /// Can be any span query.
Matching spans from `big` that contain matches from `little` are returned. + /// public SpanContainingQueryDescriptor Little(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery little) { LittleDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanFirstQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanFirstQuery.g.cs index 8d24b55461e..de8d35e12c2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanFirstQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanFirstQuery.g.cs @@ -33,8 +33,16 @@ public sealed partial class SpanFirstQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Controls the maximum end position permitted in a match. + /// [JsonInclude, JsonPropertyName("end")] public int End { get; set; } + + /// + /// Can be any other span type query. + /// [JsonInclude, JsonPropertyName("match")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Match { get; set; } @@ -56,6 +64,9 @@ public SpanFirstQueryDescriptor() : base() private float? BoostValue { get; set; } private int EndValue { get; set; } + /// + /// Can be any other span type query. + /// public SpanFirstQueryDescriptor Match(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery match) { MatchDescriptor = null; @@ -92,6 +103,9 @@ public SpanFirstQueryDescriptor Boost(float? boost) return Self; } + /// + /// Controls the maximum end position permitted in a match. + /// public SpanFirstQueryDescriptor End(int end) { EndValue = end; @@ -150,6 +164,9 @@ public SpanFirstQueryDescriptor() : base() private float? BoostValue { get; set; } private int EndValue { get; set; } + /// + /// Can be any other span type query. + /// public SpanFirstQueryDescriptor Match(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery match) { MatchDescriptor = null; @@ -186,6 +203,9 @@ public SpanFirstQueryDescriptor Boost(float? boost) return Self; } + /// + /// Controls the maximum end position permitted in a match. + /// public SpanFirstQueryDescriptor End(int end) { EndValue = end; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanMultiTermQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanMultiTermQuery.g.cs index 640680611d9..620f240e601 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanMultiTermQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanMultiTermQuery.g.cs @@ -35,7 +35,7 @@ public sealed partial class SpanMultiTermQuery : SearchQuery public float? Boost { get; set; } /// - /// Should be a multi term query (one of wildcard, fuzzy, prefix, range or regexp query) + /// Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query). /// [JsonInclude, JsonPropertyName("match")] public Elastic.Clients.Elasticsearch.QueryDsl.Query Match { get; set; } @@ -58,7 +58,7 @@ public SpanMultiTermQueryDescriptor() : base() private float? BoostValue { get; set; } /// - /// Should be a multi term query (one of wildcard, fuzzy, prefix, range or regexp query) + /// Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query). /// public SpanMultiTermQueryDescriptor Match(Elastic.Clients.Elasticsearch.QueryDsl.Query match) { @@ -146,7 +146,7 @@ public SpanMultiTermQueryDescriptor() : base() private float? BoostValue { get; set; } /// - /// Should be a multi term query (one of wildcard, fuzzy, prefix, range or regexp query) + /// Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query). /// public SpanMultiTermQueryDescriptor Match(Elastic.Clients.Elasticsearch.QueryDsl.Query match) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNearQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNearQuery.g.cs index 5f4230a430c..9fa3eba78cd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNearQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNearQuery.g.cs @@ -33,10 +33,22 @@ public sealed partial class SpanNearQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Array of one or more other span type queries. + /// [JsonInclude, JsonPropertyName("clauses")] public ICollection Clauses { get; set; } + + /// + /// Controls whether matches are required to be in-order. + /// [JsonInclude, JsonPropertyName("in_order")] public bool? InOrder { get; set; } + + /// + /// Controls the maximum number of intervening unmatched positions permitted. + /// [JsonInclude, JsonPropertyName("slop")] public int? Slop { get; set; } @@ -60,6 +72,9 @@ public SpanNearQueryDescriptor() : base() private bool? InOrderValue { get; set; } private int? SlopValue { get; set; } + /// + /// Array of one or more other span type queries. + /// public SpanNearQueryDescriptor Clauses(ICollection clauses) { ClausesDescriptor = null; @@ -108,12 +123,18 @@ public SpanNearQueryDescriptor Boost(float? boost) return Self; } + /// + /// Controls whether matches are required to be in-order. + /// public SpanNearQueryDescriptor InOrder(bool? inOrder = true) { InOrderValue = inOrder; return Self; } + /// + /// Controls the maximum number of intervening unmatched positions permitted. + /// public SpanNearQueryDescriptor Slop(int? slop) { SlopValue = slop; @@ -199,6 +220,9 @@ public SpanNearQueryDescriptor() : base() private bool? InOrderValue { get; set; } private int? SlopValue { get; set; } + /// + /// Array of one or more other span type queries. + /// public SpanNearQueryDescriptor Clauses(ICollection clauses) { ClausesDescriptor = null; @@ -247,12 +271,18 @@ public SpanNearQueryDescriptor Boost(float? boost) return Self; } + /// + /// Controls whether matches are required to be in-order. + /// public SpanNearQueryDescriptor InOrder(bool? inOrder = true) { InOrderValue = inOrder; return Self; } + /// + /// Controls the maximum number of intervening unmatched positions permitted. + /// public SpanNearQueryDescriptor Slop(int? slop) { SlopValue = slop; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNotQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNotQuery.g.cs index f8045b9e584..621e596b4c4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNotQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanNotQuery.g.cs @@ -33,14 +33,34 @@ public sealed partial class SpanNotQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// The number of tokens from within the include span that can’t have overlap with the exclude span.
Equivalent to setting both `pre` and `post`. + /// [JsonInclude, JsonPropertyName("dist")] public int? Dist { get; set; } + + /// + /// Span query whose matches must not overlap those returned. + /// [JsonInclude, JsonPropertyName("exclude")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Exclude { get; set; } + + /// + /// Span query whose matches are filtered. + /// [JsonInclude, JsonPropertyName("include")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Include { get; set; } + + /// + /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// [JsonInclude, JsonPropertyName("post")] public int? Post { get; set; } + + /// + /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// [JsonInclude, JsonPropertyName("pre")] public int? Pre { get; set; } @@ -67,6 +87,9 @@ public SpanNotQueryDescriptor() : base() private int? PostValue { get; set; } private int? PreValue { get; set; } + /// + /// Span query whose matches must not overlap those returned. + /// public SpanNotQueryDescriptor Exclude(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery exclude) { ExcludeDescriptor = null; @@ -91,6 +114,9 @@ public SpanNotQueryDescriptor Exclude(Action + /// Span query whose matches are filtered. + /// public SpanNotQueryDescriptor Include(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery include) { IncludeDescriptor = null; @@ -127,18 +153,27 @@ public SpanNotQueryDescriptor Boost(float? boost) return Self; } + /// + /// The number of tokens from within the include span that can’t have overlap with the exclude span.
Equivalent to setting both `pre` and `post`. + /// public SpanNotQueryDescriptor Dist(int? dist) { DistValue = dist; return Self; } + /// + /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// public SpanNotQueryDescriptor Post(int? post) { PostValue = post; return Self; } + /// + /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// public SpanNotQueryDescriptor Pre(int? pre) { PreValue = pre; @@ -234,6 +269,9 @@ public SpanNotQueryDescriptor() : base() private int? PostValue { get; set; } private int? PreValue { get; set; } + /// + /// Span query whose matches must not overlap those returned. + /// public SpanNotQueryDescriptor Exclude(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery exclude) { ExcludeDescriptor = null; @@ -258,6 +296,9 @@ public SpanNotQueryDescriptor Exclude(Action configure) return Self; } + /// + /// Span query whose matches are filtered. + /// public SpanNotQueryDescriptor Include(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery include) { IncludeDescriptor = null; @@ -294,18 +335,27 @@ public SpanNotQueryDescriptor Boost(float? boost) return Self; } + /// + /// The number of tokens from within the include span that can’t have overlap with the exclude span.
Equivalent to setting both `pre` and `post`. + /// public SpanNotQueryDescriptor Dist(int? dist) { DistValue = dist; return Self; } + /// + /// The number of tokens after the include span that can’t have overlap with the exclude span. + /// public SpanNotQueryDescriptor Post(int? post) { PostValue = post; return Self; } + /// + /// The number of tokens before the include span that can’t have overlap with the exclude span. + /// public SpanNotQueryDescriptor Pre(int? pre) { PreValue = pre; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanOrQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanOrQuery.g.cs index 9161e7ee8c5..9f8aef7803a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanOrQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanOrQuery.g.cs @@ -33,6 +33,10 @@ public sealed partial class SpanOrQuery : SearchQuery public string? QueryName { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Array of one or more other span type queries. + /// [JsonInclude, JsonPropertyName("clauses")] public ICollection Clauses { get; set; } @@ -54,6 +58,9 @@ public SpanOrQueryDescriptor() : base() private string? QueryNameValue { get; set; } private float? BoostValue { get; set; } + /// + /// Array of one or more other span type queries. + /// public SpanOrQueryDescriptor Clauses(ICollection clauses) { ClausesDescriptor = null; @@ -167,6 +174,9 @@ public SpanOrQueryDescriptor() : base() private string? QueryNameValue { get; set; } private float? BoostValue { get; set; } + /// + /// Array of one or more other span type queries. + /// public SpanOrQueryDescriptor Clauses(ICollection clauses) { ClausesDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanWithinQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanWithinQuery.g.cs index ab62419f9f5..8cc66668b1f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanWithinQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/SpanWithinQuery.g.cs @@ -31,10 +31,18 @@ public sealed partial class SpanWithinQuery : SearchQuery { [JsonInclude, JsonPropertyName("_name")] public string? QueryName { get; set; } + + /// + /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// [JsonInclude, JsonPropertyName("big")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Big { get; set; } [JsonInclude, JsonPropertyName("boost")] public float? Boost { get; set; } + + /// + /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// [JsonInclude, JsonPropertyName("little")] public Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery Little { get; set; } @@ -58,6 +66,9 @@ public SpanWithinQueryDescriptor() : base() private string? QueryNameValue { get; set; } private float? BoostValue { get; set; } + /// + /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// public SpanWithinQueryDescriptor Big(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery big) { BigDescriptor = null; @@ -82,6 +93,9 @@ public SpanWithinQueryDescriptor Big(Action + /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// public SpanWithinQueryDescriptor Little(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery little) { LittleDescriptor = null; @@ -186,6 +200,9 @@ public SpanWithinQueryDescriptor() : base() private string? QueryNameValue { get; set; } private float? BoostValue { get; set; } + /// + /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// public SpanWithinQueryDescriptor Big(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery big) { BigDescriptor = null; @@ -210,6 +227,9 @@ public SpanWithinQueryDescriptor Big(Action configure) return Self; } + /// + /// Can be any span query.
Matching spans from `little` that are enclosed within `big` are returned. + /// public SpanWithinQueryDescriptor Little(Elastic.Clients.Elasticsearch.QueryDsl.SpanQuery little) { LittleDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermQuery.g.cs index d3e6f1ea747..1d1b370d454 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermQuery.g.cs @@ -122,7 +122,15 @@ public TermQuery(Field field) public string? QueryName { get; set; } public float? Boost { get; set; } + + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + /// public bool? CaseInsensitive { get; set; } + + /// + /// Term you wish to find in the provided field. + /// public Elastic.Clients.Elasticsearch.FieldValue Value { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -171,6 +179,9 @@ public TermQueryDescriptor Boost(float? boost) return Self; } + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + /// public TermQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { CaseInsensitiveValue = caseInsensitive; @@ -189,6 +200,9 @@ public TermQueryDescriptor Field(Expression + /// Term you wish to find in the provided field. + /// public TermQueryDescriptor Value(Elastic.Clients.Elasticsearch.FieldValue value) { ValueValue = value; @@ -260,6 +274,9 @@ public TermQueryDescriptor Boost(float? boost) return Self; } + /// + /// Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + /// public TermQueryDescriptor CaseInsensitive(bool? caseInsensitive = true) { CaseInsensitiveValue = caseInsensitive; @@ -284,6 +301,9 @@ public TermQueryDescriptor Field(Expression> return Self; } + /// + /// Term you wish to find in the provided field. + /// public TermQueryDescriptor Value(Elastic.Clients.Elasticsearch.FieldValue value) { ValueValue = value; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsSetQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsSetQuery.g.cs index 6c42320ff48..7b31a0b339d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsSetQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsSetQuery.g.cs @@ -134,8 +134,20 @@ public TermsSetQuery(Field field) public string? QueryName { get; set; } public float? Boost { get; set; } + + /// + /// Numeric field containing the number of matching terms required to return a document. + /// public Elastic.Clients.Elasticsearch.Field? MinimumShouldMatchField { get; set; } + + /// + /// Custom script containing the number of matching terms required to return a document. + /// public Elastic.Clients.Elasticsearch.Script? MinimumShouldMatchScript { get; set; } + + /// + /// Array of terms you wish to find in the provided field. + /// public ICollection Terms { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } @@ -197,24 +209,36 @@ public TermsSetQueryDescriptor Field(Expression + /// Numeric field containing the number of matching terms required to return a document. + /// public TermsSetQueryDescriptor MinimumShouldMatchField(Elastic.Clients.Elasticsearch.Field? minimumShouldMatchField) { MinimumShouldMatchFieldValue = minimumShouldMatchField; return Self; } + /// + /// Numeric field containing the number of matching terms required to return a document. + /// public TermsSetQueryDescriptor MinimumShouldMatchField(Expression> minimumShouldMatchField) { MinimumShouldMatchFieldValue = minimumShouldMatchField; return Self; } + /// + /// Custom script containing the number of matching terms required to return a document. + /// public TermsSetQueryDescriptor MinimumShouldMatchScript(Elastic.Clients.Elasticsearch.Script? minimumShouldMatchScript) { MinimumShouldMatchScriptValue = minimumShouldMatchScript; return Self; } + /// + /// Array of terms you wish to find in the provided field. + /// public TermsSetQueryDescriptor Terms(ICollection terms) { TermsValue = terms; @@ -311,30 +335,45 @@ public TermsSetQueryDescriptor Field(Expression + /// Numeric field containing the number of matching terms required to return a document. + /// public TermsSetQueryDescriptor MinimumShouldMatchField(Elastic.Clients.Elasticsearch.Field? minimumShouldMatchField) { MinimumShouldMatchFieldValue = minimumShouldMatchField; return Self; } + /// + /// Numeric field containing the number of matching terms required to return a document. + /// public TermsSetQueryDescriptor MinimumShouldMatchField(Expression> minimumShouldMatchField) { MinimumShouldMatchFieldValue = minimumShouldMatchField; return Self; } + /// + /// Numeric field containing the number of matching terms required to return a document. + /// public TermsSetQueryDescriptor MinimumShouldMatchField(Expression> minimumShouldMatchField) { MinimumShouldMatchFieldValue = minimumShouldMatchField; return Self; } + /// + /// Custom script containing the number of matching terms required to return a document. + /// public TermsSetQueryDescriptor MinimumShouldMatchScript(Elastic.Clients.Elasticsearch.Script? minimumShouldMatchScript) { MinimumShouldMatchScriptValue = minimumShouldMatchScript; return Self; } + /// + /// Array of terms you wish to find in the provided field. + /// public TermsSetQueryDescriptor Terms(ICollection terms) { TermsValue = terms; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WildcardQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WildcardQuery.g.cs index a13fd1f26e0..3accfb7555a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WildcardQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WildcardQuery.g.cs @@ -157,7 +157,7 @@ public WildcardQuery(Field field) public bool? CaseInsensitive { get; set; } /// - /// Method used to rewrite the query + /// Method used to rewrite the query. /// public string? Rewrite { get; set; } @@ -241,7 +241,7 @@ public WildcardQueryDescriptor Field(Expression - /// Method used to rewrite the query + /// Method used to rewrite the query. /// public WildcardQueryDescriptor Rewrite(string? rewrite) { @@ -378,7 +378,7 @@ public WildcardQueryDescriptor Field(Expression - /// Method used to rewrite the query + /// Method used to rewrite the query. /// public WildcardQueryDescriptor Rewrite(string? rewrite) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WrapperQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WrapperQuery.g.cs index 92e922a1104..d01c724cddc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WrapperQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WrapperQuery.g.cs @@ -35,7 +35,7 @@ public sealed partial class WrapperQuery : SearchQuery public float? Boost { get; set; } /// - /// A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + /// A base64 encoded query.
The binary data format can be any of JSON, YAML, CBOR or SMILE encodings /// [JsonInclude, JsonPropertyName("query")] public string Query { get; set; } @@ -70,7 +70,7 @@ public WrapperQueryDescriptor Boost(float? boost) } /// - /// A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + /// A base64 encoded query.
The binary data format can be any of JSON, YAML, CBOR or SMILE encodings /// public WrapperQueryDescriptor Query(string query) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SegmentsStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SegmentsStats.g.cs index 6a810979bd1..502442bc4aa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SegmentsStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SegmentsStats.g.cs @@ -29,52 +29,139 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class SegmentsStats { + /// + /// Total number of segments across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("count")] public int Count { get; init; } + + /// + /// Total amount of memory used for doc values across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("doc_values_memory")] public Elastic.Clients.Elasticsearch.ByteSize? DocValuesMemory { get; init; } + + /// + /// Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("doc_values_memory_in_bytes")] public long DocValuesMemoryInBytes { get; init; } + + /// + /// This object is not populated by the cluster stats API.
To get information on segment files, use the node stats API. + /// [JsonInclude, JsonPropertyName("file_sizes")] public IReadOnlyDictionary FileSizes { get; init; } + + /// + /// Total amount of memory used by fixed bit sets across all shards assigned to selected nodes.
Fixed bit sets are used for nested object field types and type filters for join fields. + /// [JsonInclude, JsonPropertyName("fixed_bit_set")] public Elastic.Clients.Elasticsearch.ByteSize? FixedBitSet { get; init; } + + /// + /// Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("fixed_bit_set_memory_in_bytes")] public long FixedBitSetMemoryInBytes { get; init; } [JsonInclude, JsonPropertyName("index_writer_max_memory_in_bytes")] public long? IndexWriterMaxMemoryInBytes { get; init; } + + /// + /// Total amount of memory used by all index writers across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("index_writer_memory")] public Elastic.Clients.Elasticsearch.ByteSize? IndexWriterMemory { get; init; } + + /// + /// Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("index_writer_memory_in_bytes")] public long IndexWriterMemoryInBytes { get; init; } + + /// + /// Unix timestamp, in milliseconds, of the most recently retried indexing request. + /// [JsonInclude, JsonPropertyName("max_unsafe_auto_id_timestamp")] public long MaxUnsafeAutoIdTimestamp { get; init; } + + /// + /// Total amount of memory used for segments across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("memory")] public Elastic.Clients.Elasticsearch.ByteSize? Memory { get; init; } + + /// + /// Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("memory_in_bytes")] public long MemoryInBytes { get; init; } + + /// + /// Total amount of memory used for normalization factors across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("norms_memory")] public Elastic.Clients.Elasticsearch.ByteSize? NormsMemory { get; init; } + + /// + /// Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("norms_memory_in_bytes")] public long NormsMemoryInBytes { get; init; } + + /// + /// Total amount of memory used for points across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("points_memory")] public Elastic.Clients.Elasticsearch.ByteSize? PointsMemory { get; init; } + + /// + /// Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("points_memory_in_bytes")] public long PointsMemoryInBytes { get; init; } + + /// + /// Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("stored_fields_memory_in_bytes")] public long StoredFieldsMemoryInBytes { get; init; } [JsonInclude, JsonPropertyName("stored_memory")] public Elastic.Clients.Elasticsearch.ByteSize? StoredMemory { get; init; } + + /// + /// Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("term_vectors_memory_in_bytes")] public long TermVectorsMemoryInBytes { get; init; } + + /// + /// Total amount of memory used for term vectors across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("term_vectory_memory")] public Elastic.Clients.Elasticsearch.ByteSize? TermVectoryMemory { get; init; } + + /// + /// Total amount of memory used for terms across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("terms_memory")] public Elastic.Clients.Elasticsearch.ByteSize? TermsMemory { get; init; } + + /// + /// Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("terms_memory_in_bytes")] public long TermsMemoryInBytes { get; init; } + + /// + /// Total amount of memory used by all version maps across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("version_map_memory")] public Elastic.Clients.Elasticsearch.ByteSize? VersionMapMemory { get; init; } + + /// + /// Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("version_map_memory_in_bytes")] public long VersionMapMemoryInBytes { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoreStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoreStats.g.cs index c1789e6d701..ab0f70ca2a5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoreStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoreStats.g.cs @@ -29,16 +29,39 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class StoreStats { + /// + /// A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + /// [JsonInclude, JsonPropertyName("reserved")] public Elastic.Clients.Elasticsearch.ByteSize? Reserved { get; init; } + + /// + /// A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + /// [JsonInclude, JsonPropertyName("reserved_in_bytes")] public long ReservedInBytes { get; init; } + + /// + /// Total size of all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("size")] public Elastic.Clients.Elasticsearch.ByteSize? Size { get; init; } + + /// + /// Total size, in bytes, of all shards assigned to selected nodes. + /// [JsonInclude, JsonPropertyName("size_in_bytes")] public long SizeInBytes { get; init; } + + /// + /// Total data set size of all shards assigned to selected nodes.
This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + /// [JsonInclude, JsonPropertyName("total_data_set_size")] public Elastic.Clients.Elasticsearch.ByteSize? TotalDataSetSize { get; init; } + + /// + /// Total data set size, in bytes, of all shards assigned to selected nodes.
This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + /// [JsonInclude, JsonPropertyName("total_data_set_size_in_bytes")] public long? TotalDataSetSizeInBytes { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoredScript.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoredScript.g.cs index 75cc5581256..98887ee43c8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoredScript.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoredScript.g.cs @@ -29,10 +29,17 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class StoredScript { + /// + /// Specifies the language the script is written in. + /// [JsonInclude, JsonPropertyName("lang")] public Elastic.Clients.Elasticsearch.ScriptLanguage Language { get; set; } [JsonInclude, JsonPropertyName("options")] public IDictionary? Options { get; set; } + + /// + /// The script source. + /// [JsonInclude, JsonPropertyName("source")] public string Source { get; set; } } @@ -49,6 +56,9 @@ public StoredScriptDescriptor() : base() private IDictionary? OptionsValue { get; set; } private string SourceValue { get; set; } + /// + /// Specifies the language the script is written in. + /// public StoredScriptDescriptor Language(Elastic.Clients.Elasticsearch.ScriptLanguage language) { LanguageValue = language; @@ -61,6 +71,9 @@ public StoredScriptDescriptor Options(Func, Flu return Self; } + /// + /// The script source. + /// public StoredScriptDescriptor Source(string source) { SourceValue = source; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoredScriptId.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoredScriptId.g.cs index addc935ca7b..f6e0c9f31b1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoredScriptId.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/StoredScriptId.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class StoredScriptId { + /// + /// The `id` for a stored script. + /// [JsonInclude, JsonPropertyName("id")] public Elastic.Clients.Elasticsearch.Id Id { get; set; } [JsonInclude, JsonPropertyName("params")] @@ -46,6 +49,9 @@ public StoredScriptIdDescriptor() : base() private Elastic.Clients.Elasticsearch.Id IdValue { get; set; } private IDictionary? ParamsValue { get; set; } + /// + /// The `id` for a stored script. + /// public StoredScriptIdDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { IdValue = id; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/ParentTaskInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/ParentTaskInfo.g.cs index 01ec0b5f3a2..a13c87ac7f6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/ParentTaskInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/ParentTaskInfo.g.cs @@ -54,7 +54,7 @@ public sealed partial class ParentTaskInfo [JsonInclude, JsonPropertyName("start_time_in_millis")] public long StartTimeInMillis { get; init; } [JsonInclude, JsonPropertyName("status")] - public Elastic.Clients.Elasticsearch.Tasks.TaskStatus? Status { get; init; } + public object? Status { get; init; } [JsonInclude, JsonPropertyName("type")] public string Type { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskInfo.g.cs index 7d189518243..74ad3b1b281 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskInfo.g.cs @@ -51,8 +51,12 @@ public sealed partial class TaskInfo public long RunningTimeInNanos { get; init; } [JsonInclude, JsonPropertyName("start_time_in_millis")] public long StartTimeInMillis { get; init; } + + /// + /// Task status information can vary wildly from task to task. + /// [JsonInclude, JsonPropertyName("status")] - public Elastic.Clients.Elasticsearch.Tasks.TaskStatus? Status { get; init; } + public object? Status { get; init; } [JsonInclude, JsonPropertyName("type")] public string Type { get; init; } } \ No newline at end of file diff --git a/tests/Tests/Document/Multiple/DeleteByQueryRethrottle/DeleteByQueryRethrottleApiTests.cs b/tests/Tests/Document/Multiple/DeleteByQueryRethrottle/DeleteByQueryRethrottleApiTests.cs index 389ae189c4a..6aad1787ef8 100644 --- a/tests/Tests/Document/Multiple/DeleteByQueryRethrottle/DeleteByQueryRethrottleApiTests.cs +++ b/tests/Tests/Document/Multiple/DeleteByQueryRethrottle/DeleteByQueryRethrottleApiTests.cs @@ -100,8 +100,6 @@ protected override void ExpectResponse(DeleteByQueryRethrottleResponse response) task.Type.Should().NotBeNullOrEmpty(); task.Action.Should().NotBeNullOrEmpty(); - task.Status.RequestsPerSecond.Should().Be(-1); - task.StartTimeInMillis.Should().BeGreaterThan(0); task.RunningTimeInNanos.Should().BeGreaterThan(0); task.Cancellable.Should().BeTrue();