diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ApiUrlLookup.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ApiUrlLookup.g.cs index a95353e610..a417b9b437 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ApiUrlLookup.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ApiUrlLookup.g.cs @@ -88,6 +88,10 @@ internal static class ApiUrlLookup internal static ApiUrls IndexManagementStats = new ApiUrls(new[] { "_stats", "_stats/{metric}", "{index}/_stats", "{index}/_stats/{metric}" }); internal static ApiUrls IndexManagementUpdateAliases = new ApiUrls(new[] { "_aliases" }); internal static ApiUrls IndexManagementValidateQuery = new ApiUrls(new[] { "_validate/query", "{index}/_validate/query" }); + internal static ApiUrls InferenceDelete = new ApiUrls(new[] { "_inference/{inference_id}", "_inference/{task_type}/{inference_id}" }); + internal static ApiUrls InferenceGet = new ApiUrls(new[] { "_inference", "_inference/{inference_id}", "_inference/{task_type}/{inference_id}" }); + internal static ApiUrls InferenceInference = new ApiUrls(new[] { "_inference/{inference_id}", "_inference/{task_type}/{inference_id}" }); + internal static ApiUrls InferencePut = new ApiUrls(new[] { "_inference/{inference_id}", "_inference/{task_type}/{inference_id}" }); internal static ApiUrls IngestDeleteGeoipDatabase = new ApiUrls(new[] { "_ingest/geoip/database/{id}" }); internal static ApiUrls IngestDeletePipeline = new ApiUrls(new[] { "_ingest/pipeline/{id}" }); internal static ApiUrls IngestGeoIpStats = new ApiUrls(new[] { "_ingest/geoip/stats" }); @@ -218,6 +222,7 @@ internal static class ApiUrlLookup internal static ApiUrls QueryRulesListRulesets = new ApiUrls(new[] { "_query_rules" }); internal static ApiUrls QueryRulesPutRule = new ApiUrls(new[] { "_query_rules/{ruleset_id}/_rule/{rule_id}" }); internal static ApiUrls QueryRulesPutRuleset = new ApiUrls(new[] { "_query_rules/{ruleset_id}" }); + internal static ApiUrls QueryRulesTest = new ApiUrls(new[] { "_query_rules/{ruleset_id}/_test" }); internal static ApiUrls SecurityActivateUserProfile = new ApiUrls(new[] { "_security/profile/_activate" }); internal static ApiUrls SecurityAuthenticate = new ApiUrls(new[] { "_security/_authenticate" }); internal static ApiUrls SecurityBulkDeleteRole = new ApiUrls(new[] { "_security/role" }); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs index c87bdfffbb..dbeb916562 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs @@ -36,8 +36,10 @@ public sealed partial class AsyncSearchStatusRequestParameters : RequestParamete /// /// -/// Get async search status -/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. +/// Get the async search status. +/// +/// +/// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// /// @@ -58,8 +60,10 @@ public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) /// /// -/// Get async search status -/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. +/// Get the async search status. +/// +/// +/// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// /// @@ -92,8 +96,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Get async search status -/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. +/// Get the async search status. +/// +/// +/// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs index 5f52d5657f..3d0db2d1b6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs @@ -36,8 +36,10 @@ public sealed partial class DeleteAsyncSearchRequestParameters : RequestParamete /// /// -/// Deletes an async search by identifier. -/// If the search is still running, the search request will be cancelled. +/// Delete an async search. +/// +/// +/// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// @@ -59,8 +61,10 @@ public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) /// /// -/// Deletes an async search by identifier. -/// If the search is still running, the search request will be cancelled. +/// Delete an async search. +/// +/// +/// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// @@ -94,8 +98,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes an async search by identifier. -/// If the search is still running, the search request will be cancelled. +/// Delete an async search. +/// +/// +/// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs index eb6996e314..773597370a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs @@ -62,7 +62,10 @@ public sealed partial class GetAsyncSearchRequestParameters : RequestParameters /// /// -/// Retrieves the results of a previously submitted async search request given its identifier. +/// Get async search results. +/// +/// +/// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// /// @@ -113,7 +116,10 @@ public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : b /// /// -/// Retrieves the results of a previously submitted async search request given its identifier. +/// Get async search results. +/// +/// +/// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// /// @@ -150,7 +156,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieves the results of a previously submitted async search request given its identifier. +/// Get async search results. +/// +/// +/// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs index 201bd4cacd..eecf690c28 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs @@ -138,7 +138,6 @@ public sealed partial class SubmitAsyncSearchRequestParameters : RequestParamete /// /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } - public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// /// @@ -652,10 +651,16 @@ public override void Write(Utf8JsonWriter writer, SubmitAsyncSearchRequest value /// /// -/// Runs a search request asynchronously. -/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. -/// Warning: Async search does not support scroll nor search requests that only include the suggest section. -/// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. +/// Run an async search. +/// +/// +/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. +/// +/// +/// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. +/// +/// +/// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// /// @@ -799,8 +804,6 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices /// [JsonIgnore] public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } - [JsonIgnore] - public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// /// @@ -1145,10 +1148,16 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices /// /// -/// Runs a search request asynchronously. -/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. -/// Warning: Async search does not support scroll nor search requests that only include the suggest section. -/// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. +/// Run an async search. +/// +/// +/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. +/// +/// +/// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. +/// +/// +/// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// /// @@ -1187,7 +1196,6 @@ public SubmitAsyncSearchRequestDescriptor() public SubmitAsyncSearchRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true) => Qs("keep_on_completion", keepOnCompletion); public SubmitAsyncSearchRequestDescriptor Lenient(bool? lenient = true) => Qs("lenient", lenient); public SubmitAsyncSearchRequestDescriptor MaxConcurrentShardRequests(long? maxConcurrentShardRequests) => Qs("max_concurrent_shard_requests", maxConcurrentShardRequests); - public SubmitAsyncSearchRequestDescriptor MinCompatibleShardNode(string? minCompatibleShardNode) => Qs("min_compatible_shard_node", minCompatibleShardNode); public SubmitAsyncSearchRequestDescriptor Preference(string? preference) => Qs("preference", preference); public SubmitAsyncSearchRequestDescriptor PreFilterShardSize(long? preFilterShardSize) => Qs("pre_filter_shard_size", preFilterShardSize); public SubmitAsyncSearchRequestDescriptor QueryLuceneSyntax(string? queryLuceneSyntax) => Qs("q", queryLuceneSyntax); @@ -2264,10 +2272,16 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Runs a search request asynchronously. -/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. -/// Warning: Async search does not support scroll nor search requests that only include the suggest section. -/// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. +/// Run an async search. +/// +/// +/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. +/// +/// +/// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. +/// +/// +/// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// /// @@ -2306,7 +2320,6 @@ public SubmitAsyncSearchRequestDescriptor() public SubmitAsyncSearchRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true) => Qs("keep_on_completion", keepOnCompletion); public SubmitAsyncSearchRequestDescriptor Lenient(bool? lenient = true) => Qs("lenient", lenient); public SubmitAsyncSearchRequestDescriptor MaxConcurrentShardRequests(long? maxConcurrentShardRequests) => Qs("max_concurrent_shard_requests", maxConcurrentShardRequests); - public SubmitAsyncSearchRequestDescriptor MinCompatibleShardNode(string? minCompatibleShardNode) => Qs("min_compatible_shard_node", minCompatibleShardNode); public SubmitAsyncSearchRequestDescriptor Preference(string? preference) => Qs("preference", preference); public SubmitAsyncSearchRequestDescriptor PreFilterShardSize(long? preFilterShardSize) => Qs("pre_filter_shard_size", preFilterShardSize); public SubmitAsyncSearchRequestDescriptor QueryLuceneSyntax(string? queryLuceneSyntax) => Qs("q", queryLuceneSyntax); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClearScrollRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClearScrollRequest.g.cs index 5ef6d921fe..d0dec945da 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClearScrollRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClearScrollRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class ClearScrollRequestParameters : RequestParameters /// /// -/// Clears the search context and results for a scrolling search. +/// Clear a scrolling search. +/// +/// +/// Clear the search context and results for a scrolling search. /// /// public sealed partial class ClearScrollRequest : PlainRequest @@ -61,7 +64,10 @@ public sealed partial class ClearScrollRequest : PlainRequest /// -/// Clears the search context and results for a scrolling search. +/// Clear a scrolling search. +/// +/// +/// Clear the search context and results for a scrolling search. /// /// public sealed partial class ClearScrollRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClosePointInTimeRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClosePointInTimeRequest.g.cs index fce101f496..843be08f62 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClosePointInTimeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ClosePointInTimeRequest.g.cs @@ -36,7 +36,13 @@ public sealed partial class ClosePointInTimeRequestParameters : RequestParameter /// /// -/// Closes a point-in-time. +/// Close a point in time. +/// +/// +/// A point in time must be opened explicitly before being used in search requests. +/// The keep_alive parameter tells Elasticsearch how long it should persist. +/// A point in time is automatically closed when the keep_alive period has elapsed. +/// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. /// /// public sealed partial class ClosePointInTimeRequest : PlainRequest @@ -60,7 +66,13 @@ public sealed partial class ClosePointInTimeRequest : PlainRequest /// -/// Closes a point-in-time. +/// Close a point in time. +/// +/// +/// A point in time must be opened explicitly before being used in search requests. +/// The keep_alive parameter tells Elasticsearch how long it should persist. +/// A point in time is automatically closed when the keep_alive period has elapsed. +/// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. /// /// public sealed partial class ClosePointInTimeRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs index e56fc10d40..4b332640fe 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs @@ -42,7 +42,11 @@ public sealed partial class DeleteByQueryRethrottleRequestParameters : RequestPa /// /// -/// Changes the number of requests per second for a particular Delete By Query operation. +/// Throttle a delete by query operation. +/// +/// +/// Change the number of requests per second for a particular delete by query operation. +/// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// public sealed partial class DeleteByQueryRethrottleRequest : PlainRequest @@ -70,7 +74,11 @@ public DeleteByQueryRethrottleRequest(Elastic.Clients.Elasticsearch.Serverless.T /// /// -/// Changes the number of requests per second for a particular Delete By Query operation. +/// Throttle a delete by query operation. +/// +/// +/// Change the number of requests per second for a particular delete by query operation. +/// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// public sealed partial class DeleteByQueryRethrottleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchRequest.g.cs index f01dfc28fc..ed8d5a287a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchRequest.g.cs @@ -115,6 +115,16 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices [JsonInclude, JsonPropertyName("keep_on_completion")] public bool? KeepOnCompletion { get; set; } + /// + /// + /// By default, the response of a sample query contains up to 10 samples, with one sample per unique set of join keys. Use the size + /// parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the + /// max_samples_per_key parameter. Pipes are not supported for sample queries. + /// + /// + [JsonInclude, JsonPropertyName("max_samples_per_key")] + public int? MaxSamplesPerKey { get; set; } + /// /// /// EQL query you wish to run. @@ -202,6 +212,7 @@ public EqlSearchRequestDescriptor Indices(Elastic.Clients.Elasticsear private Action>[] FilterDescriptorActions { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAliveValue { get; set; } private bool? KeepOnCompletionValue { get; set; } + private int? MaxSamplesPerKeyValue { get; set; } private string QueryValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Eql.ResultPosition? ResultPositionValue { get; set; } private IDictionary> RuntimeMappingsValue { get; set; } @@ -354,6 +365,19 @@ public EqlSearchRequestDescriptor KeepOnCompletion(bool? keepOnComple return Self; } + /// + /// + /// By default, the response of a sample query contains up to 10 samples, with one sample per unique set of join keys. Use the size + /// parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the + /// max_samples_per_key parameter. Pipes are not supported for sample queries. + /// + /// + public EqlSearchRequestDescriptor MaxSamplesPerKey(int? maxSamplesPerKey) + { + MaxSamplesPerKeyValue = maxSamplesPerKey; + return Self; + } + /// /// /// EQL query you wish to run. @@ -551,6 +575,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteBooleanValue(KeepOnCompletionValue.Value); } + if (MaxSamplesPerKeyValue.HasValue) + { + writer.WritePropertyName("max_samples_per_key"); + writer.WriteNumberValue(MaxSamplesPerKeyValue.Value); + } + writer.WritePropertyName("query"); writer.WriteStringValue(QueryValue); if (ResultPositionValue is not null) @@ -637,6 +667,7 @@ public EqlSearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverle private Action[] FilterDescriptorActions { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAliveValue { get; set; } private bool? KeepOnCompletionValue { get; set; } + private int? MaxSamplesPerKeyValue { get; set; } private string QueryValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Eql.ResultPosition? ResultPositionValue { get; set; } private IDictionary RuntimeMappingsValue { get; set; } @@ -789,6 +820,19 @@ public EqlSearchRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true return Self; } + /// + /// + /// By default, the response of a sample query contains up to 10 samples, with one sample per unique set of join keys. Use the size + /// parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the + /// max_samples_per_key parameter. Pipes are not supported for sample queries. + /// + /// + public EqlSearchRequestDescriptor MaxSamplesPerKey(int? maxSamplesPerKey) + { + MaxSamplesPerKeyValue = maxSamplesPerKey; + return Self; + } + /// /// /// EQL query you wish to run. @@ -986,6 +1030,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteBooleanValue(KeepOnCompletionValue.Value); } + if (MaxSamplesPerKeyValue.HasValue) + { + writer.WritePropertyName("max_samples_per_key"); + writer.WriteNumberValue(MaxSamplesPerKeyValue.Value); + } + writer.WritePropertyName("query"); writer.WriteStringValue(QueryValue); if (ResultPositionValue is not null) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/FieldCapsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/FieldCapsRequest.g.cs index da4e00b240..c947c93800 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/FieldCapsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/FieldCapsRequest.g.cs @@ -86,9 +86,15 @@ public sealed partial class FieldCapsRequestParameters : RequestParameters /// /// -/// The field capabilities API returns the information about the capabilities of fields among multiple indices. -/// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type -/// of keyword is returned as any other field that belongs to the keyword family. +/// Get the field capabilities. +/// +/// +/// Get information about the capabilities of fields among multiple indices. +/// +/// +/// For data streams, the API returns field capabilities among the stream’s backing indices. +/// It returns runtime fields like any other field. +/// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// public sealed partial class FieldCapsRequest : PlainRequest @@ -196,9 +202,15 @@ public FieldCapsRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indice /// /// -/// The field capabilities API returns the information about the capabilities of fields among multiple indices. -/// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type -/// of keyword is returned as any other field that belongs to the keyword family. +/// Get the field capabilities. +/// +/// +/// Get information about the capabilities of fields among multiple indices. +/// +/// +/// For data streams, the API returns field capabilities among the stream’s backing indices. +/// It returns runtime fields like any other field. +/// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// public sealed partial class FieldCapsRequestDescriptor : RequestDescriptor, FieldCapsRequestParameters> @@ -330,9 +342,15 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// The field capabilities API returns the information about the capabilities of fields among multiple indices. -/// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type -/// of keyword is returned as any other field that belongs to the keyword family. +/// Get the field capabilities. +/// +/// +/// Get information about the capabilities of fields among multiple indices. +/// +/// +/// For data streams, the API returns field capabilities among the stream’s backing indices. +/// It returns runtime fields like any other field. +/// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// public sealed partial class FieldCapsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs index 19c041d5f4..81d7198745 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class AnalyzeIndexRequestParameters : RequestParameters /// /// -/// Performs analysis on a text string and returns the resulting tokens. +/// Get tokens from text analysis. +/// The analyze API performs analysis on a text string and returns the resulting tokens. /// /// public sealed partial class AnalyzeIndexRequest : PlainRequest @@ -137,7 +138,8 @@ public AnalyzeIndexRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName? i /// /// -/// Performs analysis on a text string and returns the resulting tokens. +/// Get tokens from text analysis. +/// The analyze API performs analysis on a text string and returns the resulting tokens. /// /// public sealed partial class AnalyzeIndexRequestDescriptor : RequestDescriptor, AnalyzeIndexRequestParameters> @@ -368,7 +370,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Performs analysis on a text string and returns the resulting tokens. +/// Get tokens from text analysis. +/// The analyze API performs analysis on a text string and returns the resulting tokens. /// /// public sealed partial class AnalyzeIndexRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs index 9f27881dc8..31b5341d64 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs @@ -56,13 +56,6 @@ public sealed partial class ExistsAliasRequestParameters : RequestParameters /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - - /// - /// - /// If true, the request retrieves information from the local node only. - /// - /// - public bool? Local { get => Q("local"); set => Q("local", value); } } /// @@ -116,14 +109,6 @@ public ExistsAliasRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indi /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - - /// - /// - /// If true, the request retrieves information from the local node only. - /// - /// - [JsonIgnore] - public bool? Local { get => Q("local"); set => Q("local", value); } } /// @@ -155,7 +140,6 @@ public ExistsAliasRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Nam public ExistsAliasRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); public ExistsAliasRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public ExistsAliasRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public ExistsAliasRequestDescriptor Local(bool? local = true) => Qs("local", local); public ExistsAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -203,7 +187,6 @@ public ExistsAliasRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Nam public ExistsAliasRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); public ExistsAliasRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public ExistsAliasRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public ExistsAliasRequestDescriptor Local(bool? local = true) => Qs("local", local); public ExistsAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetAliasRequest.g.cs index 53820d6bb2..8af03179f6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/GetAliasRequest.g.cs @@ -56,13 +56,6 @@ public sealed partial class GetAliasRequestParameters : RequestParameters /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - - /// - /// - /// If true, the request retrieves information from the local node only. - /// - /// - public bool? Local { get => Q("local"); set => Q("local", value); } } /// @@ -124,14 +117,6 @@ public GetAliasRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - - /// - /// - /// If true, the request retrieves information from the local node only. - /// - /// - [JsonIgnore] - public bool? Local { get => Q("local"); set => Q("local", value); } } /// @@ -163,7 +148,6 @@ public GetAliasRequestDescriptor() public GetAliasRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); public GetAliasRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public GetAliasRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public GetAliasRequestDescriptor Local(bool? local = true) => Qs("local", local); public GetAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -211,7 +195,6 @@ public GetAliasRequestDescriptor() public GetAliasRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); public GetAliasRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public GetAliasRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public GetAliasRequestDescriptor Local(bool? local = true) => Qs("local", local); public GetAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs index 3c979b58a5..39f545869d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs @@ -65,7 +65,7 @@ public sealed partial class PutDataLifecycleRequestParameters : RequestParameter /// Update the data stream lifecycle of the specified data streams. /// /// -public sealed partial class PutDataLifecycleRequest : PlainRequest +public sealed partial class PutDataLifecycleRequest : PlainRequest, ISelfSerializable { public PutDataLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name) : base(r => r.Required("name", name)) { @@ -107,25 +107,13 @@ public PutDataLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.DataStre /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycle Lifecycle { 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. - /// - /// - [JsonInclude, JsonPropertyName("data_retention")] - public Elastic.Clients.Elasticsearch.Serverless.Duration? DataRetention { get; set; } - - /// - /// - /// If defined, every backing index will execute the configured downsampling configuration after the backing - /// index is not the data stream write index anymore. - /// - /// - [JsonInclude, JsonPropertyName("downsampling")] - public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsampling? Downsampling { get; set; } + void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + JsonSerializer.Serialize(writer, Lifecycle, options); + } } /// @@ -137,10 +125,7 @@ public PutDataLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.DataStre public sealed partial class PutDataLifecycleRequestDescriptor : RequestDescriptor { internal PutDataLifecycleRequestDescriptor(Action configure) => configure.Invoke(this); - - public PutDataLifecycleRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name) : base(r => r.Required("name", name)) - { - } + public PutDataLifecycleRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycle lifecycle, Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name) : base(r => r.Required("name", name)) => LifecycleValue = lifecycle; internal override ApiUrls ApiUrls => ApiUrlLookup.IndexManagementPutDataLifecycle; @@ -160,79 +145,36 @@ public PutDataLifecycleRequestDescriptor Name(Elastic.Clients.Elasticsearch.Serv return Self; } - private Elastic.Clients.Elasticsearch.Serverless.Duration? DataRetentionValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsampling? DownsamplingValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsamplingDescriptor DownsamplingDescriptor { get; set; } - private Action DownsamplingDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycle LifecycleValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDescriptor LifecycleDescriptor { get; set; } + private Action LifecycleDescriptorAction { 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.Serverless.Duration? dataRetention) - { - DataRetentionValue = dataRetention; - return Self; - } - - /// - /// - /// If defined, every backing index will execute the configured downsampling configuration after the backing - /// index is not the data stream write index anymore. - /// - /// - public PutDataLifecycleRequestDescriptor Downsampling(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsampling? downsampling) + public PutDataLifecycleRequestDescriptor Lifecycle(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycle lifecycle) { - DownsamplingDescriptor = null; - DownsamplingDescriptorAction = null; - DownsamplingValue = downsampling; + LifecycleDescriptor = null; + LifecycleDescriptorAction = null; + LifecycleValue = lifecycle; return Self; } - public PutDataLifecycleRequestDescriptor Downsampling(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsamplingDescriptor descriptor) + public PutDataLifecycleRequestDescriptor Lifecycle(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDescriptor descriptor) { - DownsamplingValue = null; - DownsamplingDescriptorAction = null; - DownsamplingDescriptor = descriptor; + LifecycleValue = null; + LifecycleDescriptorAction = null; + LifecycleDescriptor = descriptor; return Self; } - public PutDataLifecycleRequestDescriptor Downsampling(Action configure) + public PutDataLifecycleRequestDescriptor Lifecycle(Action configure) { - DownsamplingValue = null; - DownsamplingDescriptor = null; - DownsamplingDescriptorAction = configure; + LifecycleValue = null; + LifecycleDescriptor = null; + LifecycleDescriptorAction = configure; return Self; } protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { - writer.WriteStartObject(); - if (DataRetentionValue is not null) - { - writer.WritePropertyName("data_retention"); - JsonSerializer.Serialize(writer, DataRetentionValue, options); - } - - if (DownsamplingDescriptor is not null) - { - writer.WritePropertyName("downsampling"); - JsonSerializer.Serialize(writer, DownsamplingDescriptor, options); - } - else if (DownsamplingDescriptorAction is not null) - { - writer.WritePropertyName("downsampling"); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsamplingDescriptor(DownsamplingDescriptorAction), options); - } - else if (DownsamplingValue is not null) - { - writer.WritePropertyName("downsampling"); - JsonSerializer.Serialize(writer, DownsamplingValue, options); - } - - writer.WriteEndObject(); + JsonSerializer.Serialize(writer, LifecycleValue, options); } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SegmentsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SegmentsRequest.g.cs index 0960e65ef6..81234631b7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SegmentsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/SegmentsRequest.g.cs @@ -56,13 +56,6 @@ public sealed partial class SegmentsRequestParameters : RequestParameters /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - - /// - /// - /// If true, the request returns a verbose response. - /// - /// - public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// @@ -116,14 +109,6 @@ public SegmentsRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - - /// - /// - /// If true, the request returns a verbose response. - /// - /// - [JsonIgnore] - public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// @@ -155,7 +140,6 @@ public SegmentsRequestDescriptor() public SegmentsRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); public SegmentsRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public SegmentsRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public SegmentsRequestDescriptor Verbose(bool? verbose = true) => Qs("verbose", verbose); public SegmentsRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -197,7 +181,6 @@ public SegmentsRequestDescriptor() public SegmentsRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); public SegmentsRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public SegmentsRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public SegmentsRequestDescriptor Verbose(bool? verbose = true) => Qs("verbose", verbose); public SegmentsRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/DeleteInferenceRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/DeleteInferenceRequest.g.cs new file mode 100644 index 0000000000..b2db5f61ff --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/DeleteInferenceRequest.g.cs @@ -0,0 +1,133 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Requests; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using Elastic.Transport; +using Elastic.Transport.Extensions; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Inference; + +public sealed partial class DeleteInferenceRequestParameters : RequestParameters +{ + /// + /// + /// When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned + /// + /// + public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } + + /// + /// + /// When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields + /// + /// + public bool? Force { get => Q("force"); set => Q("force", value); } +} + +/// +/// +/// Delete an inference endpoint +/// +/// +public sealed partial class DeleteInferenceRequest : PlainRequest +{ + public DeleteInferenceRequest(Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) : base(r => r.Required("inference_id", inferenceId)) + { + } + + public DeleteInferenceRequest(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) : base(r => r.Optional("task_type", taskType).Required("inference_id", inferenceId)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.InferenceDelete; + + protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE; + + internal override bool SupportsBody => false; + + internal override string OperationName => "inference.delete"; + + /// + /// + /// When true, the endpoint is not deleted, and a list of ingest processors which reference this endpoint is returned + /// + /// + [JsonIgnore] + public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } + + /// + /// + /// When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields + /// + /// + [JsonIgnore] + public bool? Force { get => Q("force"); set => Q("force", value); } +} + +/// +/// +/// Delete an inference endpoint +/// +/// +public sealed partial class DeleteInferenceRequestDescriptor : RequestDescriptor +{ + internal DeleteInferenceRequestDescriptor(Action configure) => configure.Invoke(this); + + public DeleteInferenceRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) : base(r => r.Optional("task_type", taskType).Required("inference_id", inferenceId)) + { + } + + public DeleteInferenceRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) : base(r => r.Required("inference_id", inferenceId)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.InferenceDelete; + + protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE; + + internal override bool SupportsBody => false; + + internal override string OperationName => "inference.delete"; + + public DeleteInferenceRequestDescriptor DryRun(bool? dryRun = true) => Qs("dry_run", dryRun); + public DeleteInferenceRequestDescriptor Force(bool? force = true) => Qs("force", force); + + public DeleteInferenceRequestDescriptor InferenceId(Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) + { + RouteValues.Required("inference_id", inferenceId); + return Self; + } + + public DeleteInferenceRequestDescriptor TaskType(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType) + { + RouteValues.Optional("task_type", taskType); + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/DeleteInferenceResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/DeleteInferenceResponse.g.cs new file mode 100644 index 0000000000..87912c59bf --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/DeleteInferenceResponse.g.cs @@ -0,0 +1,40 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using Elastic.Transport.Products.Elasticsearch; +using System; +using System.Collections.Generic; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Inference; + +public sealed partial class DeleteInferenceResponse : ElasticsearchResponse +{ + /// + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// + [JsonInclude, JsonPropertyName("acknowledged")] + public bool Acknowledged { get; init; } + [JsonInclude, JsonPropertyName("pipelines")] + public IReadOnlyCollection Pipelines { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/GetInferenceRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/GetInferenceRequest.g.cs new file mode 100644 index 0000000000..f18bb03711 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/GetInferenceRequest.g.cs @@ -0,0 +1,105 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Requests; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using Elastic.Transport; +using Elastic.Transport.Extensions; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Inference; + +public sealed partial class GetInferenceRequestParameters : RequestParameters +{ +} + +/// +/// +/// Get an inference endpoint +/// +/// +public sealed partial class GetInferenceRequest : PlainRequest +{ + public GetInferenceRequest() + { + } + + public GetInferenceRequest(Elastic.Clients.Elasticsearch.Serverless.Id? inferenceId) : base(r => r.Optional("inference_id", inferenceId)) + { + } + + public GetInferenceRequest(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id? inferenceId) : base(r => r.Optional("task_type", taskType).Optional("inference_id", inferenceId)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.InferenceGet; + + protected override HttpMethod StaticHttpMethod => HttpMethod.GET; + + internal override bool SupportsBody => false; + + internal override string OperationName => "inference.get"; +} + +/// +/// +/// Get an inference endpoint +/// +/// +public sealed partial class GetInferenceRequestDescriptor : RequestDescriptor +{ + internal GetInferenceRequestDescriptor(Action configure) => configure.Invoke(this); + + public GetInferenceRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id? inferenceId) : base(r => r.Optional("task_type", taskType).Optional("inference_id", inferenceId)) + { + } + + public GetInferenceRequestDescriptor() + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.InferenceGet; + + protected override HttpMethod StaticHttpMethod => HttpMethod.GET; + + internal override bool SupportsBody => false; + + internal override string OperationName => "inference.get"; + + public GetInferenceRequestDescriptor InferenceId(Elastic.Clients.Elasticsearch.Serverless.Id? inferenceId) + { + RouteValues.Optional("inference_id", inferenceId); + return Self; + } + + public GetInferenceRequestDescriptor TaskType(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType) + { + RouteValues.Optional("task_type", taskType); + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/GetInferenceResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/GetInferenceResponse.g.cs new file mode 100644 index 0000000000..eadcef93ac --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/GetInferenceResponse.g.cs @@ -0,0 +1,33 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using Elastic.Transport.Products.Elasticsearch; +using System; +using System.Collections.Generic; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Inference; + +public sealed partial class GetInferenceResponse : ElasticsearchResponse +{ + [JsonInclude, JsonPropertyName("endpoints")] + public IReadOnlyCollection Endpoints { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/InferenceRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/InferenceRequest.g.cs new file mode 100644 index 0000000000..6e94c6b33a --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/InferenceRequest.g.cs @@ -0,0 +1,199 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Requests; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using Elastic.Transport; +using Elastic.Transport.Extensions; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Inference; + +public sealed partial class InferenceRequestParameters : RequestParameters +{ + /// + /// + /// Specifies the amount of time to wait for the inference request to complete. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } +} + +/// +/// +/// Perform inference on the service +/// +/// +public sealed partial class InferenceRequest : PlainRequest +{ + public InferenceRequest(Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) : base(r => r.Required("inference_id", inferenceId)) + { + } + + public InferenceRequest(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) : base(r => r.Optional("task_type", taskType).Required("inference_id", inferenceId)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.InferenceInference; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => true; + + internal override string OperationName => "inference.inference"; + + /// + /// + /// Specifies the amount of time to wait for the inference request to complete. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + + /// + /// + /// Inference input. + /// Either a string or an array of strings. + /// + /// + [JsonInclude, JsonPropertyName("input")] + [SingleOrManyCollectionConverter(typeof(string))] + public ICollection Input { get; set; } + + /// + /// + /// Query input, required for rerank task. + /// Not required for other tasks. + /// + /// + [JsonInclude, JsonPropertyName("query")] + public string? Query { get; set; } + + /// + /// + /// Optional task settings + /// + /// + [JsonInclude, JsonPropertyName("task_settings")] + public object? TaskSettings { get; set; } +} + +/// +/// +/// Perform inference on the service +/// +/// +public sealed partial class InferenceRequestDescriptor : RequestDescriptor +{ + internal InferenceRequestDescriptor(Action configure) => configure.Invoke(this); + + public InferenceRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) : base(r => r.Optional("task_type", taskType).Required("inference_id", inferenceId)) + { + } + + public InferenceRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) : base(r => r.Required("inference_id", inferenceId)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.InferenceInference; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => true; + + internal override string OperationName => "inference.inference"; + + public InferenceRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) => Qs("timeout", timeout); + + public InferenceRequestDescriptor InferenceId(Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) + { + RouteValues.Required("inference_id", inferenceId); + return Self; + } + + public InferenceRequestDescriptor TaskType(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType) + { + RouteValues.Optional("task_type", taskType); + return Self; + } + + private ICollection InputValue { get; set; } + private string? QueryValue { get; set; } + private object? TaskSettingsValue { get; set; } + + /// + /// + /// Inference input. + /// Either a string or an array of strings. + /// + /// + public InferenceRequestDescriptor Input(ICollection input) + { + InputValue = input; + return Self; + } + + /// + /// + /// Query input, required for rerank task. + /// Not required for other tasks. + /// + /// + public InferenceRequestDescriptor Query(string? query) + { + QueryValue = query; + return Self; + } + + /// + /// + /// Optional task settings + /// + /// + public InferenceRequestDescriptor TaskSettings(object? taskSettings) + { + TaskSettingsValue = taskSettings; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("input"); + SingleOrManySerializationHelper.Serialize(InputValue, writer, options); + if (!string.IsNullOrEmpty(QueryValue)) + { + writer.WritePropertyName("query"); + writer.WriteStringValue(QueryValue); + } + + if (TaskSettingsValue is not null) + { + writer.WritePropertyName("task_settings"); + JsonSerializer.Serialize(writer, TaskSettingsValue, options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/InferenceResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/InferenceResponse.g.cs new file mode 100644 index 0000000000..0e2891aecf --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/InferenceResponse.g.cs @@ -0,0 +1,31 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using Elastic.Transport.Products.Elasticsearch; +using System; +using System.Collections.Generic; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Inference; + +public sealed partial class InferenceResponse : ElasticsearchResponse +{ +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/PutInferenceRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/PutInferenceRequest.g.cs new file mode 100644 index 0000000000..25fcbef107 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/PutInferenceRequest.g.cs @@ -0,0 +1,132 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Requests; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using Elastic.Transport; +using Elastic.Transport.Extensions; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Inference; + +public sealed partial class PutInferenceRequestParameters : RequestParameters +{ +} + +/// +/// +/// Create an inference endpoint +/// +/// +public sealed partial class PutInferenceRequest : PlainRequest, ISelfSerializable +{ + public PutInferenceRequest(Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) : base(r => r.Required("inference_id", inferenceId)) + { + } + + public PutInferenceRequest(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) : base(r => r.Optional("task_type", taskType).Required("inference_id", inferenceId)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.InferencePut; + + protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; + + internal override bool SupportsBody => true; + + internal override string OperationName => "inference.put"; + + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Inference.InferenceEndpoint InferenceConfig { get; set; } + + void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + JsonSerializer.Serialize(writer, InferenceConfig, options); + } +} + +/// +/// +/// Create an inference endpoint +/// +/// +public sealed partial class PutInferenceRequestDescriptor : RequestDescriptor +{ + internal PutInferenceRequestDescriptor(Action configure) => configure.Invoke(this); + public PutInferenceRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Inference.InferenceEndpoint inferenceConfig, Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) : base(r => r.Optional("task_type", taskType).Required("inference_id", inferenceId)) => InferenceConfigValue = inferenceConfig; + public PutInferenceRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Inference.InferenceEndpoint inferenceConfig, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) : base(r => r.Required("inference_id", inferenceId)) => InferenceConfigValue = inferenceConfig; + + internal override ApiUrls ApiUrls => ApiUrlLookup.InferencePut; + + protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; + + internal override bool SupportsBody => true; + + internal override string OperationName => "inference.put"; + + public PutInferenceRequestDescriptor InferenceId(Elastic.Clients.Elasticsearch.Serverless.Id inferenceId) + { + RouteValues.Required("inference_id", inferenceId); + return Self; + } + + public PutInferenceRequestDescriptor TaskType(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType) + { + RouteValues.Optional("task_type", taskType); + return Self; + } + + private Elastic.Clients.Elasticsearch.Serverless.Inference.InferenceEndpoint InferenceConfigValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Inference.InferenceEndpointDescriptor InferenceConfigDescriptor { get; set; } + private Action InferenceConfigDescriptorAction { get; set; } + + public PutInferenceRequestDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Serverless.Inference.InferenceEndpoint inferenceConfig) + { + InferenceConfigDescriptor = null; + InferenceConfigDescriptorAction = null; + InferenceConfigValue = inferenceConfig; + return Self; + } + + public PutInferenceRequestDescriptor InferenceConfig(Elastic.Clients.Elasticsearch.Serverless.Inference.InferenceEndpointDescriptor descriptor) + { + InferenceConfigValue = null; + InferenceConfigDescriptorAction = null; + InferenceConfigDescriptor = descriptor; + return Self; + } + + public PutInferenceRequestDescriptor InferenceConfig(Action configure) + { + InferenceConfigValue = null; + InferenceConfigDescriptor = null; + InferenceConfigDescriptorAction = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + JsonSerializer.Serialize(writer, InferenceConfigValue, options); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/PutInferenceResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/PutInferenceResponse.g.cs new file mode 100644 index 0000000000..88c831242f --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/PutInferenceResponse.g.cs @@ -0,0 +1,70 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using Elastic.Transport.Products.Elasticsearch; +using System; +using System.Collections.Generic; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Inference; + +public sealed partial class PutInferenceResponse : ElasticsearchResponse +{ + /// + /// + /// The inference Id + /// + /// + [JsonInclude, JsonPropertyName("inference_id")] + public string InferenceId { get; init; } + + /// + /// + /// The service type + /// + /// + [JsonInclude, JsonPropertyName("service")] + public string Service { get; init; } + + /// + /// + /// Settings specific to the service + /// + /// + [JsonInclude, JsonPropertyName("service_settings")] + public object ServiceSettings { get; init; } + + /// + /// + /// Task settings specific to the service and task type + /// + /// + [JsonInclude, JsonPropertyName("task_settings")] + public object? TaskSettings { get; init; } + + /// + /// + /// The task type + /// + /// + [JsonInclude, JsonPropertyName("task_type")] + public Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType TaskType { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs index 21cd468437..3e60e8ceca 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs @@ -254,7 +254,12 @@ public override void Write(Utf8JsonWriter writer, PutDatafeedRequest value, Json /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). -/// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. +/// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had +/// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, +/// those credentials are used instead. +/// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed +/// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// [JsonConverter(typeof(PutDatafeedRequestConverter))] @@ -438,7 +443,12 @@ public PutDatafeedRequest() /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). -/// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. +/// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had +/// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, +/// those credentials are used instead. +/// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed +/// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// public sealed partial class PutDatafeedRequestDescriptor : RequestDescriptor, PutDatafeedRequestParameters> @@ -871,7 +881,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). -/// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. +/// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had +/// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, +/// those credentials are used instead. +/// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed +/// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// public sealed partial class PutDatafeedRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiGetRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiGetRequest.g.cs index 9aa85448a9..e9954b360a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiGetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiGetRequest.g.cs @@ -94,7 +94,12 @@ public sealed partial class MultiGetRequestParameters : RequestParameters /// /// -/// Allows to get multiple documents in one request. +/// Get multiple documents. +/// +/// +/// Get multiple JSON documents by ID from one or more indices. +/// If you specify an index in the request URI, you only need to specify the document IDs in the request body. +/// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// public sealed partial class MultiGetRequest : PlainRequest @@ -201,7 +206,12 @@ public MultiGetRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName? index /// /// -/// Allows to get multiple documents in one request. +/// Get multiple documents. +/// +/// +/// Get multiple JSON documents by ID from one or more indices. +/// If you specify an index in the request URI, you only need to specify the document IDs in the request body. +/// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// public sealed partial class MultiGetRequestDescriptor : RequestDescriptor, MultiGetRequestParameters> @@ -343,7 +353,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Allows to get multiple documents in one request. +/// Get multiple documents. +/// +/// +/// Get multiple JSON documents by ID from one or more indices. +/// If you specify an index in the request URI, you only need to specify the document IDs in the request body. +/// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// public sealed partial class MultiGetRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchRequest.g.cs index 8c0ef9bbda..25f73f2120 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchRequest.g.cs @@ -121,7 +121,25 @@ public sealed partial class MultiSearchRequestParameters : RequestParameters /// /// -/// Allows to execute several search operations in one request. +/// Run multiple searches. +/// +/// +/// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. +/// The structure is as follows: +/// +/// +/// header\n +/// body\n +/// header\n +/// body\n +/// +/// +/// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. +/// +/// +/// IMPORTANT: The final line of data must end with a newline character \n. +/// Each newline character may be preceded by a carriage return \r. +/// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// public sealed partial class MultiSearchRequest : PlainRequest, IStreamSerializable @@ -264,7 +282,25 @@ async Task IStreamSerializable.SerializeAsync(Stream stream, IElasticsearchClien /// /// -/// Allows to execute several search operations in one request. +/// Run multiple searches. +/// +/// +/// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. +/// The structure is as follows: +/// +/// +/// header\n +/// body\n +/// header\n +/// body\n +/// +/// +/// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. +/// +/// +/// IMPORTANT: The final line of data must end with a newline character \n. +/// Each newline character may be preceded by a carriage return \r. +/// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// public sealed partial class MultiSearchRequestDescriptor : RequestDescriptor, MultiSearchRequestParameters>, IStreamSerializable @@ -343,7 +379,25 @@ public MultiSearchRequestDescriptor AddSearches(Elastic.Clients.Elast /// /// -/// Allows to execute several search operations in one request. +/// Run multiple searches. +/// +/// +/// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. +/// The structure is as follows: +/// +/// +/// header\n +/// body\n +/// header\n +/// body\n +/// +/// +/// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. +/// +/// +/// IMPORTANT: The final line of data must end with a newline character \n. +/// Each newline character may be preceded by a carriage return \r. +/// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// public sealed partial class MultiSearchRequestDescriptor : RequestDescriptor, IStreamSerializable diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchTemplateRequest.g.cs index 3d32f3e457..1fffa2f190 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiSearchTemplateRequest.g.cs @@ -74,7 +74,7 @@ public sealed partial class MultiSearchTemplateRequestParameters : RequestParame /// /// -/// Runs multiple templated searches with a single request. +/// Run multiple templated searches. /// /// public sealed partial class MultiSearchTemplateRequest : PlainRequest, IStreamSerializable @@ -163,7 +163,7 @@ async Task IStreamSerializable.SerializeAsync(Stream stream, IElasticsearchClien /// /// -/// Runs multiple templated searches with a single request. +/// Run multiple templated searches. /// /// public sealed partial class MultiSearchTemplateRequestDescriptor : RequestDescriptor, MultiSearchTemplateRequestParameters>, IStreamSerializable @@ -235,7 +235,7 @@ public MultiSearchTemplateRequestDescriptor AddSearchTemplates(Elasti /// /// -/// Runs multiple templated searches with a single request. +/// Run multiple templated searches. /// /// public sealed partial class MultiSearchTemplateRequestDescriptor : RequestDescriptor, IStreamSerializable diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiTermVectorsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiTermVectorsRequest.g.cs index 1f4602c474..40cdd16d28 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiTermVectorsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MultiTermVectorsRequest.g.cs @@ -114,7 +114,13 @@ public sealed partial class MultiTermVectorsRequestParameters : RequestParameter /// /// -/// Returns multiple termvectors in one request. +/// Get multiple term vectors. +/// +/// +/// You can specify existing documents by index and ID or provide artificial documents in the body of the request. +/// You can specify the index in the request body or request URI. +/// The response contains a docs array with all the fetched termvectors. +/// Each element has the structure provided by the termvectors API. /// /// public sealed partial class MultiTermVectorsRequest : PlainRequest @@ -244,7 +250,13 @@ public MultiTermVectorsRequest(Elastic.Clients.Elasticsearch.Serverless.IndexNam /// /// -/// Returns multiple termvectors in one request. +/// Get multiple term vectors. +/// +/// +/// You can specify existing documents by index and ID or provide artificial documents in the body of the request. +/// You can specify the index in the request body or request URI. +/// The response contains a docs array with all the fetched termvectors. +/// Each element has the structure provided by the termvectors API. /// /// public sealed partial class MultiTermVectorsRequestDescriptor : RequestDescriptor, MultiTermVectorsRequestParameters> @@ -389,7 +401,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns multiple termvectors in one request. +/// Get multiple term vectors. +/// +/// +/// You can specify existing documents by index and ID or provide artificial documents in the body of the request. +/// You can specify the index in the request body or request URI. +/// The response contains a docs array with all the fetched termvectors. +/// Each element has the structure provided by the termvectors API. /// /// public sealed partial class MultiTermVectorsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/OpenPointInTimeRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/OpenPointInTimeRequest.g.cs index da6b9acc96..a9947bbed2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/OpenPointInTimeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/OpenPointInTimeRequest.g.cs @@ -73,13 +73,20 @@ public sealed partial class OpenPointInTimeRequestParameters : RequestParameters /// /// -/// A search request by default executes against the most recent visible data of the target indices, +/// Open a point in time. +/// +/// +/// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// +/// +/// A point in time must be opened explicitly before being used in search requests. +/// The keep_alive parameter tells Elasticsearch how long it should persist. +/// /// public sealed partial class OpenPointInTimeRequest : PlainRequest { @@ -149,13 +156,20 @@ public OpenPointInTimeRequest(Elastic.Clients.Elasticsearch.Serverless.Indices i /// /// -/// A search request by default executes against the most recent visible data of the target indices, +/// Open a point in time. +/// +/// +/// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// +/// +/// A point in time must be opened explicitly before being used in search requests. +/// The keep_alive parameter tells Elasticsearch how long it should persist. +/// /// public sealed partial class OpenPointInTimeRequestDescriptor : RequestDescriptor, OpenPointInTimeRequestParameters> { @@ -247,13 +261,20 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// A search request by default executes against the most recent visible data of the target indices, +/// Open a point in time. +/// +/// +/// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// +/// +/// A point in time must be opened explicitly before being used in search requests. +/// The keep_alive parameter tells Elasticsearch how long it should persist. +/// /// public sealed partial class OpenPointInTimeRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/TestRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/TestRequest.g.cs new file mode 100644 index 0000000000..d29a817792 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/TestRequest.g.cs @@ -0,0 +1,102 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Requests; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using Elastic.Transport; +using Elastic.Transport.Extensions; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.QueryRules; + +public sealed partial class TestRequestParameters : RequestParameters +{ +} + +/// +/// +/// Creates or updates a query ruleset. +/// +/// +public sealed partial class TestRequest : PlainRequest +{ + public TestRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId) : base(r => r.Required("ruleset_id", rulesetId)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.QueryRulesTest; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => true; + + internal override string OperationName => "query_rules.test"; + + [JsonInclude, JsonPropertyName("match_criteria")] + public IDictionary MatchCriteria { get; set; } +} + +/// +/// +/// Creates or updates a query ruleset. +/// +/// +public sealed partial class TestRequestDescriptor : RequestDescriptor +{ + internal TestRequestDescriptor(Action configure) => configure.Invoke(this); + + public TestRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId) : base(r => r.Required("ruleset_id", rulesetId)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.QueryRulesTest; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => true; + + internal override string OperationName => "query_rules.test"; + + public TestRequestDescriptor RulesetId(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId) + { + RouteValues.Required("ruleset_id", rulesetId); + return Self; + } + + private IDictionary MatchCriteriaValue { get; set; } + + public TestRequestDescriptor MatchCriteria(Func, FluentDictionary> selector) + { + MatchCriteriaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("match_criteria"); + JsonSerializer.Serialize(writer, MatchCriteriaValue, options); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/TestResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/TestResponse.g.cs new file mode 100644 index 0000000000..f2999d2d40 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/TestResponse.g.cs @@ -0,0 +1,35 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using Elastic.Transport.Products.Elasticsearch; +using System; +using System.Collections.Generic; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.QueryRules; + +public sealed partial class TestResponse : ElasticsearchResponse +{ + [JsonInclude, JsonPropertyName("matched_rules")] + public IReadOnlyCollection MatchedRules { get; init; } + [JsonInclude, JsonPropertyName("total_matched_rules")] + public int TotalMatchedRules { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RankEvalRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RankEvalRequest.g.cs index 85d9c3e904..fea2484686 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RankEvalRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RankEvalRequest.g.cs @@ -63,7 +63,10 @@ public sealed partial class RankEvalRequestParameters : RequestParameters /// /// -/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// Evaluate ranked search results. +/// +/// +/// Evaluate the quality of ranked search results over a set of typical search queries. /// /// public sealed partial class RankEvalRequest : PlainRequest @@ -135,7 +138,10 @@ public RankEvalRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices /// /// -/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// Evaluate ranked search results. +/// +/// +/// Evaluate the quality of ranked search results over a set of typical search queries. /// /// public sealed partial class RankEvalRequestDescriptor : RequestDescriptor, RankEvalRequestParameters> @@ -303,7 +309,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// Evaluate ranked search results. +/// +/// +/// Evaluate the quality of ranked search results over a set of typical search queries. /// /// public sealed partial class RankEvalRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ReindexRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ReindexRethrottleRequest.g.cs index d073864682..8bcfea0159 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ReindexRethrottleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ReindexRethrottleRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class ReindexRethrottleRequestParameters : RequestParamete /// /// -/// Copies documents from a source to a destination. +/// Throttle a reindex operation. +/// +/// +/// Change the number of requests per second for a particular reindex operation. /// /// public sealed partial class ReindexRethrottleRequest : PlainRequest @@ -70,7 +73,10 @@ public ReindexRethrottleRequest(Elastic.Clients.Elasticsearch.Serverless.Id task /// /// -/// Copies documents from a source to a destination. +/// Throttle a reindex operation. +/// +/// +/// Change the number of requests per second for a particular reindex operation. /// /// public sealed partial class ReindexRethrottleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RenderSearchTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RenderSearchTemplateRequest.g.cs index 98214e0bfa..7a9a01ec4d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RenderSearchTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/RenderSearchTemplateRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class RenderSearchTemplateRequestParameters : RequestParam /// /// -/// Renders a search template as a search request body. +/// Render a search template. +/// +/// +/// Render a search template as a search request body. /// /// public sealed partial class RenderSearchTemplateRequest : PlainRequest @@ -84,7 +87,10 @@ public RenderSearchTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Id? /// /// -/// Renders a search template as a search request body. +/// Render a search template. +/// +/// +/// Render a search template as a search request body. /// /// public sealed partial class RenderSearchTemplateRequestDescriptor : RequestDescriptor, RenderSearchTemplateRequestParameters> @@ -177,7 +183,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Renders a search template as a search request body. +/// Render a search template. +/// +/// +/// Render a search template as a search request body. /// /// public sealed partial class RenderSearchTemplateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ScrollRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ScrollRequest.g.cs index 4f722b979b..c86812de36 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ScrollRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ScrollRequest.g.cs @@ -42,7 +42,24 @@ public sealed partial class ScrollRequestParameters : RequestParameters /// /// -/// Allows to retrieve a large numbers of results from a single search request. +/// Run a scrolling search. +/// +/// +/// IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the search_after parameter with a point in time (PIT). +/// +/// +/// The scroll API gets large sets of results from a single scrolling search request. +/// To get the necessary scroll ID, submit a search API request that includes an argument for the scroll query parameter. +/// The scroll parameter indicates how long Elasticsearch should retain the search context for the request. +/// The search response returns a scroll ID in the _scroll_id response body parameter. +/// You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. +/// If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. +/// +/// +/// You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. +/// +/// +/// IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. /// /// public sealed partial class ScrollRequest : PlainRequest @@ -82,7 +99,24 @@ public sealed partial class ScrollRequest : PlainRequest /// -/// Allows to retrieve a large numbers of results from a single search request. +/// Run a scrolling search. +/// +/// +/// IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the search_after parameter with a point in time (PIT). +/// +/// +/// The scroll API gets large sets of results from a single scrolling search request. +/// To get the necessary scroll ID, submit a search API request that includes an argument for the scroll query parameter. +/// The scroll parameter indicates how long Elasticsearch should retain the search context for the request. +/// The search response returns a scroll ID in the _scroll_id response body parameter. +/// You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. +/// If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. +/// +/// +/// You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. +/// +/// +/// IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. /// /// public sealed partial class ScrollRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchMvtRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchMvtRequest.g.cs index 5c1f2d95bc..f66e7e1f32 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchMvtRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchMvtRequest.g.cs @@ -37,7 +37,9 @@ public sealed partial class SearchMvtRequestParameters : RequestParameters /// /// /// Search a vector tile. -/// Searches a vector tile for geospatial values. +/// +/// +/// Search a vector tile for geospatial values. /// /// public sealed partial class SearchMvtRequest : PlainRequest @@ -221,7 +223,9 @@ public SearchMvtRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices /// /// /// Search a vector tile. -/// Searches a vector tile for geospatial values. +/// +/// +/// Search a vector tile for geospatial values. /// /// public sealed partial class SearchMvtRequestDescriptor : RequestDescriptor, SearchMvtRequestParameters> @@ -672,7 +676,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// /// Search a vector tile. -/// Searches a vector tile for geospatial values. +/// +/// +/// Search a vector tile for geospatial values. /// /// public sealed partial class SearchMvtRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchRequest.g.cs index 79e1a49b38..d7dfb6182a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchRequest.g.cs @@ -134,14 +134,6 @@ public sealed partial class SearchRequestParameters : RequestParameters /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } - /// - /// - /// The minimum version of the node that can handle the request - /// Any handling node with a lower version will fail the request. - /// - /// - public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } - /// /// /// Nodes and shards used for the search. @@ -694,7 +686,10 @@ public override void Write(Utf8JsonWriter writer, SearchRequest value, JsonSeria /// /// -/// Returns search hits that match the query defined in the request. +/// Run a search. +/// +/// +/// Get 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. /// @@ -833,15 +828,6 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) [JsonIgnore] public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } - /// - /// - /// The minimum version of the node that can handle the request - /// Any handling node with a lower version will fail the request. - /// - /// - [JsonIgnore] - public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } - /// /// /// Nodes and shards used for the search. @@ -1287,7 +1273,10 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) /// /// -/// Returns search hits that match the query defined in the request. +/// Run a search. +/// +/// +/// Get 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. /// @@ -1325,7 +1314,6 @@ public SearchRequestDescriptor() public SearchRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); public SearchRequestDescriptor Lenient(bool? lenient = true) => Qs("lenient", lenient); public SearchRequestDescriptor MaxConcurrentShardRequests(long? maxConcurrentShardRequests) => Qs("max_concurrent_shard_requests", maxConcurrentShardRequests); - public SearchRequestDescriptor MinCompatibleShardNode(string? minCompatibleShardNode) => Qs("min_compatible_shard_node", minCompatibleShardNode); public SearchRequestDescriptor Preference(string? preference) => Qs("preference", preference); public SearchRequestDescriptor PreFilterShardSize(long? preFilterShardSize) => Qs("pre_filter_shard_size", preFilterShardSize); public SearchRequestDescriptor QueryLuceneSyntax(string? queryLuceneSyntax) => Qs("q", queryLuceneSyntax); @@ -2506,7 +2494,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns search hits that match the query defined in the request. +/// Run a search. +/// +/// +/// Get 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. /// @@ -2544,7 +2535,6 @@ public SearchRequestDescriptor() public SearchRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); public SearchRequestDescriptor Lenient(bool? lenient = true) => Qs("lenient", lenient); public SearchRequestDescriptor MaxConcurrentShardRequests(long? maxConcurrentShardRequests) => Qs("max_concurrent_shard_requests", maxConcurrentShardRequests); - public SearchRequestDescriptor MinCompatibleShardNode(string? minCompatibleShardNode) => Qs("min_compatible_shard_node", minCompatibleShardNode); public SearchRequestDescriptor Preference(string? preference) => Qs("preference", preference); public SearchRequestDescriptor PreFilterShardSize(long? preFilterShardSize) => Qs("pre_filter_shard_size", preFilterShardSize); public SearchRequestDescriptor QueryLuceneSyntax(string? queryLuceneSyntax) => Qs("q", queryLuceneSyntax); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchTemplateRequest.g.cs index e1288d7fef..3a37210a63 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SearchTemplateRequest.g.cs @@ -119,7 +119,7 @@ public sealed partial class SearchTemplateRequestParameters : RequestParameters /// /// -/// Runs a search with a search template. +/// Run a search with a search template. /// /// public sealed partial class SearchTemplateRequest : PlainRequest @@ -283,7 +283,7 @@ public SearchTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? i /// /// -/// Runs a search with a search template. +/// Run a search with a search template. /// /// public sealed partial class SearchTemplateRequestDescriptor : RequestDescriptor, SearchTemplateRequestParameters> @@ -429,7 +429,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Runs a search with a search template. +/// Run a search with a search template. /// /// public sealed partial class SearchTemplateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ActivateUserProfileRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ActivateUserProfileRequest.g.cs index 51d7f4d54b..fe394e4fec 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ActivateUserProfileRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ActivateUserProfileRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class ActivateUserProfileRequestParameters : RequestParame /// /// -/// Creates or updates a user profile on behalf of another user. +/// Activate a user profile. +/// +/// +/// Create or update a user profile on behalf of another user. /// /// public sealed partial class ActivateUserProfileRequest : PlainRequest @@ -61,7 +64,10 @@ public sealed partial class ActivateUserProfileRequest : PlainRequest /// -/// Creates or updates a user profile on behalf of another user. +/// Activate a user profile. +/// +/// +/// Create or update a user profile on behalf of another user. /// /// public sealed partial class ActivateUserProfileRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/AuthenticateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/AuthenticateRequest.g.cs index ecd2ad1876..e87105682b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/AuthenticateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/AuthenticateRequest.g.cs @@ -37,6 +37,8 @@ public sealed partial class AuthenticateRequestParameters : RequestParameters /// /// /// Authenticate a user. +/// +/// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -57,6 +59,8 @@ public sealed partial class AuthenticateRequest : PlainRequest /// /// Authenticate a user. +/// +/// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/BulkDeleteRoleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/BulkDeleteRoleRequest.g.cs index ee3942ef7a..68ea0ad9b1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/BulkDeleteRoleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/BulkDeleteRoleRequest.g.cs @@ -42,6 +42,9 @@ public sealed partial class BulkDeleteRoleRequestParameters : RequestParameters /// /// +/// Bulk delete roles. +/// +/// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -75,6 +78,9 @@ public sealed partial class BulkDeleteRoleRequest : PlainRequest /// +/// Bulk delete roles. +/// +/// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/BulkPutRoleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/BulkPutRoleRequest.g.cs index f7cf7f825e..459580f212 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/BulkPutRoleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/BulkPutRoleRequest.g.cs @@ -42,6 +42,9 @@ public sealed partial class BulkPutRoleRequestParameters : RequestParameters /// /// +/// Bulk create or update roles. +/// +/// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -75,6 +78,9 @@ public sealed partial class BulkPutRoleRequest : PlainRequest /// +/// Bulk create or update roles. +/// +/// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -121,6 +127,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// +/// Bulk create or update roles. +/// +/// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearApiKeyCacheRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearApiKeyCacheRequest.g.cs index 342b9460d4..d4817ad108 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearApiKeyCacheRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearApiKeyCacheRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class ClearApiKeyCacheRequestParameters : RequestParameter /// /// -/// Evicts a subset of all entries from the API key cache. +/// Clear the API key cache. +/// +/// +/// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// @@ -57,7 +60,10 @@ public ClearApiKeyCacheRequest(Elastic.Clients.Elasticsearch.Serverless.Ids ids) /// /// -/// Evicts a subset of all entries from the API key cache. +/// Clear the API key cache. +/// +/// +/// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedPrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedPrivilegesRequest.g.cs index 6222ec0725..71ab78556a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedPrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedPrivilegesRequest.g.cs @@ -36,7 +36,11 @@ public sealed partial class ClearCachedPrivilegesRequestParameters : RequestPara /// /// -/// Evicts application privileges from the native application privileges cache. +/// Clear the privileges cache. +/// +/// +/// Evict privileges from the native application privilege cache. +/// The cache is also automatically cleared for applications that have their privileges updated. /// /// public sealed partial class ClearCachedPrivilegesRequest : PlainRequest @@ -56,7 +60,11 @@ public ClearCachedPrivilegesRequest(Elastic.Clients.Elasticsearch.Serverless.Nam /// /// -/// Evicts application privileges from the native application privileges cache. +/// Clear the privileges cache. +/// +/// +/// Evict privileges from the native application privilege cache. +/// The cache is also automatically cleared for applications that have their privileges updated. /// /// public sealed partial class ClearCachedPrivilegesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedRealmsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedRealmsRequest.g.cs index e867442c43..88ff2437b7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedRealmsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedRealmsRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class ClearCachedRealmsRequestParameters : RequestParamete /// /// -/// Evicts users from the user cache. Can completely clear the cache or evict specific users. +/// Clear the user cache. +/// +/// +/// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// public sealed partial class ClearCachedRealmsRequest : PlainRequest @@ -70,7 +73,10 @@ public ClearCachedRealmsRequest(Elastic.Clients.Elasticsearch.Serverless.Names r /// /// -/// Evicts users from the user cache. Can completely clear the cache or evict specific users. +/// Clear the user cache. +/// +/// +/// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// public sealed partial class ClearCachedRealmsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedRolesRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedRolesRequest.g.cs index 63eb2f221d..1b9b3c6c0e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedRolesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedRolesRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class ClearCachedRolesRequestParameters : RequestParameter /// /// -/// Evicts roles from the native role cache. +/// Clear the roles cache. +/// +/// +/// Evict roles from the native role cache. /// /// public sealed partial class ClearCachedRolesRequest : PlainRequest @@ -56,7 +59,10 @@ public ClearCachedRolesRequest(Elastic.Clients.Elasticsearch.Serverless.Names na /// /// -/// Evicts roles from the native role cache. +/// Clear the roles cache. +/// +/// +/// Evict roles from the native role cache. /// /// public sealed partial class ClearCachedRolesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedServiceTokensRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedServiceTokensRequest.g.cs index 6290641f21..7005cecd4f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedServiceTokensRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/ClearCachedServiceTokensRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class ClearCachedServiceTokensRequestParameters : RequestP /// /// -/// Evicts tokens from the service account token caches. +/// Clear service account token caches. +/// +/// +/// Evict a subset of all entries from the service account token caches. /// /// public sealed partial class ClearCachedServiceTokensRequest : PlainRequest @@ -56,7 +59,10 @@ public ClearCachedServiceTokensRequest(string ns, string service, Elastic.Client /// /// -/// Evicts tokens from the service account token caches. +/// Clear service account token caches. +/// +/// +/// Evict a subset of all entries from the service account token caches. /// /// public sealed partial class ClearCachedServiceTokensRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/CreateApiKeyRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/CreateApiKeyRequest.g.cs index 45ea635401..9568152258 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/CreateApiKeyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/CreateApiKeyRequest.g.cs @@ -43,7 +43,9 @@ public sealed partial class CreateApiKeyRequestParameters : RequestParameters /// /// /// Create an API key. -/// Creates an API key for access without requiring basic authentication. +/// +/// +/// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -103,7 +105,9 @@ public sealed partial class CreateApiKeyRequest : PlainRequest /// /// Create an API key. -/// Creates an API key for access without requiring basic authentication. +/// +/// +/// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -210,7 +214,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// /// Create an API key. -/// Creates an API key for access without requiring basic authentication. +/// +/// +/// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/CreateServiceTokenRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/CreateServiceTokenRequest.g.cs index cf914c5cb4..1b16f17316 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/CreateServiceTokenRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/CreateServiceTokenRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class CreateServiceTokenRequestParameters : RequestParamet /// /// -/// Creates a service accounts token for access without requiring basic authentication. +/// Create a service account token. +/// +/// +/// Create a service accounts token for access without requiring basic authentication. /// /// public sealed partial class CreateServiceTokenRequest : PlainRequest @@ -74,7 +77,10 @@ public CreateServiceTokenRequest(string ns, string service) : base(r => r.Requir /// /// -/// Creates a service accounts token for access without requiring basic authentication. +/// Create a service account token. +/// +/// +/// Create a service accounts token for access without requiring basic authentication. /// /// public sealed partial class CreateServiceTokenRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeletePrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeletePrivilegesRequest.g.cs index b13523c31d..53e7878ab3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeletePrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeletePrivilegesRequest.g.cs @@ -42,7 +42,7 @@ public sealed partial class DeletePrivilegesRequestParameters : RequestParameter /// /// -/// Removes application privileges. +/// Delete application privileges. /// /// public sealed partial class DeletePrivilegesRequest : PlainRequest @@ -70,7 +70,7 @@ public DeletePrivilegesRequest(Elastic.Clients.Elasticsearch.Serverless.Name app /// /// -/// Removes application privileges. +/// Delete application privileges. /// /// public sealed partial class DeletePrivilegesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeleteRoleMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeleteRoleMappingRequest.g.cs index 51e64452bb..91b20085b2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeleteRoleMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeleteRoleMappingRequest.g.cs @@ -42,7 +42,7 @@ public sealed partial class DeleteRoleMappingRequestParameters : RequestParamete /// /// -/// Removes role mappings. +/// Delete role mappings. /// /// public sealed partial class DeleteRoleMappingRequest : PlainRequest @@ -70,7 +70,7 @@ public DeleteRoleMappingRequest(Elastic.Clients.Elasticsearch.Serverless.Name na /// /// -/// Removes role mappings. +/// Delete role mappings. /// /// public sealed partial class DeleteRoleMappingRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeleteRoleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeleteRoleRequest.g.cs index 8b78b92a09..511239673c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeleteRoleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeleteRoleRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class DeleteRoleRequestParameters : RequestParameters /// /// -/// Removes roles in the native realm. +/// Delete roles. +/// +/// +/// Delete roles in the native realm. /// /// public sealed partial class DeleteRoleRequest : PlainRequest @@ -70,7 +73,10 @@ public DeleteRoleRequest(Elastic.Clients.Elasticsearch.Serverless.Name name) : b /// /// -/// Removes roles in the native realm. +/// Delete roles. +/// +/// +/// Delete roles in the native realm. /// /// public sealed partial class DeleteRoleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeleteServiceTokenRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeleteServiceTokenRequest.g.cs index 48fd4aeb88..ce2465d95d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeleteServiceTokenRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DeleteServiceTokenRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class DeleteServiceTokenRequestParameters : RequestParamet /// /// -/// Deletes a service account token. +/// Delete service account tokens. +/// +/// +/// Delete service account tokens for a service in a specified namespace. /// /// public sealed partial class DeleteServiceTokenRequest : PlainRequest @@ -70,7 +73,10 @@ public DeleteServiceTokenRequest(string ns, string service, Elastic.Clients.Elas /// /// -/// Deletes a service account token. +/// Delete service account tokens. +/// +/// +/// Delete service account tokens for a service in a specified namespace. /// /// public sealed partial class DeleteServiceTokenRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DisableUserProfileRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DisableUserProfileRequest.g.cs index ffe29e0129..a3b2005119 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DisableUserProfileRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/DisableUserProfileRequest.g.cs @@ -44,7 +44,10 @@ public sealed partial class DisableUserProfileRequestParameters : RequestParamet /// /// -/// Disables a user profile so it's not visible in user profile searches. +/// Disable a user profile. +/// +/// +/// Disable user profiles so that they are not visible in user profile searches. /// /// public sealed partial class DisableUserProfileRequest : PlainRequest @@ -74,7 +77,10 @@ public DisableUserProfileRequest(string uid) : base(r => r.Required("uid", uid)) /// /// -/// Disables a user profile so it's not visible in user profile searches. +/// Disable a user profile. +/// +/// +/// Disable user profiles so that they are not visible in user profile searches. /// /// public sealed partial class DisableUserProfileRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/EnableUserProfileRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/EnableUserProfileRequest.g.cs index 4e0b5e25e0..68aba25f44 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/EnableUserProfileRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/EnableUserProfileRequest.g.cs @@ -44,7 +44,10 @@ public sealed partial class EnableUserProfileRequestParameters : RequestParamete /// /// -/// Enables a user profile so it's visible in user profile searches. +/// Enable a user profile. +/// +/// +/// Enable user profiles to make them visible in user profile searches. /// /// public sealed partial class EnableUserProfileRequest : PlainRequest @@ -74,7 +77,10 @@ public EnableUserProfileRequest(string uid) : base(r => r.Required("uid", uid)) /// /// -/// Enables a user profile so it's visible in user profile searches. +/// Enable a user profile. +/// +/// +/// Enable user profiles to make them visible in user profile searches. /// /// public sealed partial class EnableUserProfileRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetApiKeyRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetApiKeyRequest.g.cs index 4b6499dc56..81ba73b301 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetApiKeyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetApiKeyRequest.g.cs @@ -101,6 +101,8 @@ public sealed partial class GetApiKeyRequestParameters : RequestParameters /// /// /// Get API key information. +/// +/// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -193,6 +195,8 @@ public sealed partial class GetApiKeyRequest : PlainRequest /// /// Get API key information. +/// +/// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetBuiltinPrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetBuiltinPrivilegesRequest.g.cs index 326829e915..b8873b769a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetBuiltinPrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetBuiltinPrivilegesRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class GetBuiltinPrivilegesRequestParameters : RequestParam /// /// -/// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. +/// Get builtin privileges. +/// +/// +/// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// public sealed partial class GetBuiltinPrivilegesRequest : PlainRequest @@ -52,7 +55,10 @@ public sealed partial class GetBuiltinPrivilegesRequest : PlainRequest /// -/// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. +/// Get builtin privileges. +/// +/// +/// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// public sealed partial class GetBuiltinPrivilegesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetBuiltinPrivilegesResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetBuiltinPrivilegesResponse.g.cs index f8523f5be5..289a4f1da5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetBuiltinPrivilegesResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetBuiltinPrivilegesResponse.g.cs @@ -29,7 +29,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Security; public sealed partial class GetBuiltinPrivilegesResponse : ElasticsearchResponse { [JsonInclude, JsonPropertyName("cluster")] - public IReadOnlyCollection Cluster { get; init; } + public IReadOnlyCollection Cluster { get; init; } [JsonInclude, JsonPropertyName("index")] public IReadOnlyCollection Index { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetPrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetPrivilegesRequest.g.cs index da45eb97fe..a90bea1fdd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetPrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetPrivilegesRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class GetPrivilegesRequestParameters : RequestParameters /// /// -/// Retrieves application privileges. +/// Get application privileges. /// /// public sealed partial class GetPrivilegesRequest : PlainRequest @@ -64,7 +64,7 @@ public GetPrivilegesRequest(Elastic.Clients.Elasticsearch.Serverless.Name? appli /// /// -/// Retrieves application privileges. +/// Get application privileges. /// /// public sealed partial class GetPrivilegesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetRoleMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetRoleMappingRequest.g.cs index 30e94b5b7f..a454c8e731 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetRoleMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetRoleMappingRequest.g.cs @@ -36,7 +36,12 @@ public sealed partial class GetRoleMappingRequestParameters : RequestParameters /// /// -/// Retrieves role mappings. +/// Get role mappings. +/// +/// +/// Role mappings define which roles are assigned to each user. +/// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. +/// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// public sealed partial class GetRoleMappingRequest : PlainRequest @@ -60,7 +65,12 @@ public GetRoleMappingRequest(Elastic.Clients.Elasticsearch.Serverless.Names? nam /// /// -/// Retrieves role mappings. +/// Get role mappings. +/// +/// +/// Role mappings define which roles are assigned to each user. +/// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. +/// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// public sealed partial class GetRoleMappingRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetRoleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetRoleRequest.g.cs index f4132f81a2..38491b4083 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetRoleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetRoleRequest.g.cs @@ -36,8 +36,10 @@ public sealed partial class GetRoleRequestParameters : RequestParameters /// /// -/// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. -/// The get roles API cannot retrieve roles that are defined in roles files. +/// Get roles. +/// +/// +/// Get roles in the native realm. /// /// public sealed partial class GetRoleRequest : PlainRequest @@ -61,8 +63,10 @@ public GetRoleRequest(Elastic.Clients.Elasticsearch.Serverless.Names? name) : ba /// /// -/// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. -/// The get roles API cannot retrieve roles that are defined in roles files. +/// Get roles. +/// +/// +/// Get roles in the native realm. /// /// public sealed partial class GetRoleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetServiceAccountsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetServiceAccountsRequest.g.cs index 3d722b0eb8..bf6cd184fd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetServiceAccountsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetServiceAccountsRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class GetServiceAccountsRequestParameters : RequestParamet /// /// -/// This API returns a list of service accounts that match the provided path parameter(s). +/// Get service accounts. +/// +/// +/// Get a list of service accounts that match the provided path parameters. /// /// public sealed partial class GetServiceAccountsRequest : PlainRequest @@ -64,7 +67,10 @@ public GetServiceAccountsRequest(string? ns) : base(r => r.Optional("namespace", /// /// -/// This API returns a list of service accounts that match the provided path parameter(s). +/// Get service accounts. +/// +/// +/// Get a list of service accounts that match the provided path parameters. /// /// public sealed partial class GetServiceAccountsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetServiceCredentialsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetServiceCredentialsRequest.g.cs index 3d2a0ecfb8..f343ece9bb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetServiceCredentialsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetServiceCredentialsRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class GetServiceCredentialsRequestParameters : RequestPara /// /// -/// Retrieves information of all service credentials for a service account. +/// Get service account credentials. /// /// public sealed partial class GetServiceCredentialsRequest : PlainRequest @@ -56,7 +56,7 @@ public GetServiceCredentialsRequest(string ns, Elastic.Clients.Elasticsearch.Ser /// /// -/// Retrieves information of all service credentials for a service account. +/// Get service account credentials. /// /// public sealed partial class GetServiceCredentialsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetTokenRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetTokenRequest.g.cs index 0fea9bc36d..52d992c21c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetTokenRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetTokenRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class GetTokenRequestParameters : RequestParameters /// /// -/// Creates a bearer token for access without requiring basic authentication. +/// Get a token. +/// +/// +/// Create a bearer token for access without requiring basic authentication. /// /// public sealed partial class GetTokenRequest : PlainRequest @@ -65,7 +68,10 @@ public sealed partial class GetTokenRequest : PlainRequest /// -/// Creates a bearer token for access without requiring basic authentication. +/// Get a token. +/// +/// +/// Create a bearer token for access without requiring basic authentication. /// /// public sealed partial class GetTokenRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetUserPrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetUserPrivilegesRequest.g.cs index 3f6b988aad..6e0183f4d6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetUserPrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetUserPrivilegesRequest.g.cs @@ -50,7 +50,7 @@ public sealed partial class GetUserPrivilegesRequestParameters : RequestParamete /// /// -/// Retrieves security privileges for the logged in user. +/// Get user privileges. /// /// public sealed partial class GetUserPrivilegesRequest : PlainRequest @@ -84,7 +84,7 @@ public sealed partial class GetUserPrivilegesRequest : PlainRequest /// -/// Retrieves security privileges for the logged in user. +/// Get user privileges. /// /// public sealed partial class GetUserPrivilegesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetUserProfileRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetUserProfileRequest.g.cs index bb282a71b6..5f0dd65f11 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetUserProfileRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GetUserProfileRequest.g.cs @@ -45,7 +45,10 @@ public sealed partial class GetUserProfileRequestParameters : RequestParameters /// /// -/// Retrieves a user's profile using the unique profile ID. +/// Get a user profile. +/// +/// +/// Get a user's profile using the unique profile ID. /// /// public sealed partial class GetUserProfileRequest : PlainRequest @@ -76,7 +79,10 @@ public GetUserProfileRequest(IReadOnlyCollection uid) : base(r => r.Requ /// /// -/// Retrieves a user's profile using the unique profile ID. +/// Get a user profile. +/// +/// +/// Get a user's profile using the unique profile ID. /// /// public sealed partial class GetUserProfileRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GrantApiKeyRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GrantApiKeyRequest.g.cs index 250badd561..91b196ec00 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GrantApiKeyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/GrantApiKeyRequest.g.cs @@ -36,8 +36,11 @@ public sealed partial class GrantApiKeyRequestParameters : RequestParameters /// /// -/// Creates an API key on behalf of another user. -/// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. +/// Grant an API key. +/// +/// +/// Create an API key on behalf of another user. +/// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -120,8 +123,11 @@ public sealed partial class GrantApiKeyRequest : PlainRequest /// -/// Creates an API key on behalf of another user. -/// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. +/// Grant an API key. +/// +/// +/// Create an API key on behalf of another user. +/// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -303,8 +309,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Creates an API key on behalf of another user. -/// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. +/// Grant an API key. +/// +/// +/// Create an API key on behalf of another user. +/// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/HasPrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/HasPrivilegesRequest.g.cs index dbeec56ac2..103009be8c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/HasPrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/HasPrivilegesRequest.g.cs @@ -37,7 +37,9 @@ public sealed partial class HasPrivilegesRequestParameters : RequestParameters /// /// /// Check user privileges. -/// Determines whether the specified user has a specified list of privileges. +/// +/// +/// Determine whether the specified user has a specified list of privileges. /// /// public sealed partial class HasPrivilegesRequest : PlainRequest @@ -75,7 +77,9 @@ public HasPrivilegesRequest(Elastic.Clients.Elasticsearch.Serverless.Name? user) /// /// /// Check user privileges. -/// Determines whether the specified user has a specified list of privileges. +/// +/// +/// Determine whether the specified user has a specified list of privileges. /// /// public sealed partial class HasPrivilegesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/HasPrivilegesUserProfileRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/HasPrivilegesUserProfileRequest.g.cs index ec0fc8461a..56c7c266a7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/HasPrivilegesUserProfileRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/HasPrivilegesUserProfileRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class HasPrivilegesUserProfileRequestParameters : RequestP /// /// -/// Determines whether the users associated with the specified profile IDs have all the requested privileges. +/// Check user profile privileges. +/// +/// +/// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// public sealed partial class HasPrivilegesUserProfileRequest : PlainRequest @@ -63,7 +66,10 @@ public sealed partial class HasPrivilegesUserProfileRequest : PlainRequest /// -/// Determines whether the users associated with the specified profile IDs have all the requested privileges. +/// Check user profile privileges. +/// +/// +/// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// public sealed partial class HasPrivilegesUserProfileRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/InvalidateApiKeyRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/InvalidateApiKeyRequest.g.cs index d9256ca110..c4d81214b8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/InvalidateApiKeyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/InvalidateApiKeyRequest.g.cs @@ -37,7 +37,10 @@ public sealed partial class InvalidateApiKeyRequestParameters : RequestParameter /// /// /// Invalidate API keys. -/// Invalidates one or more API keys. +/// +/// +/// This API invalidates API keys created by the create API key or grant API key APIs. +/// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -55,7 +58,7 @@ public sealed partial class InvalidateApiKeyRequestParameters : RequestParameter /// /// /// -/// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. +/// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -122,7 +125,10 @@ public sealed partial class InvalidateApiKeyRequest : PlainRequest /// /// Invalidate API keys. -/// Invalidates one or more API keys. +/// +/// +/// This API invalidates API keys created by the create API key or grant API key APIs. +/// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -140,7 +146,7 @@ public sealed partial class InvalidateApiKeyRequest : PlainRequest /// /// -/// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. +/// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/InvalidateTokenRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/InvalidateTokenRequest.g.cs index 3f146541c7..91ad1b235a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/InvalidateTokenRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/InvalidateTokenRequest.g.cs @@ -36,7 +36,16 @@ public sealed partial class InvalidateTokenRequestParameters : RequestParameters /// /// -/// Invalidates one or more access tokens or refresh tokens. +/// Invalidate a token. +/// +/// +/// The access tokens returned by the get token API have a finite period of time for which they are valid. +/// After that time period, they can no longer be used. +/// The time period is defined by the xpack.security.authc.token.timeout setting. +/// +/// +/// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. +/// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// public sealed partial class InvalidateTokenRequest : PlainRequest @@ -61,7 +70,16 @@ public sealed partial class InvalidateTokenRequest : PlainRequest /// -/// Invalidates one or more access tokens or refresh tokens. +/// Invalidate a token. +/// +/// +/// The access tokens returned by the get token API have a finite period of time for which they are valid. +/// After that time period, they can no longer be used. +/// The time period is defined by the xpack.security.authc.token.timeout setting. +/// +/// +/// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. +/// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// public sealed partial class InvalidateTokenRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/PutPrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/PutPrivilegesRequest.g.cs index ab3366a550..2a4b0e681d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/PutPrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/PutPrivilegesRequest.g.cs @@ -44,7 +44,7 @@ public sealed partial class PutPrivilegesRequestParameters : RequestParameters /// /// -/// Adds or updates application privileges. +/// Create or update application privileges. /// /// public sealed partial class PutPrivilegesRequest : PlainRequest, ISelfSerializable @@ -74,7 +74,7 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op /// /// -/// Adds or updates application privileges. +/// Create or update application privileges. /// /// public sealed partial class PutPrivilegesRequestDescriptor : RequestDescriptor, ISelfSerializable diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/PutRoleMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/PutRoleMappingRequest.g.cs index 9be7d80b89..8b012008cd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/PutRoleMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/PutRoleMappingRequest.g.cs @@ -42,7 +42,16 @@ public sealed partial class PutRoleMappingRequestParameters : RequestParameters /// /// -/// Creates and updates role mappings. +/// Create or update role mappings. +/// +/// +/// Role mappings define which roles are assigned to each user. +/// Each mapping has rules that identify users and a list of roles that are granted to those users. +/// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. +/// +/// +/// This API does not create roles. Rather, it maps users to existing roles. +/// Roles can be created by using the create or update roles API or roles files. /// /// public sealed partial class PutRoleMappingRequest : PlainRequest @@ -82,7 +91,16 @@ public PutRoleMappingRequest(Elastic.Clients.Elasticsearch.Serverless.Name name) /// /// -/// Creates and updates role mappings. +/// Create or update role mappings. +/// +/// +/// Role mappings define which roles are assigned to each user. +/// Each mapping has rules that identify users and a list of roles that are granted to those users. +/// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. +/// +/// +/// This API does not create roles. Rather, it maps users to existing roles. +/// Roles can be created by using the create or update roles API or roles files. /// /// public sealed partial class PutRoleMappingRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/PutRoleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/PutRoleRequest.g.cs index 17b733fefa..7cb42023af 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/PutRoleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/PutRoleRequest.g.cs @@ -42,8 +42,12 @@ public sealed partial class PutRoleRequestParameters : RequestParameters /// /// -/// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. +/// Create or update roles. +/// +/// +/// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. +/// File-based role management is not available in Elastic Serverless. /// /// public sealed partial class PutRoleRequest : PlainRequest @@ -127,8 +131,12 @@ public PutRoleRequest(Elastic.Clients.Elasticsearch.Serverless.Name name) : base /// /// -/// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. +/// Create or update roles. +/// +/// +/// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. +/// File-based role management is not available in Elastic Serverless. /// /// public sealed partial class PutRoleRequestDescriptor : RequestDescriptor, PutRoleRequestParameters> @@ -407,8 +415,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. +/// Create or update roles. +/// +/// +/// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. +/// File-based role management is not available in Elastic Serverless. /// /// public sealed partial class PutRoleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/QueryApiKeysRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/QueryApiKeysRequest.g.cs index 7e74a7993c..4da4639b1b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/QueryApiKeysRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/QueryApiKeysRequest.g.cs @@ -153,8 +153,10 @@ public override void Write(Utf8JsonWriter writer, QueryApiKeysRequest value, Jso /// /// -/// Query API keys. -/// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. +/// Find API keys with a query. +/// +/// +/// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// [JsonConverter(typeof(QueryApiKeysRequestConverter))] @@ -263,8 +265,10 @@ public QueryApiKeysRequest() /// /// -/// Query API keys. -/// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. +/// Find API keys with a query. +/// +/// +/// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// public sealed partial class QueryApiKeysRequestDescriptor : RequestDescriptor, QueryApiKeysRequestParameters> @@ -505,8 +509,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Query API keys. -/// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. +/// Find API keys with a query. +/// +/// +/// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// public sealed partial class QueryApiKeysRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/QueryRoleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/QueryRoleRequest.g.cs index 87f3f201e4..7aea332007 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/QueryRoleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/QueryRoleRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class QueryRoleRequestParameters : RequestParameters /// /// -/// Retrieves roles in a paginated manner. You can optionally filter the results with a query. +/// Find roles with a query. +/// +/// +/// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// public sealed partial class QueryRoleRequest : PlainRequest @@ -103,7 +106,10 @@ public sealed partial class QueryRoleRequest : PlainRequest /// -/// Retrieves roles in a paginated manner. You can optionally filter the results with a query. +/// Find roles with a query. +/// +/// +/// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// public sealed partial class QueryRoleRequestDescriptor : RequestDescriptor, QueryRoleRequestParameters> @@ -318,7 +324,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieves roles in a paginated manner. You can optionally filter the results with a query. +/// Find roles with a query. +/// +/// +/// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// public sealed partial class QueryRoleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/QueryUserRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/QueryUserRequest.g.cs index 0f1142d276..3d9242111b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/QueryUserRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/QueryUserRequest.g.cs @@ -42,7 +42,11 @@ public sealed partial class QueryUserRequestParameters : RequestParameters /// /// -/// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. +/// Find users with a query. +/// +/// +/// Get information for users in a paginated manner. +/// You can optionally filter the results with a query. /// /// public sealed partial class QueryUserRequest : PlainRequest @@ -116,7 +120,11 @@ public sealed partial class QueryUserRequest : PlainRequest /// -/// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. +/// Find users with a query. +/// +/// +/// Get information for users in a paginated manner. +/// You can optionally filter the results with a query. /// /// public sealed partial class QueryUserRequestDescriptor : RequestDescriptor, QueryUserRequestParameters> @@ -332,7 +340,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. +/// Find users with a query. +/// +/// +/// Get information for users in a paginated manner. +/// You can optionally filter the results with a query. /// /// public sealed partial class QueryUserRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlAuthenticateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlAuthenticateRequest.g.cs index 148ca66cd0..8222f4fdbf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlAuthenticateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlAuthenticateRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class SamlAuthenticateRequestParameters : RequestParameter /// /// -/// Submits a SAML Response message to Elasticsearch for consumption. +/// Authenticate SAML. +/// +/// +/// Submits a SAML response message to Elasticsearch for consumption. /// /// public sealed partial class SamlAuthenticateRequest : PlainRequest @@ -76,7 +79,10 @@ public sealed partial class SamlAuthenticateRequest : PlainRequest /// -/// Submits a SAML Response message to Elasticsearch for consumption. +/// Authenticate SAML. +/// +/// +/// Submits a SAML response message to Elasticsearch for consumption. /// /// public sealed partial class SamlAuthenticateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlCompleteLogoutRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlCompleteLogoutRequest.g.cs index 66f777e8d7..58b98982f3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlCompleteLogoutRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlCompleteLogoutRequest.g.cs @@ -36,6 +36,9 @@ public sealed partial class SamlCompleteLogoutRequestParameters : RequestParamet /// /// +/// Logout of SAML completely. +/// +/// /// Verifies the logout response sent from the SAML IdP. /// /// @@ -84,6 +87,9 @@ public sealed partial class SamlCompleteLogoutRequest : PlainRequest /// +/// Logout of SAML completely. +/// +/// /// Verifies the logout response sent from the SAML IdP. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlInvalidateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlInvalidateRequest.g.cs index cdcc6ca1c5..b631761eb4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlInvalidateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlInvalidateRequest.g.cs @@ -36,6 +36,9 @@ public sealed partial class SamlInvalidateRequestParameters : RequestParameters /// /// +/// Invalidate SAML. +/// +/// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// @@ -80,6 +83,9 @@ public sealed partial class SamlInvalidateRequest : PlainRequest /// +/// Invalidate SAML. +/// +/// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlLogoutRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlLogoutRequest.g.cs index 0423c1881d..9b2ffde5d0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlLogoutRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlLogoutRequest.g.cs @@ -36,6 +36,9 @@ public sealed partial class SamlLogoutRequestParameters : RequestParameters /// /// +/// Logout of SAML. +/// +/// /// Submits a request to invalidate an access token and refresh token. /// /// @@ -70,6 +73,9 @@ public sealed partial class SamlLogoutRequest : PlainRequest /// +/// Logout of SAML. +/// +/// /// Submits a request to invalidate an access token and refresh token. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlPrepareAuthenticationRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlPrepareAuthenticationRequest.g.cs index 92570ab779..fab192886e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlPrepareAuthenticationRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlPrepareAuthenticationRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class SamlPrepareAuthenticationRequestParameters : Request /// /// -/// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. +/// Prepare SAML authentication. +/// +/// +/// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// public sealed partial class SamlPrepareAuthenticationRequest : PlainRequest @@ -79,7 +82,10 @@ public sealed partial class SamlPrepareAuthenticationRequest : PlainRequest /// -/// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. +/// Prepare SAML authentication. +/// +/// +/// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// public sealed partial class SamlPrepareAuthenticationRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlServiceProviderMetadataRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlServiceProviderMetadataRequest.g.cs index 91804f5cb3..601fd669ec 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlServiceProviderMetadataRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SamlServiceProviderMetadataRequest.g.cs @@ -36,6 +36,9 @@ public sealed partial class SamlServiceProviderMetadataRequestParameters : Reque /// /// +/// Create SAML service provider metadata. +/// +/// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// @@ -56,6 +59,9 @@ public SamlServiceProviderMetadataRequest(Elastic.Clients.Elasticsearch.Serverle /// /// +/// Create SAML service provider metadata. +/// +/// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SuggestUserProfilesRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SuggestUserProfilesRequest.g.cs index 48bb480009..8aa590fb3b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SuggestUserProfilesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/SuggestUserProfilesRequest.g.cs @@ -36,6 +36,9 @@ public sealed partial class SuggestUserProfilesRequestParameters : RequestParame /// /// +/// Suggest a user profile. +/// +/// /// Get suggestions for user profiles that match specified search criteria. /// /// @@ -92,6 +95,9 @@ public sealed partial class SuggestUserProfilesRequest : PlainRequest /// +/// Suggest a user profile. +/// +/// /// Get suggestions for user profiles that match specified search criteria. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/UpdateApiKeyRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/UpdateApiKeyRequest.g.cs index 06552e2e13..aa6dbc91c9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/UpdateApiKeyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/UpdateApiKeyRequest.g.cs @@ -37,6 +37,8 @@ public sealed partial class UpdateApiKeyRequestParameters : RequestParameters /// /// /// Update an API key. +/// +/// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -94,6 +96,8 @@ public UpdateApiKeyRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : bas /// /// /// Update an API key. +/// +/// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -196,6 +200,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// /// Update an API key. +/// +/// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/UpdateUserProfileDataRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/UpdateUserProfileDataRequest.g.cs index 632005a5cc..3b56008f30 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/UpdateUserProfileDataRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/UpdateUserProfileDataRequest.g.cs @@ -58,7 +58,10 @@ public sealed partial class UpdateUserProfileDataRequestParameters : RequestPara /// /// -/// Updates specific data for the user profile that's associated with the specified unique ID. +/// Update user profile data. +/// +/// +/// Update specific data for the user profile that is associated with a unique ID. /// /// public sealed partial class UpdateUserProfileDataRequest : PlainRequest @@ -122,7 +125,10 @@ public UpdateUserProfileDataRequest(string uid) : base(r => r.Required("uid", ui /// /// -/// Updates specific data for the user profile that's associated with the specified unique ID. +/// Update user profile data. +/// +/// +/// Update specific data for the user profile that is associated with a unique ID. /// /// public sealed partial class UpdateUserProfileDataRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermVectorsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermVectorsRequest.g.cs index 9819d12388..7854f37940 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermVectorsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermVectorsRequest.g.cs @@ -115,7 +115,9 @@ public sealed partial class TermVectorsRequestParameters : RequestParameters /// /// /// Get term vector information. -/// Returns information and statistics about terms in the fields of a particular document. +/// +/// +/// Get information and statistics about terms in the fields of a particular document. /// /// public sealed partial class TermVectorsRequest : PlainRequest @@ -255,7 +257,9 @@ public TermVectorsRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName ind /// /// /// Get term vector information. -/// Returns information and statistics about terms in the fields of a particular document. +/// +/// +/// Get information and statistics about terms in the fields of a particular document. /// /// public sealed partial class TermVectorsRequestDescriptor : RequestDescriptor, TermVectorsRequestParameters> diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermsEnumRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermsEnumRequest.g.cs index 52e089690d..5173a597ba 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermsEnumRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TermsEnumRequest.g.cs @@ -36,7 +36,18 @@ public sealed partial class TermsEnumRequestParameters : RequestParameters /// /// -/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// Get terms in an index. +/// +/// +/// Discover terms that match a partial string in an index. +/// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. +/// +/// +/// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. +/// This can occur due to a few reasons, such as a request timeout or a node error. +/// +/// +/// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// public sealed partial class TermsEnumRequest : PlainRequest @@ -106,7 +117,18 @@ public TermsEnumRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName index /// /// -/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// Get terms in an index. +/// +/// +/// Discover terms that match a partial string in an index. +/// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. +/// +/// +/// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. +/// This can occur due to a few reasons, such as a request timeout or a node error. +/// +/// +/// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// public sealed partial class TermsEnumRequestDescriptor : RequestDescriptor, TermsEnumRequestParameters> @@ -314,7 +336,18 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// Get terms in an index. +/// +/// +/// Discover terms that match a partial string in an index. +/// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. +/// +/// +/// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. +/// This can occur due to a few reasons, such as a request timeout or a node error. +/// +/// +/// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// public sealed partial class TermsEnumRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs index a10de0936d..a5f50b58ef 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs @@ -42,7 +42,11 @@ public sealed partial class UpdateByQueryRethrottleRequestParameters : RequestPa /// /// -/// Changes the number of requests per second for a particular Update By Query operation. +/// Throttle an update by query operation. +/// +/// +/// Change the number of requests per second for a particular update by query operation. +/// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// public sealed partial class UpdateByQueryRethrottleRequest : PlainRequest @@ -70,7 +74,11 @@ public UpdateByQueryRethrottleRequest(Elastic.Clients.Elasticsearch.Serverless.I /// /// -/// Changes the number of requests per second for a particular Update By Query operation. +/// Throttle an update by query operation. +/// +/// +/// Change the number of requests per second for a particular update by query operation. +/// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// public sealed partial class UpdateByQueryRethrottleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs index 95d1920cbb..b3d675da44 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs @@ -41,12 +41,14 @@ internal AsyncSearchNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteAsyncSearchRequest request, CancellationToken cancellationToken = default) { @@ -56,12 +58,14 @@ public virtual Task DeleteAsync(DeleteAsyncSearchRequ /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -71,12 +75,14 @@ public virtual Task DeleteAsync(DeleteAsyn /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -87,12 +93,14 @@ public virtual Task DeleteAsync(Elastic.Cl /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -104,12 +112,14 @@ public virtual Task DeleteAsync(Elastic.Cl /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -119,12 +129,14 @@ public virtual Task DeleteAsync(DeleteAsyncSearchRequ /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -135,12 +147,14 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) { @@ -152,10 +166,13 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast /// /// - /// Retrieves the results of a previously submitted async search request given its identifier. + /// Get async search results. + /// + /// + /// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(GetAsyncSearchRequest request, CancellationToken cancellationToken = default) { @@ -165,10 +182,13 @@ public virtual Task> GetAsync(GetAs /// /// - /// Retrieves the results of a previously submitted async search request given its identifier. + /// Get async search results. + /// + /// + /// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(GetAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -178,10 +198,13 @@ public virtual Task> GetAsync(GetAs /// /// - /// Retrieves the results of a previously submitted async search request given its identifier. + /// Get async search results. + /// + /// + /// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -192,10 +215,13 @@ public virtual Task> GetAsync(Elast /// /// - /// Retrieves the results of a previously submitted async search request given its identifier. + /// Get async search results. + /// + /// + /// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -207,11 +233,13 @@ public virtual Task> GetAsync(Elast /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(AsyncSearchStatusRequest request, CancellationToken cancellationToken = default) { @@ -221,11 +249,13 @@ public virtual Task StatusAsync(AsyncSearchStatusRequ /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(AsyncSearchStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -235,11 +265,13 @@ public virtual Task StatusAsync(AsyncSearc /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -250,11 +282,13 @@ public virtual Task StatusAsync(Elastic.Cl /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -266,11 +300,13 @@ public virtual Task StatusAsync(Elastic.Cl /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(AsyncSearchStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -280,11 +316,13 @@ public virtual Task StatusAsync(AsyncSearchStatusRequ /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -295,11 +333,13 @@ public virtual Task StatusAsync(Elastic.Clients.Elast /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) { @@ -311,13 +351,19 @@ public virtual Task StatusAsync(Elastic.Clients.Elast /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(SubmitAsyncSearchRequest request, CancellationToken cancellationToken = default) { @@ -327,13 +373,19 @@ public virtual Task> SubmitAsync /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(SubmitAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -343,13 +395,19 @@ public virtual Task> SubmitAsync /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) { @@ -360,13 +418,19 @@ public virtual Task> SubmitAsync /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -378,13 +442,19 @@ public virtual Task> SubmitAsync /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(CancellationToken cancellationToken = default) { @@ -395,13 +465,19 @@ public virtual Task> SubmitAsync /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(Action> configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Cluster.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Cluster.g.cs index ac98b37b29..d46bb20418 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Cluster.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Cluster.g.cs @@ -43,7 +43,7 @@ internal ClusterNamespacedClient(ElasticsearchClient client) : base(client) /// /// Provides explanations for shard allocations in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(AllocationExplainRequest request, CancellationToken cancellationToken = default) { @@ -55,7 +55,7 @@ public virtual Task AllocationExplainAsync(Allocation /// /// Provides explanations for shard allocations in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(AllocationExplainRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -67,7 +67,7 @@ public virtual Task AllocationExplainAsync(Allocation /// /// Provides explanations for shard allocations in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(CancellationToken cancellationToken = default) { @@ -80,7 +80,7 @@ public virtual Task AllocationExplainAsync(Cancellati /// /// Provides explanations for shard allocations in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -96,7 +96,7 @@ public virtual Task AllocationExplainAsync(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(DeleteComponentTemplateRequest request, CancellationToken cancellationToken = default) { @@ -110,7 +110,7 @@ public virtual Task DeleteComponentTemplateAsyn /// Deletes component templates. /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(DeleteComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -124,7 +124,7 @@ public virtual Task DeleteComponentTemplateAsyn /// Deletes component templates. /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) { @@ -139,7 +139,7 @@ public virtual Task DeleteComponentTemplateAsyn /// Deletes component templates. /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -154,7 +154,7 @@ public virtual Task DeleteComponentTemplateAsyn /// Check component templates. /// Returns information about whether a particular component template exists. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(ExistsComponentTemplateRequest request, CancellationToken cancellationToken = default) { @@ -167,7 +167,7 @@ public virtual Task ExistsComponentTemplateAsyn /// Check component templates. /// Returns information about whether a particular component template exists. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(ExistsComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -180,7 +180,7 @@ public virtual Task ExistsComponentTemplateAsyn /// Check component templates. /// Returns information about whether a particular component template exists. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, CancellationToken cancellationToken = default) { @@ -194,7 +194,7 @@ public virtual Task ExistsComponentTemplateAsyn /// Check component templates. /// Returns information about whether a particular component template exists. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Names name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -209,7 +209,7 @@ public virtual Task ExistsComponentTemplateAsyn /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(GetComponentTemplateRequest request, CancellationToken cancellationToken = default) { @@ -222,7 +222,7 @@ public virtual Task GetComponentTemplateAsync(GetC /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(GetComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -235,7 +235,7 @@ public virtual Task GetComponentTemplateAsync(GetC /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name? name, CancellationToken cancellationToken = default) { @@ -249,7 +249,7 @@ public virtual Task GetComponentTemplateAsync(Elas /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name? name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -264,7 +264,7 @@ public virtual Task GetComponentTemplateAsync(Elas /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(CancellationToken cancellationToken = default) { @@ -278,7 +278,7 @@ public virtual Task GetComponentTemplateAsync(Canc /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -293,7 +293,7 @@ public virtual Task GetComponentTemplateAsync(Acti /// Returns cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetClusterSettingsRequest request, CancellationToken cancellationToken = default) { @@ -306,7 +306,7 @@ public virtual Task GetSettingsAsync(GetClusterSetti /// Returns cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetClusterSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -319,7 +319,7 @@ public virtual Task GetSettingsAsync(GetClusterSetti /// Returns cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(CancellationToken cancellationToken = default) { @@ -333,7 +333,7 @@ public virtual Task GetSettingsAsync(CancellationTok /// Returns cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -348,7 +348,7 @@ public virtual Task GetSettingsAsync(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequest request, CancellationToken cancellationToken = default) { @@ -361,7 +361,7 @@ public virtual Task HealthAsync(HealthRequest request, Cancellat /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -374,7 +374,7 @@ public virtual Task HealthAsync(HealthRequestDescript /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) { @@ -388,7 +388,7 @@ public virtual Task HealthAsync(Elastic.Clients.Elast /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -403,7 +403,7 @@ public virtual Task HealthAsync(Elastic.Clients.Elast /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(CancellationToken cancellationToken = default) { @@ -417,7 +417,7 @@ public virtual Task HealthAsync(CancellationToken can /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -432,7 +432,7 @@ public virtual Task HealthAsync(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -445,7 +445,7 @@ public virtual Task HealthAsync(HealthRequestDescriptor descript /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) { @@ -459,7 +459,7 @@ public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Se /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -474,7 +474,7 @@ public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Se /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(CancellationToken cancellationToken = default) { @@ -488,7 +488,7 @@ public virtual Task HealthAsync(CancellationToken cancellationTo /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -503,7 +503,7 @@ public virtual Task HealthAsync(Action /// Get cluster info. /// Returns basic information about the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(ClusterInfoRequest request, CancellationToken cancellationToken = default) { @@ -516,7 +516,7 @@ public virtual Task InfoAsync(ClusterInfoRequest request, C /// Get cluster info. /// Returns basic information about the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(ClusterInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -529,7 +529,7 @@ public virtual Task InfoAsync(ClusterInfoRequestDescriptor /// Get cluster info. /// Returns basic information about the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(IReadOnlyCollection target, CancellationToken cancellationToken = default) { @@ -543,7 +543,7 @@ public virtual Task InfoAsync(IReadOnlyCollection - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(IReadOnlyCollection target, Action configureRequest, CancellationToken cancellationToken = default) { @@ -560,7 +560,7 @@ public virtual Task InfoAsync(IReadOnlyCollection - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(PendingTasksRequest request, CancellationToken cancellationToken = default) { @@ -575,7 +575,7 @@ public virtual Task PendingTasksAsync(PendingTasksRequest /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(PendingTasksRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -590,7 +590,7 @@ public virtual Task PendingTasksAsync(PendingTasksRequestD /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(CancellationToken cancellationToken = default) { @@ -606,7 +606,7 @@ public virtual Task PendingTasksAsync(CancellationToken ca /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -639,7 +639,7 @@ public virtual Task PendingTasksAsync(Action/* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(PutComponentTemplateRequest request, CancellationToken cancellationToken = default) { @@ -670,7 +670,7 @@ public virtual Task PutComponentTemplateAsync(PutC /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(PutComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -701,7 +701,7 @@ public virtual Task PutComponentTemplateAsync/* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) { @@ -733,7 +733,7 @@ public virtual Task PutComponentTemplateAsync/* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -766,7 +766,7 @@ public virtual Task PutComponentTemplateAsync/* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(PutComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -797,7 +797,7 @@ public virtual Task PutComponentTemplateAsync(PutC /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, CancellationToken cancellationToken = default) { @@ -829,7 +829,7 @@ public virtual Task PutComponentTemplateAsync(Elas /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -844,7 +844,7 @@ public virtual Task PutComponentTemplateAsync(Elas /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(ClusterStatsRequest request, CancellationToken cancellationToken = default) { @@ -857,7 +857,7 @@ public virtual Task StatsAsync(ClusterStatsRequest request /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(ClusterStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -870,7 +870,7 @@ public virtual Task StatsAsync(ClusterStatsRequestDescript /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, CancellationToken cancellationToken = default) { @@ -884,7 +884,7 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -899,7 +899,7 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) { @@ -913,7 +913,7 @@ public virtual Task StatsAsync(CancellationToken cancellat /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Enrich.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Enrich.g.cs index 374798d47c..72a641f589 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Enrich.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Enrich.g.cs @@ -98,7 +98,7 @@ public virtual Task DeletePolicyAsync(Elastic.Clients.Elas /// /// 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) { @@ -110,7 +110,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(ExecutePolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -122,7 +122,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.Serverless.Name name, CancellationToken cancellationToken = default) { @@ -135,7 +135,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(Elastic.Clients.Elasticsearch.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -234,7 +234,7 @@ public virtual Task GetPolicyAsync(Action - /// 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) { @@ -247,7 +247,7 @@ public virtual Task PutPolicyAsync(PutPolicyRequest request, /// Create an enrich policy. /// Creates an 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) { @@ -260,7 +260,7 @@ public virtual Task PutPolicyAsync(PutPolicyReques /// Create an enrich policy. /// Creates an 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.Serverless.Name name, CancellationToken cancellationToken = default) { @@ -274,7 +274,7 @@ public virtual Task PutPolicyAsync(Elastic.Clients /// Create an enrich policy. /// Creates an 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.Serverless.Name name, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -289,7 +289,7 @@ public virtual Task PutPolicyAsync(Elastic.Clients /// Create an enrich policy. /// Creates an 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) { @@ -302,7 +302,7 @@ public virtual Task PutPolicyAsync(PutPolicyRequestDescriptor /// Create an enrich policy. /// Creates an 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.Serverless.Name name, CancellationToken cancellationToken = default) { @@ -316,7 +316,7 @@ public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsea /// Create an enrich policy. /// Creates an 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.Serverless.Name name, Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Eql.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Eql.g.cs index cf1153ff7c..b1663f4cfa 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Eql.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Eql.g.cs @@ -140,7 +140,7 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch /// /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// - /// 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) { @@ -152,7 +152,7 @@ public virtual Task> GetAsync(EqlGetRequest reque /// /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(EqlGetRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -164,7 +164,7 @@ public virtual Task> GetAsync(EqlGetRequestDescri /// /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -177,7 +177,7 @@ public virtual Task> GetAsync(Elastic.Clients.Ela /// /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// - /// 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.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -191,7 +191,7 @@ public virtual Task> GetAsync(Elastic.Clients.Ela /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// 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) { @@ -203,7 +203,7 @@ public virtual Task GetStatusAsync(GetEqlStatusRequest req /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -215,7 +215,7 @@ public virtual Task GetStatusAsync(GetEqlStatus /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -228,7 +228,7 @@ public virtual Task GetStatusAsync(Elastic.Clie /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -242,7 +242,7 @@ public virtual Task GetStatusAsync(Elastic.Clie /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -254,7 +254,7 @@ public virtual Task GetStatusAsync(GetEqlStatusRequestDesc /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -267,7 +267,7 @@ public virtual Task GetStatusAsync(Elastic.Clients.Elastic /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// 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.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Esql.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Esql.g.cs index e6b8033d87..cab5032dca 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Esql.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Esql.g.cs @@ -43,7 +43,7 @@ internal EsqlNamespacedClient(ElasticsearchClient client) : base(client) /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(EsqlQueryRequest request, CancellationToken cancellationToken = default) { @@ -55,7 +55,7 @@ public virtual Task QueryAsync(EsqlQueryRequest request, Canc /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(EsqlQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -67,7 +67,7 @@ public virtual Task QueryAsync(EsqlQueryRequestDes /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(CancellationToken cancellationToken = default) { @@ -80,7 +80,7 @@ public virtual Task QueryAsync(CancellationToken c /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -94,7 +94,7 @@ public virtual Task QueryAsync(Action /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(EsqlQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -106,7 +106,7 @@ public virtual Task QueryAsync(EsqlQueryRequestDescriptor des /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(CancellationToken cancellationToken = default) { @@ -119,7 +119,7 @@ public virtual Task QueryAsync(CancellationToken cancellation /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Graph.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Graph.g.cs index fd06cd6d38..030d6db889 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Graph.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Graph.g.cs @@ -43,7 +43,7 @@ internal GraphNamespacedClient(ElasticsearchClient client) : base(client) /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequest request, CancellationToken cancellationToken = default) { @@ -55,7 +55,7 @@ public virtual Task ExploreAsync(ExploreRequest request, Cancel /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -67,7 +67,7 @@ public virtual Task ExploreAsync(ExploreRequestDescr /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) { @@ -80,7 +80,7 @@ public virtual Task ExploreAsync(Elastic.Clients.Ela /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -94,7 +94,7 @@ public virtual Task ExploreAsync(Elastic.Clients.Ela /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(CancellationToken cancellationToken = default) { @@ -107,7 +107,7 @@ public virtual Task ExploreAsync(CancellationToken c /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -121,7 +121,7 @@ public virtual Task ExploreAsync(Action /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -133,7 +133,7 @@ public virtual Task ExploreAsync(ExploreRequestDescriptor descr /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) { @@ -146,7 +146,7 @@ public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch. /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Indices.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Indices.g.cs index 7b6acfce7a..093cb132d9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Indices.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Indices.g.cs @@ -41,9 +41,10 @@ internal IndicesNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(AnalyzeIndexRequest request, CancellationToken cancellationToken = default) { @@ -53,9 +54,10 @@ public virtual Task AnalyzeAsync(AnalyzeIndexRequest reque /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(AnalyzeIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -65,9 +67,10 @@ public virtual Task AnalyzeAsync(AnalyzeIndexRe /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, CancellationToken cancellationToken = default) { @@ -78,9 +81,10 @@ public virtual Task AnalyzeAsync(Elastic.Client /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -92,9 +96,10 @@ public virtual Task AnalyzeAsync(Elastic.Client /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(CancellationToken cancellationToken = default) { @@ -105,9 +110,10 @@ public virtual Task AnalyzeAsync(CancellationTo /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -119,9 +125,10 @@ public virtual Task AnalyzeAsync(Action /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(AnalyzeIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -131,9 +138,10 @@ public virtual Task AnalyzeAsync(AnalyzeIndexRequestDescri /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, CancellationToken cancellationToken = default) { @@ -144,9 +152,10 @@ public virtual Task AnalyzeAsync(Elastic.Clients.Elasticse /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, Action configureRequest, CancellationToken cancellationToken = default) { @@ -158,9 +167,10 @@ public virtual Task AnalyzeAsync(Elastic.Clients.Elasticse /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(CancellationToken cancellationToken = default) { @@ -171,9 +181,10 @@ public virtual Task AnalyzeAsync(CancellationToken cancell /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -342,7 +353,7 @@ public virtual Task ClearCacheAsync(Action /// 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) { @@ -354,7 +365,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 Task CloseAsync(CloseIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -366,7 +377,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.Serverless.Indices indices, CancellationToken cancellationToken = default) { @@ -379,7 +390,7 @@ public virtual Task CloseAsync(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 Task CloseAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -393,7 +404,7 @@ public virtual Task CloseAsync(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 Task CloseAsync(CancellationToken cancellationToken = default) { @@ -406,7 +417,7 @@ public virtual Task CloseAsync(CancellationToken /// /// 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(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -420,7 +431,7 @@ public virtual Task CloseAsync(Action /// 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) { @@ -432,7 +443,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.Serverless.Indices indices, CancellationToken cancellationToken = default) { @@ -445,7 +456,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(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -460,7 +471,7 @@ public virtual Task CloseAsync(Elastic.Clients.Elasticsearch /// Create an index. /// Creates a new index. /// - /// 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) { @@ -473,7 +484,7 @@ public virtual Task CreateAsync(CreateIndexRequest request, /// Create an index. /// Creates a new index. /// - /// 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) { @@ -486,7 +497,7 @@ public virtual Task CreateAsync(CreateIndexReque /// Create an index. /// Creates a new index. /// - /// 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.Serverless.IndexName index, CancellationToken cancellationToken = default) { @@ -500,7 +511,7 @@ public virtual Task CreateAsync(Elastic.Clients. /// Create an index. /// Creates a new index. /// - /// 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.Serverless.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -515,7 +526,7 @@ public virtual Task CreateAsync(Elastic.Clients. /// Create an index. /// Creates a new index. /// - /// 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) { @@ -529,7 +540,7 @@ public virtual Task CreateAsync(CancellationToke /// Create an index. /// Creates a new index. /// - /// 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) { @@ -544,7 +555,7 @@ public virtual Task CreateAsync(Action - /// 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) { @@ -557,7 +568,7 @@ public virtual Task CreateAsync(CreateIndexRequestDescripto /// Create an index. /// Creates a new index. /// - /// 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.Serverless.IndexName index, CancellationToken cancellationToken = default) { @@ -571,7 +582,7 @@ public virtual Task CreateAsync(Elastic.Clients.Elasticsear /// Create an index. /// Creates a new index. /// - /// 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.Serverless.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1611,7 +1622,7 @@ public virtual Task ExplainDataLifecycleAsync(Elas /// /// Flushes one or more data streams or 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) { @@ -1623,7 +1634,7 @@ public virtual Task FlushAsync(FlushRequest request, Cancellation /// /// Flushes one or more data streams or 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) { @@ -1635,7 +1646,7 @@ public virtual Task FlushAsync(FlushRequestDescriptor< /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) { @@ -1648,7 +1659,7 @@ public virtual Task FlushAsync(Elastic.Clients.Elastic /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1662,7 +1673,7 @@ public virtual Task FlushAsync(Elastic.Clients.Elastic /// /// Flushes one or more data streams or 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) { @@ -1675,7 +1686,7 @@ public virtual Task FlushAsync(CancellationToken cance /// /// Flushes one or more data streams or 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) { @@ -1689,7 +1700,7 @@ public virtual Task FlushAsync(Action /// Flushes one or more data streams or 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) { @@ -1701,7 +1712,7 @@ public virtual Task FlushAsync(FlushRequestDescriptor descriptor, /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) { @@ -1714,7 +1725,7 @@ public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serv /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1728,7 +1739,7 @@ public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serv /// /// Flushes one or more data streams or 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) { @@ -1741,7 +1752,7 @@ public virtual Task FlushAsync(CancellationToken cancellationToke /// /// Flushes one or more data streams or 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) { @@ -3171,9 +3182,9 @@ public virtual Task PutDataLifecycleAsync(PutDataLifec /// /// Learn more about this API in the Elasticsearch documentation. /// - public virtual Task PutDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name, CancellationToken cancellationToken = default) + public virtual Task PutDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycle lifecycle, Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name, CancellationToken cancellationToken = default) { - var descriptor = new PutDataLifecycleRequestDescriptor(name); + var descriptor = new PutDataLifecycleRequestDescriptor(lifecycle, name); descriptor.BeforeRequest(); return DoRequestAsync(descriptor, cancellationToken); } @@ -3185,9 +3196,9 @@ public virtual Task PutDataLifecycleAsync(Elastic.Clie /// /// Learn more about this API in the Elasticsearch documentation. /// - public virtual Task PutDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name, Action configureRequest, CancellationToken cancellationToken = default) + public virtual Task PutDataLifecycleAsync(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycle lifecycle, Elastic.Clients.Elasticsearch.Serverless.DataStreamNames name, Action configureRequest, CancellationToken cancellationToken = default) { - var descriptor = new PutDataLifecycleRequestDescriptor(name); + var descriptor = new PutDataLifecycleRequestDescriptor(lifecycle, name); configureRequest?.Invoke(descriptor); descriptor.BeforeRequest(); return DoRequestAsync(descriptor, cancellationToken); @@ -3981,7 +3992,7 @@ public virtual Task ResolveIndexAsync(Elastic.Clients.Elas /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequest request, CancellationToken cancellationToken = default) { @@ -3994,7 +4005,7 @@ public virtual Task RolloverAsync(RolloverRequest request, Can /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -4007,7 +4018,7 @@ public virtual Task RolloverAsync(RolloverRequestDe /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, Elastic.Clients.Elasticsearch.Serverless.IndexName? newIndex, CancellationToken cancellationToken = default) { @@ -4021,7 +4032,7 @@ public virtual Task RolloverAsync(Elastic.Clients.E /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, Elastic.Clients.Elasticsearch.Serverless.IndexName? newIndex, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -4036,7 +4047,7 @@ public virtual Task RolloverAsync(Elastic.Clients.E /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, CancellationToken cancellationToken = default) { @@ -4050,7 +4061,7 @@ public virtual Task RolloverAsync(Elastic.Clients.E /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -4065,7 +4076,7 @@ public virtual Task RolloverAsync(Elastic.Clients.E /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -4078,7 +4089,7 @@ public virtual Task RolloverAsync(RolloverRequestDescriptor de /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, Elastic.Clients.Elasticsearch.Serverless.IndexName? newIndex, CancellationToken cancellationToken = default) { @@ -4092,7 +4103,7 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, Elastic.Clients.Elasticsearch.Serverless.IndexName? newIndex, Action configureRequest, CancellationToken cancellationToken = default) { @@ -4107,7 +4118,7 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, CancellationToken cancellationToken = default) { @@ -4121,7 +4132,7 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.Serverless.IndexAlias alias, Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Inference.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Inference.g.cs new file mode 100644 index 0000000000..1ff6bc4c39 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Inference.g.cs @@ -0,0 +1,353 @@ +// 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 System; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; + +namespace Elastic.Clients.Elasticsearch.Serverless.Inference; + +public partial class InferenceNamespacedClient : NamespacedClientProxy +{ + /// + /// + /// Initializes a new instance of the class for mocking. + /// + /// + protected InferenceNamespacedClient() : base() + { + } + + internal InferenceNamespacedClient(ElasticsearchClient client) : base(client) + { + } + + /// + /// + /// Delete an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteAsync(DeleteInferenceRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Delete an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteAsync(DeleteInferenceRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Delete an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId, CancellationToken cancellationToken = default) + { + var descriptor = new DeleteInferenceRequestDescriptor(taskType, inferenceId); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Delete an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new DeleteInferenceRequestDescriptor(taskType, inferenceId); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Delete an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id inferenceId, CancellationToken cancellationToken = default) + { + var descriptor = new DeleteInferenceRequestDescriptor(inferenceId); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Delete an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Serverless.Id inferenceId, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new DeleteInferenceRequestDescriptor(inferenceId); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetAsync(GetInferenceRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Get an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetAsync(GetInferenceRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id? inferenceId, CancellationToken cancellationToken = default) + { + var descriptor = new GetInferenceRequestDescriptor(taskType, inferenceId); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id? inferenceId, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new GetInferenceRequestDescriptor(taskType, inferenceId); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetAsync(CancellationToken cancellationToken = default) + { + var descriptor = new GetInferenceRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetAsync(Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new GetInferenceRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Perform inference on the service + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task InferenceAsync(InferenceRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Perform inference on the service + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task InferenceAsync(InferenceRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Perform inference on the service + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task InferenceAsync(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId, CancellationToken cancellationToken = default) + { + var descriptor = new InferenceRequestDescriptor(taskType, inferenceId); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Perform inference on the service + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task InferenceAsync(Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new InferenceRequestDescriptor(taskType, inferenceId); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Perform inference on the service + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task InferenceAsync(Elastic.Clients.Elasticsearch.Serverless.Id inferenceId, CancellationToken cancellationToken = default) + { + var descriptor = new InferenceRequestDescriptor(inferenceId); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Perform inference on the service + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task InferenceAsync(Elastic.Clients.Elasticsearch.Serverless.Id inferenceId, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new InferenceRequestDescriptor(inferenceId); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutAsync(PutInferenceRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Create an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutAsync(PutInferenceRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutAsync(Elastic.Clients.Elasticsearch.Serverless.Inference.InferenceEndpoint inferenceConfig, Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId, CancellationToken cancellationToken = default) + { + var descriptor = new PutInferenceRequestDescriptor(inferenceConfig, taskType, inferenceId); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutAsync(Elastic.Clients.Elasticsearch.Serverless.Inference.InferenceEndpoint inferenceConfig, Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType? taskType, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new PutInferenceRequestDescriptor(inferenceConfig, taskType, inferenceId); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutAsync(Elastic.Clients.Elasticsearch.Serverless.Inference.InferenceEndpoint inferenceConfig, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId, CancellationToken cancellationToken = default) + { + var descriptor = new PutInferenceRequestDescriptor(inferenceConfig, inferenceId); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create an inference endpoint + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutAsync(Elastic.Clients.Elasticsearch.Serverless.Inference.InferenceEndpoint inferenceConfig, Elastic.Clients.Elasticsearch.Serverless.Id inferenceId, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new PutInferenceRequestDescriptor(inferenceConfig, inferenceId); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ingest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ingest.g.cs index cdd7941b0f..e612028f21 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ingest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ingest.g.cs @@ -223,7 +223,7 @@ public virtual Task DeletePipelineAsync(Elastic.Clients. /// /// Gets download statistics for GeoIP2 databases used with the geoip processor. /// - /// 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) { @@ -235,7 +235,7 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequest reques /// /// Gets download statistics for GeoIP2 databases used with the geoip processor. /// - /// 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) { @@ -247,7 +247,7 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequestDescrip /// /// Gets download statistics for GeoIP2 databases used with the geoip processor. /// - /// 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) { @@ -260,7 +260,7 @@ public virtual Task GeoIpStatsAsync(CancellationToken cancel /// /// Gets download statistics for GeoIP2 databases used with the geoip processor. /// - /// 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) { @@ -575,7 +575,7 @@ public virtual Task GetPipelineAsync(Action - /// 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) { @@ -589,7 +589,7 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(ProcessorGrokRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -603,7 +603,7 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(CancellationToken cancellationToken = default) { @@ -618,7 +618,7 @@ public virtual Task ProcessorGrokAsync(CancellationToken /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -723,7 +723,7 @@ public virtual Task PutGeoipDatabaseAsync(Elastic.Clie /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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) { @@ -736,7 +736,7 @@ public virtual Task PutPipelineAsync(PutPipelineRequest req /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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) { @@ -749,7 +749,7 @@ public virtual Task PutPipelineAsync(PutPipeline /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -763,7 +763,7 @@ public virtual Task PutPipelineAsync(Elastic.Cli /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -778,7 +778,7 @@ public virtual Task PutPipelineAsync(Elastic.Cli /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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) { @@ -791,7 +791,7 @@ public virtual Task PutPipelineAsync(PutPipelineRequestDesc /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -805,7 +805,7 @@ public virtual Task PutPipelineAsync(Elastic.Clients.Elasti /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ml.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ml.g.cs index 6f5f2eb4b0..6761e0e864 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ml.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Ml.g.cs @@ -114,7 +114,7 @@ public virtual Task ClearTrainedModelD /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. /// When a datafeed that has a specified end date stops, it automatically closes its associated job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(CloseJobRequest request, CancellationToken cancellationToken = default) { @@ -130,7 +130,7 @@ public virtual Task CloseJobAsync(CloseJobRequest request, Can /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. /// When a datafeed that has a specified end date stops, it automatically closes its associated job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(CloseJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -146,7 +146,7 @@ public virtual Task CloseJobAsync(CloseJobRequestDescriptor de /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. /// When a datafeed that has a specified end date stops, it automatically closes its associated job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) { @@ -163,7 +163,7 @@ public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearc /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. /// When a datafeed that has a specified end date stops, it automatically closes its associated job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -178,7 +178,7 @@ public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearc /// Delete a calendar. /// Removes all scheduled events from a calendar, then deletes it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(DeleteCalendarRequest request, CancellationToken cancellationToken = default) { @@ -191,7 +191,7 @@ public virtual Task DeleteCalendarAsync(DeleteCalendarRe /// Delete a calendar. /// Removes all scheduled events from a calendar, then deletes it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(DeleteCalendarRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -204,7 +204,7 @@ public virtual Task DeleteCalendarAsync(DeleteCalendarRe /// Delete a calendar. /// Removes all scheduled events from a calendar, then deletes it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, CancellationToken cancellationToken = default) { @@ -218,7 +218,7 @@ public virtual Task DeleteCalendarAsync(Elastic.Clients. /// Delete a calendar. /// Removes all scheduled events from a calendar, then deletes it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -232,7 +232,7 @@ public virtual Task DeleteCalendarAsync(Elastic.Clients. /// /// Delete events from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(DeleteCalendarEventRequest request, CancellationToken cancellationToken = default) { @@ -244,7 +244,7 @@ public virtual Task DeleteCalendarEventAsync(Delete /// /// Delete events from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(DeleteCalendarEventRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -256,7 +256,7 @@ public virtual Task DeleteCalendarEventAsync(Delete /// /// Delete events from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Elastic.Clients.Elasticsearch.Serverless.Id eventId, CancellationToken cancellationToken = default) { @@ -269,7 +269,7 @@ public virtual Task DeleteCalendarEventAsync(Elasti /// /// Delete events from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Elastic.Clients.Elasticsearch.Serverless.Id eventId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -283,7 +283,7 @@ public virtual Task DeleteCalendarEventAsync(Elasti /// /// Delete anomaly jobs from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(DeleteCalendarJobRequest request, CancellationToken cancellationToken = default) { @@ -295,7 +295,7 @@ public virtual Task DeleteCalendarJobAsync(DeleteCale /// /// Delete anomaly jobs from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(DeleteCalendarJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -307,7 +307,7 @@ public virtual Task DeleteCalendarJobAsync(DeleteCale /// /// Delete anomaly jobs from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Elastic.Clients.Elasticsearch.Serverless.Ids jobId, CancellationToken cancellationToken = default) { @@ -320,7 +320,7 @@ public virtual Task DeleteCalendarJobAsync(Elastic.Cl /// /// Delete anomaly jobs from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id calendarId, Elastic.Clients.Elasticsearch.Serverless.Ids jobId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -334,7 +334,7 @@ public virtual Task DeleteCalendarJobAsync(Elastic.Cl /// /// Delete a datafeed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(DeleteDatafeedRequest request, CancellationToken cancellationToken = default) { @@ -346,7 +346,7 @@ public virtual Task DeleteDatafeedAsync(DeleteDatafeedRe /// /// Delete a datafeed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(DeleteDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -358,7 +358,7 @@ public virtual Task DeleteDatafeedAsync(DeleteDatafeedRe /// /// Delete a datafeed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, CancellationToken cancellationToken = default) { @@ -371,7 +371,7 @@ public virtual Task DeleteDatafeedAsync(Elastic.Clients. /// /// Delete a datafeed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(Elastic.Clients.Elasticsearch.Serverless.Id datafeedId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -385,7 +385,7 @@ public virtual Task DeleteDatafeedAsync(Elastic.Clients. /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) { @@ -397,7 +397,7 @@ public virtual Task DeleteDataFrameAnalyticsAs /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -409,7 +409,7 @@ public virtual Task DeleteDataFrameAnalyticsAs /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -422,7 +422,7 @@ public virtual Task DeleteDataFrameAnalyticsAs /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -436,7 +436,7 @@ public virtual Task DeleteDataFrameAnalyticsAs /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -448,7 +448,7 @@ public virtual Task DeleteDataFrameAnalyticsAs /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -461,7 +461,7 @@ public virtual Task DeleteDataFrameAnalyticsAs /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) { @@ -4303,7 +4303,12 @@ public virtual Task PutCalendarJobAsync(Elastic.Clients. /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4319,7 +4324,12 @@ public virtual Task PutDatafeedAsync(PutDatafeedRequest req /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4335,7 +4345,12 @@ public virtual Task PutDatafeedAsync(PutDatafeed /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4352,7 +4367,12 @@ public virtual Task PutDatafeedAsync(Elastic.Cli /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4370,7 +4390,12 @@ public virtual Task PutDatafeedAsync(Elastic.Cli /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4386,7 +4411,12 @@ public virtual Task PutDatafeedAsync(PutDatafeedRequestDesc /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4403,7 +4433,12 @@ public virtual Task PutDatafeedAsync(Elastic.Clients.Elasti /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4421,7 +4456,7 @@ public virtual Task PutDatafeedAsync(Elastic.Clients.Elasti /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) { @@ -4435,7 +4470,7 @@ public virtual Task PutDataFrameAnalyticsAsync(Pu /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -4449,7 +4484,7 @@ public virtual Task PutDataFrameAnalyticsAsync - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -4464,7 +4499,7 @@ public virtual Task PutDataFrameAnalyticsAsync - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -4480,7 +4515,7 @@ public virtual Task PutDataFrameAnalyticsAsync - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -4494,7 +4529,7 @@ public virtual Task PutDataFrameAnalyticsAsync(Pu /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) { @@ -4509,7 +4544,7 @@ public virtual Task PutDataFrameAnalyticsAsync(El /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Nodes.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Nodes.g.cs index 545ba98ec1..a9882fe207 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Nodes.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Nodes.g.cs @@ -44,7 +44,7 @@ internal NodesNamespacedClient(ElasticsearchClient client) : base(client) /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(HotThreadsRequest request, CancellationToken cancellationToken = default) { @@ -57,7 +57,7 @@ public virtual Task HotThreadsAsync(HotThreadsRequest reques /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(HotThreadsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -70,7 +70,7 @@ public virtual Task HotThreadsAsync(HotThreadsRequestDescrip /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, CancellationToken cancellationToken = default) { @@ -84,7 +84,7 @@ public virtual Task HotThreadsAsync(Elastic.Clients.Elastics /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -99,7 +99,7 @@ public virtual Task HotThreadsAsync(Elastic.Clients.Elastics /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(CancellationToken cancellationToken = default) { @@ -113,7 +113,7 @@ public virtual Task HotThreadsAsync(CancellationToken cancel /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -127,7 +127,7 @@ public virtual Task HotThreadsAsync(Action /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(NodesInfoRequest request, CancellationToken cancellationToken = default) { @@ -139,7 +139,7 @@ public virtual Task InfoAsync(NodesInfoRequest request, Cance /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(NodesInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -151,7 +151,7 @@ public virtual Task InfoAsync(NodesInfoRequestDescriptor desc /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, CancellationToken cancellationToken = default) { @@ -164,7 +164,7 @@ public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.S /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Action configureRequest, CancellationToken cancellationToken = default) { @@ -178,7 +178,7 @@ public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.S /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(CancellationToken cancellationToken = default) { @@ -191,7 +191,7 @@ public virtual Task InfoAsync(CancellationToken cancellationT /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -205,7 +205,7 @@ public virtual Task InfoAsync(Action /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(NodesStatsRequest request, CancellationToken cancellationToken = default) { @@ -217,7 +217,7 @@ public virtual Task StatsAsync(NodesStatsRequest request, Ca /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(NodesStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -229,7 +229,7 @@ public virtual Task StatsAsync(NodesStatsRequestD /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Elastic.Clients.Elasticsearch.Serverless.Metrics? indexMetric, CancellationToken cancellationToken = default) { @@ -242,7 +242,7 @@ public virtual Task StatsAsync(Elastic.Clients.El /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Elastic.Clients.Elasticsearch.Serverless.Metrics? indexMetric, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -256,7 +256,7 @@ public virtual Task StatsAsync(Elastic.Clients.El /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) { @@ -269,7 +269,7 @@ public virtual Task StatsAsync(CancellationToken /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -283,7 +283,7 @@ public virtual Task StatsAsync(Action /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(NodesStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -295,7 +295,7 @@ public virtual Task StatsAsync(NodesStatsRequestDescriptor d /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Elastic.Clients.Elasticsearch.Serverless.Metrics? indexMetric, CancellationToken cancellationToken = default) { @@ -308,7 +308,7 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsearch /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Elastic.Clients.Elasticsearch.Serverless.Metrics? indexMetric, Action configureRequest, CancellationToken cancellationToken = default) { @@ -322,7 +322,7 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsearch /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) { @@ -335,7 +335,7 @@ public virtual Task StatsAsync(CancellationToken cancellatio /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -349,7 +349,7 @@ public virtual Task StatsAsync(Action /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(NodesUsageRequest request, CancellationToken cancellationToken = default) { @@ -361,7 +361,7 @@ public virtual Task UsageAsync(NodesUsageRequest request, Ca /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(NodesUsageRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -373,7 +373,7 @@ public virtual Task UsageAsync(NodesUsageRequestDescriptor d /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, CancellationToken cancellationToken = default) { @@ -386,7 +386,7 @@ public virtual Task UsageAsync(Elastic.Clients.Elasticsearch /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Serverless.Metrics? metric, Action configureRequest, CancellationToken cancellationToken = default) { @@ -400,7 +400,7 @@ public virtual Task UsageAsync(Elastic.Clients.Elasticsearch /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(CancellationToken cancellationToken = default) { @@ -413,7 +413,7 @@ public virtual Task UsageAsync(CancellationToken cancellatio /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.QueryRules.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.QueryRules.g.cs index 9adeb57e85..7924d7d16d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.QueryRules.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.QueryRules.g.cs @@ -395,4 +395,55 @@ public virtual Task PutRulesetAsync(Elastic.Clients.Elastics descriptor.BeforeRequest(); return DoRequestAsync(descriptor, cancellationToken); } + + /// + /// + /// Creates or updates a query ruleset. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task TestAsync(TestRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Creates or updates a query ruleset. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task TestAsync(TestRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Creates or updates a query ruleset. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task TestAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, CancellationToken cancellationToken = default) + { + var descriptor = new TestRequestDescriptor(rulesetId); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Creates or updates a query ruleset. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task TestAsync(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new TestRequestDescriptor(rulesetId); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Security.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Security.g.cs index 67e3c6f621..3b630a6b91 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Security.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Security.g.cs @@ -41,7 +41,10 @@ internal SecurityNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Creates or updates a user profile on behalf of another user. + /// Activate a user profile. + /// + /// + /// Create or update a user profile on behalf of another user. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -53,7 +56,10 @@ public virtual Task ActivateUserProfileAsync(Activa /// /// - /// Creates or updates a user profile on behalf of another user. + /// Activate a user profile. + /// + /// + /// Create or update a user profile on behalf of another user. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -65,7 +71,10 @@ public virtual Task ActivateUserProfileAsync(Activa /// /// - /// Creates or updates a user profile on behalf of another user. + /// Activate a user profile. + /// + /// + /// Create or update a user profile on behalf of another user. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -78,7 +87,10 @@ public virtual Task ActivateUserProfileAsync(Cancel /// /// - /// Creates or updates a user profile on behalf of another user. + /// Activate a user profile. + /// + /// + /// Create or update a user profile on behalf of another user. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,6 +105,8 @@ public virtual Task ActivateUserProfileAsync(Action /// /// /// Authenticate a user. + /// + /// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -109,6 +123,8 @@ public virtual Task AuthenticateAsync(AuthenticateRequest /// /// /// Authenticate a user. + /// + /// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -125,6 +141,8 @@ public virtual Task AuthenticateAsync(AuthenticateRequestD /// /// /// Authenticate a user. + /// + /// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -142,6 +160,8 @@ public virtual Task AuthenticateAsync(CancellationToken ca /// /// /// Authenticate a user. + /// + /// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -159,6 +179,9 @@ public virtual Task AuthenticateAsync(Action /// + /// Bulk delete roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -172,6 +195,9 @@ public virtual Task BulkDeleteRoleAsync(BulkDeleteRoleRe /// /// + /// Bulk delete roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -185,6 +211,9 @@ public virtual Task BulkDeleteRoleAsync(BulkDeleteRoleRe /// /// + /// Bulk delete roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -199,6 +228,9 @@ public virtual Task BulkDeleteRoleAsync(CancellationToke /// /// + /// Bulk delete roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -214,6 +246,9 @@ public virtual Task BulkDeleteRoleAsync(Action /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -227,6 +262,9 @@ public virtual Task BulkPutRoleAsync(BulkPutRoleRequest req /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -240,6 +278,9 @@ public virtual Task BulkPutRoleAsync(BulkPutRole /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -254,6 +295,9 @@ public virtual Task BulkPutRoleAsync(Cancellatio /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -269,6 +313,9 @@ public virtual Task BulkPutRoleAsync(Action /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -282,6 +329,9 @@ public virtual Task BulkPutRoleAsync(BulkPutRoleRequestDesc /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -296,6 +346,9 @@ public virtual Task BulkPutRoleAsync(CancellationToken canc /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -311,7 +364,10 @@ public virtual Task BulkPutRoleAsync(Action /// - /// Evicts a subset of all entries from the API key cache. + /// Clear the API key cache. + /// + /// + /// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// Learn more about this API in the Elasticsearch documentation. @@ -324,7 +380,10 @@ public virtual Task ClearApiKeyCacheAsync(ClearApiKeyC /// /// - /// Evicts a subset of all entries from the API key cache. + /// Clear the API key cache. + /// + /// + /// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// Learn more about this API in the Elasticsearch documentation. @@ -337,7 +396,10 @@ public virtual Task ClearApiKeyCacheAsync(ClearApiKeyC /// /// - /// Evicts a subset of all entries from the API key cache. + /// Clear the API key cache. + /// + /// + /// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// Learn more about this API in the Elasticsearch documentation. @@ -351,7 +413,10 @@ public virtual Task ClearApiKeyCacheAsync(Elastic.Clie /// /// - /// Evicts a subset of all entries from the API key cache. + /// Clear the API key cache. + /// + /// + /// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// Learn more about this API in the Elasticsearch documentation. @@ -366,7 +431,11 @@ public virtual Task ClearApiKeyCacheAsync(Elastic.Clie /// /// - /// Evicts application privileges from the native application privileges cache. + /// Clear the privileges cache. + /// + /// + /// Evict privileges from the native application privilege cache. + /// The cache is also automatically cleared for applications that have their privileges updated. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -378,7 +447,11 @@ public virtual Task ClearCachedPrivilegesAsync(Cl /// /// - /// Evicts application privileges from the native application privileges cache. + /// Clear the privileges cache. + /// + /// + /// Evict privileges from the native application privilege cache. + /// The cache is also automatically cleared for applications that have their privileges updated. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -390,7 +463,11 @@ public virtual Task ClearCachedPrivilegesAsync(Cl /// /// - /// Evicts application privileges from the native application privileges cache. + /// Clear the privileges cache. + /// + /// + /// Evict privileges from the native application privilege cache. + /// The cache is also automatically cleared for applications that have their privileges updated. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -403,7 +480,11 @@ public virtual Task ClearCachedPrivilegesAsync(El /// /// - /// Evicts application privileges from the native application privileges cache. + /// Clear the privileges cache. + /// + /// + /// Evict privileges from the native application privilege cache. + /// The cache is also automatically cleared for applications that have their privileges updated. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -417,7 +498,10 @@ public virtual Task ClearCachedPrivilegesAsync(El /// /// - /// Evicts users from the user cache. Can completely clear the cache or evict specific users. + /// Clear the user cache. + /// + /// + /// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -429,7 +513,10 @@ public virtual Task ClearCachedRealmsAsync(ClearCache /// /// - /// Evicts users from the user cache. Can completely clear the cache or evict specific users. + /// Clear the user cache. + /// + /// + /// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -441,7 +528,10 @@ public virtual Task ClearCachedRealmsAsync(ClearCache /// /// - /// Evicts users from the user cache. Can completely clear the cache or evict specific users. + /// Clear the user cache. + /// + /// + /// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -454,7 +544,10 @@ public virtual Task ClearCachedRealmsAsync(Elastic.Cl /// /// - /// Evicts users from the user cache. Can completely clear the cache or evict specific users. + /// Clear the user cache. + /// + /// + /// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -468,7 +561,10 @@ public virtual Task ClearCachedRealmsAsync(Elastic.Cl /// /// - /// Evicts roles from the native role cache. + /// Clear the roles cache. + /// + /// + /// Evict roles from the native role cache. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -480,7 +576,10 @@ public virtual Task ClearCachedRolesAsync(ClearCachedR /// /// - /// Evicts roles from the native role cache. + /// Clear the roles cache. + /// + /// + /// Evict roles from the native role cache. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -492,7 +591,10 @@ public virtual Task ClearCachedRolesAsync(ClearCachedR /// /// - /// Evicts roles from the native role cache. + /// Clear the roles cache. + /// + /// + /// Evict roles from the native role cache. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -505,7 +607,10 @@ public virtual Task ClearCachedRolesAsync(Elastic.Clie /// /// - /// Evicts roles from the native role cache. + /// Clear the roles cache. + /// + /// + /// Evict roles from the native role cache. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -519,7 +624,10 @@ public virtual Task ClearCachedRolesAsync(Elastic.Clie /// /// - /// Evicts tokens from the service account token caches. + /// Clear service account token caches. + /// + /// + /// Evict a subset of all entries from the service account token caches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -531,7 +639,10 @@ public virtual Task ClearCachedServiceTokensAs /// /// - /// Evicts tokens from the service account token caches. + /// Clear service account token caches. + /// + /// + /// Evict a subset of all entries from the service account token caches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -543,7 +654,10 @@ public virtual Task ClearCachedServiceTokensAs /// /// - /// Evicts tokens from the service account token caches. + /// Clear service account token caches. + /// + /// + /// Evict a subset of all entries from the service account token caches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -556,7 +670,10 @@ public virtual Task ClearCachedServiceTokensAs /// /// - /// Evicts tokens from the service account token caches. + /// Clear service account token caches. + /// + /// + /// Evict a subset of all entries from the service account token caches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -571,7 +688,9 @@ public virtual Task ClearCachedServiceTokensAs /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -587,7 +706,9 @@ public virtual Task CreateApiKeyAsync(CreateApiKeyRequest /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -603,7 +724,9 @@ public virtual Task CreateApiKeyAsync(CreateApi /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -620,7 +743,9 @@ public virtual Task CreateApiKeyAsync(Cancellat /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -638,7 +763,9 @@ public virtual Task CreateApiKeyAsync(Action /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -654,7 +781,9 @@ public virtual Task CreateApiKeyAsync(CreateApiKeyRequestD /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -671,7 +800,9 @@ public virtual Task CreateApiKeyAsync(CancellationToken ca /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -688,7 +819,10 @@ public virtual Task CreateApiKeyAsync(Action /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -700,7 +834,10 @@ public virtual Task CreateServiceTokenAsync(CreateSe /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -712,7 +849,10 @@ public virtual Task CreateServiceTokenAsync(CreateSe /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -725,7 +865,10 @@ public virtual Task CreateServiceTokenAsync(string n /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -739,7 +882,10 @@ public virtual Task CreateServiceTokenAsync(string n /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -752,7 +898,10 @@ public virtual Task CreateServiceTokenAsync(string n /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -766,7 +915,7 @@ public virtual Task CreateServiceTokenAsync(string n /// /// - /// Removes application privileges. + /// Delete application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -778,7 +927,7 @@ public virtual Task DeletePrivilegesAsync(DeletePrivil /// /// - /// Removes application privileges. + /// Delete application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -790,7 +939,7 @@ public virtual Task DeletePrivilegesAsync(DeletePrivil /// /// - /// Removes application privileges. + /// Delete application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -803,7 +952,7 @@ public virtual Task DeletePrivilegesAsync(Elastic.Clie /// /// - /// Removes application privileges. + /// Delete application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -817,7 +966,10 @@ public virtual Task DeletePrivilegesAsync(Elastic.Clie /// /// - /// Removes roles in the native realm. + /// Delete roles. + /// + /// + /// Delete roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -829,7 +981,10 @@ public virtual Task DeleteRoleAsync(DeleteRoleRequest reques /// /// - /// Removes roles in the native realm. + /// Delete roles. + /// + /// + /// Delete roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -841,7 +996,10 @@ public virtual Task DeleteRoleAsync(DeleteRoleRequestDescrip /// /// - /// Removes roles in the native realm. + /// Delete roles. + /// + /// + /// Delete roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -854,7 +1012,10 @@ public virtual Task DeleteRoleAsync(Elastic.Clients.Elastics /// /// - /// Removes roles in the native realm. + /// Delete roles. + /// + /// + /// Delete roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -868,7 +1029,7 @@ public virtual Task DeleteRoleAsync(Elastic.Clients.Elastics /// /// - /// Removes role mappings. + /// Delete role mappings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -880,7 +1041,7 @@ public virtual Task DeleteRoleMappingAsync(DeleteRole /// /// - /// Removes role mappings. + /// Delete role mappings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -892,7 +1053,7 @@ public virtual Task DeleteRoleMappingAsync(DeleteRole /// /// - /// Removes role mappings. + /// Delete role mappings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -905,7 +1066,7 @@ public virtual Task DeleteRoleMappingAsync(Elastic.Cl /// /// - /// Removes role mappings. + /// Delete role mappings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -919,7 +1080,10 @@ public virtual Task DeleteRoleMappingAsync(Elastic.Cl /// /// - /// Deletes a service account token. + /// Delete service account tokens. + /// + /// + /// Delete service account tokens for a service in a specified namespace. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -931,7 +1095,10 @@ public virtual Task DeleteServiceTokenAsync(DeleteSe /// /// - /// Deletes a service account token. + /// Delete service account tokens. + /// + /// + /// Delete service account tokens for a service in a specified namespace. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -943,7 +1110,10 @@ public virtual Task DeleteServiceTokenAsync(DeleteSe /// /// - /// Deletes a service account token. + /// Delete service account tokens. + /// + /// + /// Delete service account tokens for a service in a specified namespace. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -956,7 +1126,10 @@ public virtual Task DeleteServiceTokenAsync(string n /// /// - /// Deletes a service account token. + /// Delete service account tokens. + /// + /// + /// Delete service account tokens for a service in a specified namespace. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -970,7 +1143,10 @@ public virtual Task DeleteServiceTokenAsync(string n /// /// - /// Disables a user profile so it's not visible in user profile searches. + /// Disable a user profile. + /// + /// + /// Disable user profiles so that they are not visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -982,7 +1158,10 @@ public virtual Task DisableUserProfileAsync(DisableU /// /// - /// Disables a user profile so it's not visible in user profile searches. + /// Disable a user profile. + /// + /// + /// Disable user profiles so that they are not visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -994,7 +1173,10 @@ public virtual Task DisableUserProfileAsync(DisableU /// /// - /// Disables a user profile so it's not visible in user profile searches. + /// Disable a user profile. + /// + /// + /// Disable user profiles so that they are not visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1007,7 +1189,10 @@ public virtual Task DisableUserProfileAsync(string u /// /// - /// Disables a user profile so it's not visible in user profile searches. + /// Disable a user profile. + /// + /// + /// Disable user profiles so that they are not visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1021,7 +1206,10 @@ public virtual Task DisableUserProfileAsync(string u /// /// - /// Enables a user profile so it's visible in user profile searches. + /// Enable a user profile. + /// + /// + /// Enable user profiles to make them visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1033,7 +1221,10 @@ public virtual Task EnableUserProfileAsync(EnableUser /// /// - /// Enables a user profile so it's visible in user profile searches. + /// Enable a user profile. + /// + /// + /// Enable user profiles to make them visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1045,7 +1236,10 @@ public virtual Task EnableUserProfileAsync(EnableUser /// /// - /// Enables a user profile so it's visible in user profile searches. + /// Enable a user profile. + /// + /// + /// Enable user profiles to make them visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1058,7 +1252,10 @@ public virtual Task EnableUserProfileAsync(string uid /// /// - /// Enables a user profile so it's visible in user profile searches. + /// Enable a user profile. + /// + /// + /// Enable user profiles to make them visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1073,6 +1270,8 @@ public virtual Task EnableUserProfileAsync(string uid /// /// /// Get API key information. + /// + /// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -1088,6 +1287,8 @@ public virtual Task GetApiKeyAsync(GetApiKeyRequest request, /// /// /// Get API key information. + /// + /// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -1103,6 +1304,8 @@ public virtual Task GetApiKeyAsync(GetApiKeyRequestDescriptor /// /// /// Get API key information. + /// + /// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -1119,6 +1322,8 @@ public virtual Task GetApiKeyAsync(CancellationToken cancella /// /// /// Get API key information. + /// + /// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -1135,7 +1340,10 @@ public virtual Task GetApiKeyAsync(Action /// - /// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + /// Get builtin privileges. + /// + /// + /// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1147,7 +1355,10 @@ public virtual Task GetBuiltinPrivilegesAsync(GetB /// /// - /// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + /// Get builtin privileges. + /// + /// + /// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1159,7 +1370,10 @@ public virtual Task GetBuiltinPrivilegesAsync(GetB /// /// - /// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + /// Get builtin privileges. + /// + /// + /// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1172,7 +1386,10 @@ public virtual Task GetBuiltinPrivilegesAsync(Canc /// /// - /// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + /// Get builtin privileges. + /// + /// + /// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1186,7 +1403,7 @@ public virtual Task GetBuiltinPrivilegesAsync(Acti /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1198,7 +1415,7 @@ public virtual Task GetPrivilegesAsync(GetPrivilegesReque /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1210,7 +1427,7 @@ public virtual Task GetPrivilegesAsync(GetPrivilegesReque /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1223,7 +1440,7 @@ public virtual Task GetPrivilegesAsync(Elastic.Clients.El /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1237,7 +1454,7 @@ public virtual Task GetPrivilegesAsync(Elastic.Clients.El /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1250,7 +1467,7 @@ public virtual Task GetPrivilegesAsync(CancellationToken /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1264,8 +1481,10 @@ public virtual Task GetPrivilegesAsync(Action /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1277,8 +1496,10 @@ public virtual Task GetRoleAsync(GetRoleRequest request, Cancel /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1290,8 +1511,10 @@ public virtual Task GetRoleAsync(GetRoleRequestDescriptor descr /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1304,8 +1527,10 @@ public virtual Task GetRoleAsync(Elastic.Clients.Elasticsearch. /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1319,8 +1544,10 @@ public virtual Task GetRoleAsync(Elastic.Clients.Elasticsearch. /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1333,8 +1560,10 @@ public virtual Task GetRoleAsync(CancellationToken cancellation /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1348,7 +1577,12 @@ public virtual Task GetRoleAsync(Action /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1360,7 +1594,12 @@ public virtual Task GetRoleMappingAsync(GetRoleMappingRe /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1372,7 +1611,12 @@ public virtual Task GetRoleMappingAsync(GetRoleMappingRe /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1385,7 +1629,12 @@ public virtual Task GetRoleMappingAsync(Elastic.Clients. /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1399,7 +1648,12 @@ public virtual Task GetRoleMappingAsync(Elastic.Clients. /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1412,7 +1666,12 @@ public virtual Task GetRoleMappingAsync(CancellationToke /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1426,7 +1685,10 @@ public virtual Task GetRoleMappingAsync(Action /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1438,7 +1700,10 @@ public virtual Task GetServiceAccountsAsync(GetServi /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1450,7 +1715,10 @@ public virtual Task GetServiceAccountsAsync(GetServi /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1463,7 +1731,10 @@ public virtual Task GetServiceAccountsAsync(string? /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1477,7 +1748,10 @@ public virtual Task GetServiceAccountsAsync(string? /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1490,7 +1764,10 @@ public virtual Task GetServiceAccountsAsync(Cancella /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1504,7 +1781,7 @@ public virtual Task GetServiceAccountsAsync(Action /// - /// Retrieves information of all service credentials for a service account. + /// Get service account credentials. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1516,7 +1793,7 @@ public virtual Task GetServiceCredentialsAsync(Ge /// /// - /// Retrieves information of all service credentials for a service account. + /// Get service account credentials. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1528,7 +1805,7 @@ public virtual Task GetServiceCredentialsAsync(Ge /// /// - /// Retrieves information of all service credentials for a service account. + /// Get service account credentials. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1541,7 +1818,7 @@ public virtual Task GetServiceCredentialsAsync(st /// /// - /// Retrieves information of all service credentials for a service account. + /// Get service account credentials. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1555,7 +1832,10 @@ public virtual Task GetServiceCredentialsAsync(st /// /// - /// Creates a bearer token for access without requiring basic authentication. + /// Get a token. + /// + /// + /// Create a bearer token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1567,7 +1847,10 @@ public virtual Task GetTokenAsync(GetTokenRequest request, Can /// /// - /// Creates a bearer token for access without requiring basic authentication. + /// Get a token. + /// + /// + /// Create a bearer token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1579,7 +1862,10 @@ public virtual Task GetTokenAsync(GetTokenRequestDescriptor de /// /// - /// Creates a bearer token for access without requiring basic authentication. + /// Get a token. + /// + /// + /// Create a bearer token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1592,7 +1878,10 @@ public virtual Task GetTokenAsync(CancellationToken cancellati /// /// - /// Creates a bearer token for access without requiring basic authentication. + /// Get a token. + /// + /// + /// Create a bearer token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1606,7 +1895,7 @@ public virtual Task GetTokenAsync(Action /// - /// Retrieves security privileges for the logged in user. + /// Get user privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1618,7 +1907,7 @@ public virtual Task GetUserPrivilegesAsync(GetUserPri /// /// - /// Retrieves security privileges for the logged in user. + /// Get user privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1630,7 +1919,7 @@ public virtual Task GetUserPrivilegesAsync(GetUserPri /// /// - /// Retrieves security privileges for the logged in user. + /// Get user privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1643,7 +1932,7 @@ public virtual Task GetUserPrivilegesAsync(Cancellati /// /// - /// Retrieves security privileges for the logged in user. + /// Get user privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1657,7 +1946,10 @@ public virtual Task GetUserPrivilegesAsync(Action /// - /// Retrieves a user's profile using the unique profile ID. + /// Get a user profile. + /// + /// + /// Get a user's profile using the unique profile ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1669,7 +1961,10 @@ public virtual Task GetUserProfileAsync(GetUserProfileRe /// /// - /// Retrieves a user's profile using the unique profile ID. + /// Get a user profile. + /// + /// + /// Get a user's profile using the unique profile ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1681,7 +1976,10 @@ public virtual Task GetUserProfileAsync(GetUserProfileRe /// /// - /// Retrieves a user's profile using the unique profile ID. + /// Get a user profile. + /// + /// + /// Get a user's profile using the unique profile ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1694,7 +1992,10 @@ public virtual Task GetUserProfileAsync(IReadOnlyCollect /// /// - /// Retrieves a user's profile using the unique profile ID. + /// Get a user profile. + /// + /// + /// Get a user's profile using the unique profile ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1708,8 +2009,11 @@ public virtual Task GetUserProfileAsync(IReadOnlyCollect /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -1735,8 +2039,11 @@ public virtual Task GrantApiKeyAsync(GrantApiKeyRequest req /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -1762,8 +2069,11 @@ public virtual Task GrantApiKeyAsync(GrantApiKey /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -1790,8 +2100,11 @@ public virtual Task GrantApiKeyAsync(Cancellatio /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -1819,8 +2132,11 @@ public virtual Task GrantApiKeyAsync(Action /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -1846,8 +2162,11 @@ public virtual Task GrantApiKeyAsync(GrantApiKeyRequestDesc /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -1874,8 +2193,11 @@ public virtual Task GrantApiKeyAsync(CancellationToken canc /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -1904,7 +2226,9 @@ public virtual Task GrantApiKeyAsync(Action /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1917,7 +2241,9 @@ public virtual Task HasPrivilegesAsync(HasPrivilegesReque /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1930,7 +2256,9 @@ public virtual Task HasPrivilegesAsync(HasPrivilegesReque /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1944,7 +2272,9 @@ public virtual Task HasPrivilegesAsync(Elastic.Clients.El /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1959,7 +2289,9 @@ public virtual Task HasPrivilegesAsync(Elastic.Clients.El /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1973,7 +2305,9 @@ public virtual Task HasPrivilegesAsync(CancellationToken /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1987,7 +2321,10 @@ public virtual Task HasPrivilegesAsync(Action /// - /// Determines whether the users associated with the specified profile IDs have all the requested privileges. + /// Check user profile privileges. + /// + /// + /// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1999,7 +2336,10 @@ public virtual Task HasPrivilegesUserProfileAs /// /// - /// Determines whether the users associated with the specified profile IDs have all the requested privileges. + /// Check user profile privileges. + /// + /// + /// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2011,7 +2351,10 @@ public virtual Task HasPrivilegesUserProfileAs /// /// - /// Determines whether the users associated with the specified profile IDs have all the requested privileges. + /// Check user profile privileges. + /// + /// + /// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2024,7 +2367,10 @@ public virtual Task HasPrivilegesUserProfileAs /// /// - /// Determines whether the users associated with the specified profile IDs have all the requested privileges. + /// Check user profile privileges. + /// + /// + /// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2039,7 +2385,10 @@ public virtual Task HasPrivilegesUserProfileAs /// /// /// Invalidate API keys. - /// Invalidates one or more API keys. + /// + /// + /// This API invalidates API keys created by the create API key or grant API key APIs. + /// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -2057,7 +2406,7 @@ public virtual Task HasPrivilegesUserProfileAs /// /// /// - /// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. + /// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -2072,7 +2421,10 @@ public virtual Task InvalidateApiKeyAsync(InvalidateAp /// /// /// Invalidate API keys. - /// Invalidates one or more API keys. + /// + /// + /// This API invalidates API keys created by the create API key or grant API key APIs. + /// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -2090,7 +2442,7 @@ public virtual Task InvalidateApiKeyAsync(InvalidateAp /// /// /// - /// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. + /// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -2105,7 +2457,10 @@ public virtual Task InvalidateApiKeyAsync(InvalidateAp /// /// /// Invalidate API keys. - /// Invalidates one or more API keys. + /// + /// + /// This API invalidates API keys created by the create API key or grant API key APIs. + /// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -2123,7 +2478,7 @@ public virtual Task InvalidateApiKeyAsync(InvalidateAp /// /// /// - /// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. + /// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -2139,7 +2494,10 @@ public virtual Task InvalidateApiKeyAsync(Cancellation /// /// /// Invalidate API keys. - /// Invalidates one or more API keys. + /// + /// + /// This API invalidates API keys created by the create API key or grant API key APIs. + /// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -2157,7 +2515,7 @@ public virtual Task InvalidateApiKeyAsync(Cancellation /// /// /// - /// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. + /// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -2173,7 +2531,16 @@ public virtual Task InvalidateApiKeyAsync(Action /// - /// Invalidates one or more access tokens or refresh tokens. + /// Invalidate a token. + /// + /// + /// The access tokens returned by the get token API have a finite period of time for which they are valid. + /// After that time period, they can no longer be used. + /// The time period is defined by the xpack.security.authc.token.timeout setting. + /// + /// + /// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. + /// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2185,7 +2552,16 @@ public virtual Task InvalidateTokenAsync(InvalidateToke /// /// - /// Invalidates one or more access tokens or refresh tokens. + /// Invalidate a token. + /// + /// + /// The access tokens returned by the get token API have a finite period of time for which they are valid. + /// After that time period, they can no longer be used. + /// The time period is defined by the xpack.security.authc.token.timeout setting. + /// + /// + /// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. + /// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2197,7 +2573,16 @@ public virtual Task InvalidateTokenAsync(InvalidateToke /// /// - /// Invalidates one or more access tokens or refresh tokens. + /// Invalidate a token. + /// + /// + /// The access tokens returned by the get token API have a finite period of time for which they are valid. + /// After that time period, they can no longer be used. + /// The time period is defined by the xpack.security.authc.token.timeout setting. + /// + /// + /// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. + /// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2210,7 +2595,16 @@ public virtual Task InvalidateTokenAsync(CancellationTo /// /// - /// Invalidates one or more access tokens or refresh tokens. + /// Invalidate a token. + /// + /// + /// The access tokens returned by the get token API have a finite period of time for which they are valid. + /// After that time period, they can no longer be used. + /// The time period is defined by the xpack.security.authc.token.timeout setting. + /// + /// + /// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. + /// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2224,7 +2618,7 @@ public virtual Task InvalidateTokenAsync(Action /// - /// Adds or updates application privileges. + /// Create or update application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2236,7 +2630,7 @@ public virtual Task PutPrivilegesAsync(PutPrivilegesReque /// /// - /// Adds or updates application privileges. + /// Create or update application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2248,7 +2642,7 @@ public virtual Task PutPrivilegesAsync(PutPrivilegesReque /// /// - /// Adds or updates application privileges. + /// Create or update application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2261,7 +2655,7 @@ public virtual Task PutPrivilegesAsync(CancellationToken /// /// - /// Adds or updates application privileges. + /// Create or update application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2275,8 +2669,12 @@ public virtual Task PutPrivilegesAsync(Action /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2288,8 +2686,12 @@ public virtual Task PutRoleAsync(PutRoleRequest request, Cancel /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2301,8 +2703,12 @@ public virtual Task PutRoleAsync(PutRoleRequestDescr /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2315,8 +2721,12 @@ public virtual Task PutRoleAsync(Elastic.Clients.Ela /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2330,8 +2740,12 @@ public virtual Task PutRoleAsync(Elastic.Clients.Ela /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2343,8 +2757,12 @@ public virtual Task PutRoleAsync(PutRoleRequestDescriptor descr /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2357,8 +2775,12 @@ public virtual Task PutRoleAsync(Elastic.Clients.Elasticsearch. /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2372,7 +2794,16 @@ public virtual Task PutRoleAsync(Elastic.Clients.Elasticsearch. /// /// - /// Creates and updates role mappings. + /// Create or update role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// Each mapping has rules that identify users and a list of roles that are granted to those users. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + /// + /// + /// This API does not create roles. Rather, it maps users to existing roles. + /// Roles can be created by using the create or update roles API or roles files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2384,7 +2815,16 @@ public virtual Task PutRoleMappingAsync(PutRoleMappingRe /// /// - /// Creates and updates role mappings. + /// Create or update role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// Each mapping has rules that identify users and a list of roles that are granted to those users. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + /// + /// + /// This API does not create roles. Rather, it maps users to existing roles. + /// Roles can be created by using the create or update roles API or roles files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2396,7 +2836,16 @@ public virtual Task PutRoleMappingAsync(PutRoleMappingRe /// /// - /// Creates and updates role mappings. + /// Create or update role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// Each mapping has rules that identify users and a list of roles that are granted to those users. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + /// + /// + /// This API does not create roles. Rather, it maps users to existing roles. + /// Roles can be created by using the create or update roles API or roles files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2409,7 +2858,16 @@ public virtual Task PutRoleMappingAsync(Elastic.Clients. /// /// - /// Creates and updates role mappings. + /// Create or update role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// Each mapping has rules that identify users and a list of roles that are granted to those users. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + /// + /// + /// This API does not create roles. Rather, it maps users to existing roles. + /// Roles can be created by using the create or update roles API or roles files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2423,8 +2881,10 @@ public virtual Task PutRoleMappingAsync(Elastic.Clients. /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2436,8 +2896,10 @@ public virtual Task QueryApiKeysAsync(QueryApiKeysRequest /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2449,8 +2911,10 @@ public virtual Task QueryApiKeysAsync(QueryApiK /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2463,8 +2927,10 @@ public virtual Task QueryApiKeysAsync(Cancellat /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2478,8 +2944,10 @@ public virtual Task QueryApiKeysAsync(Action /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2491,8 +2959,10 @@ public virtual Task QueryApiKeysAsync(QueryApiKeysRequestD /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2505,8 +2975,10 @@ public virtual Task QueryApiKeysAsync(CancellationToken ca /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2520,7 +2992,10 @@ public virtual Task QueryApiKeysAsync(Action /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2532,7 +3007,10 @@ public virtual Task QueryRoleAsync(QueryRoleRequest request, /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2544,7 +3022,10 @@ public virtual Task QueryRoleAsync(QueryRoleReques /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2557,7 +3038,10 @@ public virtual Task QueryRoleAsync(CancellationTok /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2571,7 +3055,10 @@ public virtual Task QueryRoleAsync(Action /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2583,7 +3070,10 @@ public virtual Task QueryRoleAsync(QueryRoleRequestDescriptor /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2596,7 +3086,10 @@ public virtual Task QueryRoleAsync(CancellationToken cancella /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2610,7 +3103,11 @@ public virtual Task QueryRoleAsync(Action /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2622,7 +3119,11 @@ public virtual Task QueryUserAsync(QueryUserRequest request, /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2634,7 +3135,11 @@ public virtual Task QueryUserAsync(QueryUserReques /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2647,7 +3152,11 @@ public virtual Task QueryUserAsync(CancellationTok /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2661,7 +3170,11 @@ public virtual Task QueryUserAsync(Action /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2673,7 +3186,11 @@ public virtual Task QueryUserAsync(QueryUserRequestDescriptor /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2686,7 +3203,11 @@ public virtual Task QueryUserAsync(CancellationToken cancella /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2700,7 +3221,10 @@ public virtual Task QueryUserAsync(Action /// - /// Submits a SAML Response message to Elasticsearch for consumption. + /// Authenticate SAML. + /// + /// + /// Submits a SAML response message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2712,7 +3236,10 @@ public virtual Task SamlAuthenticateAsync(SamlAuthenti /// /// - /// Submits a SAML Response message to Elasticsearch for consumption. + /// Authenticate SAML. + /// + /// + /// Submits a SAML response message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2724,7 +3251,10 @@ public virtual Task SamlAuthenticateAsync(SamlAuthenti /// /// - /// Submits a SAML Response message to Elasticsearch for consumption. + /// Authenticate SAML. + /// + /// + /// Submits a SAML response message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2737,7 +3267,10 @@ public virtual Task SamlAuthenticateAsync(Cancellation /// /// - /// Submits a SAML Response message to Elasticsearch for consumption. + /// Authenticate SAML. + /// + /// + /// Submits a SAML response message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2751,6 +3284,9 @@ public virtual Task SamlAuthenticateAsync(Action /// + /// Logout of SAML completely. + /// + /// /// Verifies the logout response sent from the SAML IdP. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2763,6 +3299,9 @@ public virtual Task SamlCompleteLogoutAsync(SamlComp /// /// + /// Logout of SAML completely. + /// + /// /// Verifies the logout response sent from the SAML IdP. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2775,6 +3314,9 @@ public virtual Task SamlCompleteLogoutAsync(SamlComp /// /// + /// Logout of SAML completely. + /// + /// /// Verifies the logout response sent from the SAML IdP. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2788,6 +3330,9 @@ public virtual Task SamlCompleteLogoutAsync(Cancella /// /// + /// Logout of SAML completely. + /// + /// /// Verifies the logout response sent from the SAML IdP. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2802,6 +3347,9 @@ public virtual Task SamlCompleteLogoutAsync(Action /// + /// Invalidate SAML. + /// + /// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2814,6 +3362,9 @@ public virtual Task SamlInvalidateAsync(SamlInvalidateRe /// /// + /// Invalidate SAML. + /// + /// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2826,6 +3377,9 @@ public virtual Task SamlInvalidateAsync(SamlInvalidateRe /// /// + /// Invalidate SAML. + /// + /// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2839,6 +3393,9 @@ public virtual Task SamlInvalidateAsync(CancellationToke /// /// + /// Invalidate SAML. + /// + /// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2853,6 +3410,9 @@ public virtual Task SamlInvalidateAsync(Action /// + /// Logout of SAML. + /// + /// /// Submits a request to invalidate an access token and refresh token. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2865,6 +3425,9 @@ public virtual Task SamlLogoutAsync(SamlLogoutRequest reques /// /// + /// Logout of SAML. + /// + /// /// Submits a request to invalidate an access token and refresh token. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2877,6 +3440,9 @@ public virtual Task SamlLogoutAsync(SamlLogoutRequestDescrip /// /// + /// Logout of SAML. + /// + /// /// Submits a request to invalidate an access token and refresh token. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2890,6 +3456,9 @@ public virtual Task SamlLogoutAsync(CancellationToken cancel /// /// + /// Logout of SAML. + /// + /// /// Submits a request to invalidate an access token and refresh token. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2904,7 +3473,10 @@ public virtual Task SamlLogoutAsync(Action /// - /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + /// Prepare SAML authentication. + /// + /// + /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2916,7 +3488,10 @@ public virtual Task SamlPrepareAuthentication /// /// - /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + /// Prepare SAML authentication. + /// + /// + /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2928,7 +3503,10 @@ public virtual Task SamlPrepareAuthentication /// /// - /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + /// Prepare SAML authentication. + /// + /// + /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2941,7 +3519,10 @@ public virtual Task SamlPrepareAuthentication /// /// - /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + /// Prepare SAML authentication. + /// + /// + /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2955,6 +3536,9 @@ public virtual Task SamlPrepareAuthentication /// /// + /// Create SAML service provider metadata. + /// + /// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2967,6 +3551,9 @@ public virtual Task SamlServiceProviderMeta /// /// + /// Create SAML service provider metadata. + /// + /// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2979,6 +3566,9 @@ public virtual Task SamlServiceProviderMeta /// /// + /// Create SAML service provider metadata. + /// + /// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// Learn more about this API in the Elasticsearch documentation. @@ -2992,6 +3582,9 @@ public virtual Task SamlServiceProviderMeta /// /// + /// Create SAML service provider metadata. + /// + /// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// Learn more about this API in the Elasticsearch documentation. @@ -3006,6 +3599,9 @@ public virtual Task SamlServiceProviderMeta /// /// + /// Suggest a user profile. + /// + /// /// Get suggestions for user profiles that match specified search criteria. /// /// Learn more about this API in the Elasticsearch documentation. @@ -3018,6 +3614,9 @@ public virtual Task SuggestUserProfilesAsync(Sugges /// /// + /// Suggest a user profile. + /// + /// /// Get suggestions for user profiles that match specified search criteria. /// /// Learn more about this API in the Elasticsearch documentation. @@ -3030,6 +3629,9 @@ public virtual Task SuggestUserProfilesAsync(Sugges /// /// + /// Suggest a user profile. + /// + /// /// Get suggestions for user profiles that match specified search criteria. /// /// Learn more about this API in the Elasticsearch documentation. @@ -3043,6 +3645,9 @@ public virtual Task SuggestUserProfilesAsync(Cancel /// /// + /// Suggest a user profile. + /// + /// /// Get suggestions for user profiles that match specified search criteria. /// /// Learn more about this API in the Elasticsearch documentation. @@ -3058,6 +3663,8 @@ public virtual Task SuggestUserProfilesAsync(Action /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -3083,6 +3690,8 @@ public virtual Task UpdateApiKeyAsync(UpdateApiKeyRequest /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -3108,6 +3717,8 @@ public virtual Task UpdateApiKeyAsync(UpdateApi /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -3134,6 +3745,8 @@ public virtual Task UpdateApiKeyAsync(Elastic.C /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -3161,6 +3774,8 @@ public virtual Task UpdateApiKeyAsync(Elastic.C /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -3186,6 +3801,8 @@ public virtual Task UpdateApiKeyAsync(UpdateApiKeyRequestD /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -3212,6 +3829,8 @@ public virtual Task UpdateApiKeyAsync(Elastic.Clients.Elas /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -3238,7 +3857,10 @@ public virtual Task UpdateApiKeyAsync(Elastic.Clients.Elas /// /// - /// Updates specific data for the user profile that's associated with the specified unique ID. + /// Update user profile data. + /// + /// + /// Update specific data for the user profile that is associated with a unique ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3250,7 +3872,10 @@ public virtual Task UpdateUserProfileDataAsync(Up /// /// - /// Updates specific data for the user profile that's associated with the specified unique ID. + /// Update user profile data. + /// + /// + /// Update specific data for the user profile that is associated with a unique ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3262,7 +3887,10 @@ public virtual Task UpdateUserProfileDataAsync(Up /// /// - /// Updates specific data for the user profile that's associated with the specified unique ID. + /// Update user profile data. + /// + /// + /// Update specific data for the user profile that is associated with a unique ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3275,7 +3903,10 @@ public virtual Task UpdateUserProfileDataAsync(st /// /// - /// Updates specific data for the user profile that's associated with the specified unique ID. + /// Update user profile data. + /// + /// + /// Update specific data for the user profile that is associated with a unique ID. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.g.cs index afed21e35c..1e4d09e511 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.g.cs @@ -24,6 +24,7 @@ using Elastic.Clients.Elasticsearch.Serverless.Esql; using Elastic.Clients.Elasticsearch.Serverless.Graph; using Elastic.Clients.Elasticsearch.Serverless.IndexManagement; +using Elastic.Clients.Elasticsearch.Serverless.Inference; using Elastic.Clients.Elasticsearch.Serverless.Ingest; using Elastic.Clients.Elasticsearch.Serverless.LicenseManagement; using Elastic.Clients.Elasticsearch.Serverless.MachineLearning; @@ -53,6 +54,7 @@ public partial class ElasticsearchClient public virtual EsqlNamespacedClient Esql { get; private set; } public virtual GraphNamespacedClient Graph { get; private set; } public virtual IndicesNamespacedClient Indices { get; private set; } + public virtual InferenceNamespacedClient Inference { get; private set; } public virtual IngestNamespacedClient Ingest { get; private set; } public virtual LicenseManagementNamespacedClient LicenseManagement { get; private set; } public virtual MachineLearningNamespacedClient MachineLearning { get; private set; } @@ -76,6 +78,7 @@ private partial void SetupNamespaces() Esql = new EsqlNamespacedClient(this); Graph = new GraphNamespacedClient(this); Indices = new IndicesNamespacedClient(this); + Inference = new InferenceNamespacedClient(this); Ingest = new IngestNamespacedClient(this); LicenseManagement = new LicenseManagementNamespacedClient(this); MachineLearning = new MachineLearningNamespacedClient(this); @@ -97,7 +100,7 @@ private partial void SetupNamespaces() /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(BulkRequest request, CancellationToken cancellationToken = default) { @@ -111,7 +114,7 @@ public virtual Task BulkAsync(BulkRequest request, CancellationTok /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(BulkRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -125,7 +128,7 @@ public virtual Task BulkAsync(BulkRequestDescriptor - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, CancellationToken cancellationToken = default) { @@ -140,7 +143,7 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticse /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -156,7 +159,7 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticse /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(CancellationToken cancellationToken = default) { @@ -171,7 +174,7 @@ public virtual Task BulkAsync(CancellationToken cancell /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -187,7 +190,7 @@ public virtual Task BulkAsync(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(BulkRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -201,7 +204,7 @@ public virtual Task BulkAsync(BulkRequestDescriptor descriptor, Ca /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, CancellationToken cancellationToken = default) { @@ -216,7 +219,7 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.Server /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.Serverless.IndexName? index, Action configureRequest, CancellationToken cancellationToken = default) { @@ -232,7 +235,7 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.Server /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(CancellationToken cancellationToken = default) { @@ -247,7 +250,7 @@ public virtual Task BulkAsync(CancellationToken cancellationToken /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -259,9 +262,12 @@ public virtual Task BulkAsync(Action config /// /// - /// Clears the search context and results for a scrolling search. + /// Clear a scrolling search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Clear the search context and results for a scrolling search. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(ClearScrollRequest request, CancellationToken cancellationToken = default) { @@ -271,9 +277,12 @@ public virtual Task ClearScrollAsync(ClearScrollRequest req /// /// - /// Clears the search context and results for a scrolling search. + /// Clear a scrolling search. + /// + /// + /// Clear the search context and results for a scrolling search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(ClearScrollRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -283,9 +292,12 @@ public virtual Task ClearScrollAsync(ClearScrollRequestDesc /// /// - /// Clears the search context and results for a scrolling search. + /// Clear a scrolling search. + /// + /// + /// Clear the search context and results for a scrolling search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(CancellationToken cancellationToken = default) { @@ -296,9 +308,12 @@ public virtual Task ClearScrollAsync(CancellationToken canc /// /// - /// Clears the search context and results for a scrolling search. + /// Clear a scrolling search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Clear the search context and results for a scrolling search. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -310,9 +325,15 @@ public virtual Task ClearScrollAsync(Action /// - /// Closes a point-in-time. + /// Close a point in time. + /// + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// A point in time is automatically closed when the keep_alive period has elapsed. + /// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(ClosePointInTimeRequest request, CancellationToken cancellationToken = default) { @@ -322,9 +343,15 @@ public virtual Task ClosePointInTimeAsync(ClosePointIn /// /// - /// Closes a point-in-time. + /// Close a point in time. + /// + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// A point in time is automatically closed when the keep_alive period has elapsed. + /// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(ClosePointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -334,9 +361,15 @@ public virtual Task ClosePointInTimeAsync(ClosePointIn /// /// - /// Closes a point-in-time. + /// Close a point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// A point in time is automatically closed when the keep_alive period has elapsed. + /// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(CancellationToken cancellationToken = default) { @@ -347,9 +380,15 @@ public virtual Task ClosePointInTimeAsync(Cancellation /// /// - /// Closes a point-in-time. + /// Close a point in time. + /// + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// A point in time is automatically closed when the keep_alive period has elapsed. + /// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -996,7 +1035,11 @@ public virtual Task DeleteByQueryAsync(Elastic.Clients.El /// /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// Throttle a delete by query operation. + /// + /// + /// Change the number of requests per second for a particular delete by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1008,7 +1051,11 @@ public virtual Task DeleteByQueryRethrottleAsyn /// /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// Throttle a delete by query operation. + /// + /// + /// Change the number of requests per second for a particular delete by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1020,7 +1067,11 @@ public virtual Task DeleteByQueryRethrottleAsyn /// /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// Throttle a delete by query operation. + /// + /// + /// Change the number of requests per second for a particular delete by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1033,7 +1084,11 @@ public virtual Task DeleteByQueryRethrottleAsyn /// /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// Throttle a delete by query operation. + /// + /// + /// Change the number of requests per second for a particular delete by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1741,9 +1796,15 @@ public virtual Task> ExplainAsync(Elastic. /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1755,9 +1816,15 @@ public virtual Task FieldCapsAsync(FieldCapsRequest request, /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1769,9 +1836,15 @@ public virtual Task FieldCapsAsync(FieldCapsReques /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1784,9 +1857,15 @@ public virtual Task FieldCapsAsync(Elastic.Clients /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1800,9 +1879,15 @@ public virtual Task FieldCapsAsync(Elastic.Clients /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1815,9 +1900,15 @@ public virtual Task FieldCapsAsync(CancellationTok /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1831,9 +1922,15 @@ public virtual Task FieldCapsAsync(Action /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1845,9 +1942,15 @@ public virtual Task FieldCapsAsync(FieldCapsRequestDescriptor /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1860,9 +1963,15 @@ public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsea /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1876,9 +1985,15 @@ public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsea /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1891,9 +2006,15 @@ public virtual Task FieldCapsAsync(CancellationToken cancella /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2631,7 +2752,13 @@ public virtual Task InfoAsync(Action config /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2643,7 +2770,13 @@ public virtual Task MtermvectorsAsync(MultiTermVectors /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2655,7 +2788,13 @@ public virtual Task MtermvectorsAsync(Multi /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2668,7 +2807,13 @@ public virtual Task MtermvectorsAsync(Elast /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2682,7 +2827,13 @@ public virtual Task MtermvectorsAsync(Elast /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2695,7 +2846,13 @@ public virtual Task MtermvectorsAsync(Cance /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2709,7 +2866,13 @@ public virtual Task MtermvectorsAsync(Actio /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2721,7 +2884,13 @@ public virtual Task MtermvectorsAsync(MultiTermVectors /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2734,7 +2903,13 @@ public virtual Task MtermvectorsAsync(Elastic.Clients. /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2748,7 +2923,13 @@ public virtual Task MtermvectorsAsync(Elastic.Clients. /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2761,7 +2942,13 @@ public virtual Task MtermvectorsAsync(CancellationToke /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2775,7 +2962,12 @@ public virtual Task MtermvectorsAsync(Action /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2787,7 +2979,12 @@ public virtual Task> MultiGetAsync(MultiG /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2799,7 +2996,12 @@ public virtual Task> MultiGetAsync(MultiG /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2812,7 +3014,12 @@ public virtual Task> MultiGetAsync(Elasti /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2826,7 +3033,12 @@ public virtual Task> MultiGetAsync(Elasti /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2839,7 +3051,12 @@ public virtual Task> MultiGetAsync(Cancel /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2853,7 +3070,25 @@ public virtual Task> MultiGetAsync(Action /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2865,7 +3100,25 @@ public virtual Task> MultiSearchAsync( /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2877,7 +3130,25 @@ public virtual Task> MultiSearchAsync( /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2890,7 +3161,25 @@ public virtual Task> MultiSearchAsync( /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2904,7 +3193,25 @@ public virtual Task> MultiSearchAsync( /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2917,7 +3224,25 @@ public virtual Task> MultiSearchAsync( /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2931,7 +3256,7 @@ public virtual Task> MultiSearchAsync( /// /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2943,7 +3268,7 @@ public virtual Task> MultiSearchTemplateA /// /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2955,7 +3280,7 @@ public virtual Task> MultiSearchTemplateA /// /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2968,7 +3293,7 @@ public virtual Task> MultiSearchTemplateA /// /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2982,7 +3307,7 @@ public virtual Task> MultiSearchTemplateA /// /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2995,7 +3320,7 @@ public virtual Task> MultiSearchTemplateA /// /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3009,14 +3334,21 @@ public virtual Task> MultiSearchTemplateA /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(OpenPointInTimeRequest request, CancellationToken cancellationToken = default) { @@ -3026,14 +3358,21 @@ public virtual Task OpenPointInTimeAsync(OpenPointInTim /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(OpenPointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -3043,14 +3382,21 @@ public virtual Task OpenPointInTimeAsync(Ope /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) { @@ -3061,14 +3407,21 @@ public virtual Task OpenPointInTimeAsync(Ela /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -3080,14 +3433,21 @@ public virtual Task OpenPointInTimeAsync(Ela /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(CancellationToken cancellationToken = default) { @@ -3098,14 +3458,21 @@ public virtual Task OpenPointInTimeAsync(Can /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -3117,14 +3484,21 @@ public virtual Task OpenPointInTimeAsync(Act /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(OpenPointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -3134,14 +3508,21 @@ public virtual Task OpenPointInTimeAsync(OpenPointInTim /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) { @@ -3152,14 +3533,21 @@ public virtual Task OpenPointInTimeAsync(Elastic.Client /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -3381,7 +3769,10 @@ public virtual Task PutScriptAsync(Elastic.Clients.Elasticsea /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3393,7 +3784,10 @@ public virtual Task RankEvalAsync(RankEvalRequest request, Can /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3405,7 +3799,10 @@ public virtual Task RankEvalAsync(RankEvalRequestDe /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3418,7 +3815,10 @@ public virtual Task RankEvalAsync(Elastic.Clients.E /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3432,7 +3832,10 @@ public virtual Task RankEvalAsync(Elastic.Clients.E /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3445,7 +3848,10 @@ public virtual Task RankEvalAsync(CancellationToken /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3459,7 +3865,10 @@ public virtual Task RankEvalAsync(Action /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3471,7 +3880,10 @@ public virtual Task RankEvalAsync(RankEvalRequestDescriptor de /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3484,7 +3896,10 @@ public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearc /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3498,7 +3913,10 @@ public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearc /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3511,7 +3929,10 @@ public virtual Task RankEvalAsync(CancellationToken cancellati /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3622,7 +4043,10 @@ public virtual Task ReindexAsync(Action /// - /// Copies documents from a source to a destination. + /// Throttle a reindex operation. + /// + /// + /// Change the number of requests per second for a particular reindex operation. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3634,7 +4058,10 @@ public virtual Task ReindexRethrottleAsync(ReindexRet /// /// - /// Copies documents from a source to a destination. + /// Throttle a reindex operation. + /// + /// + /// Change the number of requests per second for a particular reindex operation. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3646,7 +4073,10 @@ public virtual Task ReindexRethrottleAsync(ReindexRet /// /// - /// Copies documents from a source to a destination. + /// Throttle a reindex operation. + /// + /// + /// Change the number of requests per second for a particular reindex operation. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3659,7 +4089,10 @@ public virtual Task ReindexRethrottleAsync(Elastic.Cl /// /// - /// Copies documents from a source to a destination. + /// Throttle a reindex operation. + /// + /// + /// Change the number of requests per second for a particular reindex operation. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3673,7 +4106,10 @@ public virtual Task ReindexRethrottleAsync(Elastic.Cl /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3685,7 +4121,10 @@ public virtual Task RenderSearchTemplateAsync(Rend /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3697,7 +4136,10 @@ public virtual Task RenderSearchTemplateAsync /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3710,7 +4152,10 @@ public virtual Task RenderSearchTemplateAsync /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3724,7 +4169,10 @@ public virtual Task RenderSearchTemplateAsync /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3737,7 +4185,10 @@ public virtual Task RenderSearchTemplateAsync /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3751,7 +4202,10 @@ public virtual Task RenderSearchTemplateAsync /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3763,7 +4217,10 @@ public virtual Task RenderSearchTemplateAsync(Rend /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3776,7 +4233,10 @@ public virtual Task RenderSearchTemplateAsync(Elas /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3790,7 +4250,10 @@ public virtual Task RenderSearchTemplateAsync(Elas /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3803,7 +4266,10 @@ public virtual Task RenderSearchTemplateAsync(Canc /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3817,7 +4283,24 @@ public virtual Task RenderSearchTemplateAsync(Acti /// /// - /// Allows to retrieve a large numbers of results from a single search request. + /// Run a scrolling search. + /// + /// + /// IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the search_after parameter with a point in time (PIT). + /// + /// + /// The scroll API gets large sets of results from a single scrolling search request. + /// To get the necessary scroll ID, submit a search API request that includes an argument for the scroll query parameter. + /// The scroll parameter indicates how long Elasticsearch should retain the search context for the request. + /// The search response returns a scroll ID in the _scroll_id response body parameter. + /// You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. + /// If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. + /// + /// + /// You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. + /// + /// + /// IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3829,7 +4312,10 @@ public virtual Task> ScrollAsync(ScrollRequ /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -3843,7 +4329,10 @@ public virtual Task> SearchAsync(SearchRequ /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -3857,7 +4346,10 @@ public virtual Task> SearchAsync(SearchRequ /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -3872,7 +4364,10 @@ public virtual Task> SearchAsync(Elastic.Cl /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -3888,7 +4383,10 @@ public virtual Task> SearchAsync(Elastic.Cl /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -3903,7 +4401,10 @@ public virtual Task> SearchAsync(Cancellati /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -3920,7 +4421,9 @@ public virtual Task> SearchAsync(Action /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3933,7 +4436,9 @@ public virtual Task SearchMvtAsync(SearchMvtRequest request, /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3946,7 +4451,9 @@ public virtual Task SearchMvtAsync(SearchMvtReques /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3960,7 +4467,9 @@ public virtual Task SearchMvtAsync(Elastic.Clients /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3975,7 +4484,9 @@ public virtual Task SearchMvtAsync(Elastic.Clients /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3989,7 +4500,9 @@ public virtual Task SearchMvtAsync(Elastic.Clients /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4004,7 +4517,9 @@ public virtual Task SearchMvtAsync(Elastic.Clients /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4017,7 +4532,9 @@ public virtual Task SearchMvtAsync(SearchMvtRequestDescriptor /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4031,7 +4548,9 @@ public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsea /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4045,7 +4564,7 @@ public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsea /// /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4057,7 +4576,7 @@ public virtual Task> SearchTemplateAsync /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4069,7 +4588,7 @@ public virtual Task> SearchTemplateAsync /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4082,7 +4601,7 @@ public virtual Task> SearchTemplateAsync /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4096,7 +4615,7 @@ public virtual Task> SearchTemplateAsync /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4109,7 +4628,7 @@ public virtual Task> SearchTemplateAsync /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4123,7 +4642,18 @@ public virtual Task> SearchTemplateAsync /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4135,7 +4665,18 @@ public virtual Task TermsEnumAsync(TermsEnumRequest request, /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4147,7 +4688,18 @@ public virtual Task TermsEnumAsync(TermsEnumReques /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4160,7 +4712,18 @@ public virtual Task TermsEnumAsync(Elastic.Clients /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4174,7 +4737,18 @@ public virtual Task TermsEnumAsync(Elastic.Clients /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4187,7 +4761,18 @@ public virtual Task TermsEnumAsync(CancellationTok /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4201,7 +4786,18 @@ public virtual Task TermsEnumAsync(Action /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4213,7 +4809,18 @@ public virtual Task TermsEnumAsync(TermsEnumRequestDescriptor /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4226,7 +4833,18 @@ public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsea /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4241,7 +4859,9 @@ public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsea /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4254,7 +4874,9 @@ public virtual Task TermvectorsAsync(TermVectors /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4267,7 +4889,9 @@ public virtual Task TermvectorsAsync(TermVectors /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4281,7 +4905,9 @@ public virtual Task TermvectorsAsync(Elastic.Cli /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4296,7 +4922,9 @@ public virtual Task TermvectorsAsync(Elastic.Cli /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4310,7 +4938,9 @@ public virtual Task TermvectorsAsync(Elastic.Cli /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4325,7 +4955,9 @@ public virtual Task TermvectorsAsync(Elastic.Cli /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4339,7 +4971,9 @@ public virtual Task TermvectorsAsync(TDocument d /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4354,7 +4988,9 @@ public virtual Task TermvectorsAsync(TDocument d /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4368,7 +5004,9 @@ public virtual Task TermvectorsAsync(TDocument d /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4383,7 +5021,9 @@ public virtual Task TermvectorsAsync(TDocument d /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4397,7 +5037,9 @@ public virtual Task TermvectorsAsync(TDocument d /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4412,7 +5054,9 @@ public virtual Task TermvectorsAsync(TDocument d /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4426,7 +5070,9 @@ public virtual Task TermvectorsAsync(Elastic.Cli /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4746,7 +5392,11 @@ public virtual Task UpdateByQueryAsync(Elastic.Clients.El /// /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// Throttle an update by query operation. + /// + /// + /// Change the number of requests per second for a particular update by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4758,7 +5408,11 @@ public virtual Task UpdateByQueryRethrottleAsyn /// /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// Throttle an update by query operation. + /// + /// + /// Change the number of requests per second for a particular update by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4770,7 +5424,11 @@ public virtual Task UpdateByQueryRethrottleAsyn /// /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// Throttle an update by query operation. + /// + /// + /// Change the number of requests per second for a particular update by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4783,7 +5441,11 @@ public virtual Task UpdateByQueryRethrottleAsyn /// /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// Throttle an update by query operation. + /// + /// + /// Change the number of requests per second for a particular update by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Analysis/Normalizers.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Analysis/Normalizers.g.cs index 7edf328e1b..718dc14ebd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Analysis/Normalizers.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Analysis/Normalizers.g.cs @@ -122,7 +122,7 @@ public override void Write(Utf8JsonWriter writer, INormalizer value, JsonSeriali } /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// [JsonConverter(typeof(NormalizerInterfaceConverter))] public partial interface INormalizer diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ByteSize.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ByteSize.g.cs index b2d4e9e7d5..3fc70502c0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ByteSize.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/ByteSize.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless; /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ByteSize : Union { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Context.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Context.g.cs index c078dc5913..5ed663639d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Context.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/Context.g.cs @@ -34,7 +34,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.Search; /// /// Text or location that we want similar documents for or a lookup to a document's field for the text. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class Context : Union { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs index 9d1ac59206..e8159ec312 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; /// /// Discounted cumulative gain (DCG) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricDiscountedCumulativeGain { @@ -56,7 +56,7 @@ public sealed partial class RankEvalMetricDiscountedCumulativeGain /// /// Discounted cumulative gain (DCG) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricDiscountedCumulativeGainDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs index 9399ba7a53..baa2700768 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; /// /// Expected Reciprocal Rank (ERR) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricExpectedReciprocalRank { @@ -56,7 +56,7 @@ public sealed partial class RankEvalMetricExpectedReciprocalRank /// /// Expected Reciprocal Rank (ERR) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricExpectedReciprocalRankDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs index 424a709eb1..f7a9c44621 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; /// /// Mean Reciprocal Rank /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricMeanReciprocalRank { @@ -56,7 +56,7 @@ public sealed partial class RankEvalMetricMeanReciprocalRank /// /// Mean Reciprocal Rank /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricMeanReciprocalRankDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs index 2f539197a3..d59552021b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; /// /// Precision at K (P@k) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricPrecision { @@ -64,7 +64,7 @@ public sealed partial class RankEvalMetricPrecision /// /// Precision at K (P@k) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricPrecisionDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs index 795cc69562..cb35bfb45c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Core.RankEval; /// /// Recall at K (R@k) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricRecall { @@ -56,7 +56,7 @@ public sealed partial class RankEvalMetricRecall /// /// Recall at K (R@k) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricRecallDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Inference.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Inference.g.cs new file mode 100644 index 0000000000..2a4deee621 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Inference.g.cs @@ -0,0 +1,85 @@ +// 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.Serverless.Core; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using Elastic.Transport; +using System; +using System.Runtime.Serialization; +using System.Text; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Inference; + +[JsonConverter(typeof(TaskTypeConverter))] +public enum TaskType +{ + [EnumMember(Value = "text_embedding")] + TextEmbedding, + [EnumMember(Value = "sparse_embedding")] + SparseEmbedding, + [EnumMember(Value = "rerank")] + Rerank, + [EnumMember(Value = "completion")] + Completion +} + +internal sealed class TaskTypeConverter : JsonConverter +{ + public override TaskType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + var enumString = reader.GetString(); + switch (enumString) + { + case "text_embedding": + return TaskType.TextEmbedding; + case "sparse_embedding": + return TaskType.SparseEmbedding; + case "rerank": + return TaskType.Rerank; + case "completion": + return TaskType.Completion; + } + + ThrowHelper.ThrowJsonException(); + return default; + } + + public override void Write(Utf8JsonWriter writer, TaskType value, JsonSerializerOptions options) + { + switch (value) + { + case TaskType.TextEmbedding: + writer.WriteStringValue("text_embedding"); + return; + case TaskType.SparseEmbedding: + writer.WriteStringValue("sparse_embedding"); + return; + case TaskType.Rerank: + writer.WriteStringValue("rerank"); + return; + case TaskType.Completion: + writer.WriteStringValue("completion"); + return; + } + + writer.WriteNullValue(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Security.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Security.g.cs index 08429f5c02..cb3cfe32ae 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Security.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Security.g.cs @@ -265,6 +265,29 @@ public override void Write(Utf8JsonWriter writer, GrantType value, JsonSerialize public static bool operator !=(IndexPrivilege a, IndexPrivilege b) => !(a == b); } +[JsonConverter(typeof(EnumStructConverter))] +public readonly partial struct RestrictionWorkflow : IEnumStruct +{ + public RestrictionWorkflow(string value) => Value = value; + + RestrictionWorkflow IEnumStruct.Create(string value) => value; + + public readonly string Value { get; } + public static RestrictionWorkflow SearchApplicationQuery { get; } = new RestrictionWorkflow("search_application_query"); + + public override string ToString() => Value ?? string.Empty; + + public static implicit operator string(RestrictionWorkflow restrictionWorkflow) => restrictionWorkflow.Value; + public static implicit operator RestrictionWorkflow(string value) => new(value); + + public override int GetHashCode() => Value.GetHashCode(); + public override bool Equals(object obj) => obj is RestrictionWorkflow other && this.Equals(other); + public bool Equals(RestrictionWorkflow other) => Value == other.Value; + + public static bool operator ==(RestrictionWorkflow a, RestrictionWorkflow b) => a.Equals(b); + public static bool operator !=(RestrictionWorkflow a, RestrictionWorkflow b) => !(a == b); +} + [JsonConverter(typeof(TemplateFormatConverter))] public enum TemplateFormat { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Fuzziness.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Fuzziness.g.cs index 55076a1833..1047be7f88 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Fuzziness.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Fuzziness.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless; /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class Fuzziness : Union { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs index 52d2669e5e..1cd15282d5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs @@ -34,10 +34,32 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; /// public sealed partial class DataStreamLifecycle { + /// + /// + /// If defined, every document added to this data stream will be stored at least for this time frame. + /// Any time after this duration the document could be deleted. + /// When empty, every document in this data stream will be stored indefinitely. + /// + /// [JsonInclude, JsonPropertyName("data_retention")] public Elastic.Clients.Elasticsearch.Serverless.Duration? DataRetention { get; set; } + + /// + /// + /// The downsampling configuration to execute for the managed backing index after rollover. + /// + /// [JsonInclude, JsonPropertyName("downsampling")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsampling? Downsampling { get; set; } + + /// + /// + /// If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle + /// that's disabled (enabled: false) will have no effect on the data stream. + /// + /// + [JsonInclude, JsonPropertyName("enabled")] + public bool? Enabled { get; set; } } /// @@ -57,13 +79,26 @@ public DataStreamLifecycleDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsampling? DownsamplingValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsamplingDescriptor DownsamplingDescriptor { get; set; } private Action DownsamplingDescriptorAction { get; set; } + private bool? EnabledValue { 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 DataStreamLifecycleDescriptor DataRetention(Elastic.Clients.Elasticsearch.Serverless.Duration? dataRetention) { DataRetentionValue = dataRetention; return Self; } + /// + /// + /// The downsampling configuration to execute for the managed backing index after rollover. + /// + /// public DataStreamLifecycleDescriptor Downsampling(Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsampling? downsampling) { DownsamplingDescriptor = null; @@ -88,6 +123,18 @@ public DataStreamLifecycleDescriptor Downsampling(Action + /// + /// If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle + /// that's disabled (enabled: false) will have no effect on the data stream. + /// + /// + public DataStreamLifecycleDescriptor Enabled(bool? enabled = true) + { + EnabledValue = enabled; + return Self; + } + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); @@ -113,6 +160,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, DownsamplingValue, options); } + if (EnabledValue.HasValue) + { + writer.WritePropertyName("enabled"); + writer.WriteBooleanValue(EnabledValue.Value); + } + writer.WriteEndObject(); } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs index b9ccfb7f5f..48871a55b0 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs @@ -53,6 +53,15 @@ public sealed partial class DataStreamLifecycleWithRollover [JsonInclude, JsonPropertyName("downsampling")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleDownsampling? Downsampling { get; init; } + /// + /// + /// If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle + /// that's disabled (enabled: false) will have no effect on the data stream. + /// + /// + [JsonInclude, JsonPropertyName("enabled")] + public bool? Enabled { get; init; } + /// /// /// The conditions which will trigger the rollover of a backing index as configured by the cluster setting cluster.lifecycle.default.rollover. diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamWithLifecycle.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamWithLifecycle.g.cs index 8094905750..3d942cd5f3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamWithLifecycle.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/DataStreamWithLifecycle.g.cs @@ -30,7 +30,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; public sealed partial class DataStreamWithLifecycle { [JsonInclude, JsonPropertyName("lifecycle")] - public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycle? Lifecycle { get; init; } + public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.DataStreamLifecycleWithRollover? Lifecycle { get; init; } [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettings.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettings.g.cs index d006d71418..65024976ad 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettings.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexSettings.g.cs @@ -739,7 +739,7 @@ public override void Write(Utf8JsonWriter writer, IndexSettings value, JsonSeria } /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// [JsonConverter(typeof(IndexSettingsConverter))] public sealed partial class IndexSettings @@ -840,7 +840,7 @@ public sealed partial class IndexSettings } /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class IndexSettingsDescriptor : SerializableDescriptor> { @@ -2277,7 +2277,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class IndexSettingsDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplate.g.cs index 615da923b5..69e9ad496b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplate.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/IndexTemplate.g.cs @@ -51,6 +51,25 @@ public sealed partial class IndexTemplate [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.Serverless.IndexManagement.IndexTemplateDataStreamConfiguration? DataStream { get; init; } + /// + /// + /// Marks this index template as deprecated. + /// When creating or updating a non-deprecated index template that uses deprecated components, + /// Elasticsearch will emit a deprecation warning. + /// + /// + [JsonInclude, JsonPropertyName("deprecated")] + public bool? Deprecated { get; init; } + + /// + /// + /// A list of component template names that are allowed to be absent. + /// + /// + [JsonInclude, JsonPropertyName("ignore_missing_component_templates")] + [SingleOrManyCollectionConverter(typeof(string))] + public IReadOnlyCollection? IgnoreMissingComponentTemplates { get; init; } + /// /// /// Name of the index template. diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs index e0a1a5e6a2..ee3e967c44 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.IndexManagement; /// /// Mapping Limit Settings /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class MappingLimitSettings { @@ -57,7 +57,7 @@ public sealed partial class MappingLimitSettings /// /// Mapping Limit Settings /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class MappingLimitSettingsDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Inference/InferenceEndpoint.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Inference/InferenceEndpoint.g.cs new file mode 100644 index 0000000000..3f8912a106 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Inference/InferenceEndpoint.g.cs @@ -0,0 +1,127 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Inference; + +/// +/// +/// Configuration options when storing the inference endpoint +/// +/// +public sealed partial class InferenceEndpoint +{ + /// + /// + /// The service type + /// + /// + [JsonInclude, JsonPropertyName("service")] + public string Service { get; set; } + + /// + /// + /// Settings specific to the service + /// + /// + [JsonInclude, JsonPropertyName("service_settings")] + public object ServiceSettings { get; set; } + + /// + /// + /// Task settings specific to the service and task type + /// + /// + [JsonInclude, JsonPropertyName("task_settings")] + public object? TaskSettings { get; set; } +} + +/// +/// +/// Configuration options when storing the inference endpoint +/// +/// +public sealed partial class InferenceEndpointDescriptor : SerializableDescriptor +{ + internal InferenceEndpointDescriptor(Action configure) => configure.Invoke(this); + + public InferenceEndpointDescriptor() : base() + { + } + + private string ServiceValue { get; set; } + private object ServiceSettingsValue { get; set; } + private object? TaskSettingsValue { get; set; } + + /// + /// + /// The service type + /// + /// + public InferenceEndpointDescriptor Service(string service) + { + ServiceValue = service; + return Self; + } + + /// + /// + /// Settings specific to the service + /// + /// + public InferenceEndpointDescriptor ServiceSettings(object serviceSettings) + { + ServiceSettingsValue = serviceSettings; + return Self; + } + + /// + /// + /// Task settings specific to the service and task type + /// + /// + public InferenceEndpointDescriptor TaskSettings(object? taskSettings) + { + TaskSettingsValue = taskSettings; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("service"); + writer.WriteStringValue(ServiceValue); + writer.WritePropertyName("service_settings"); + JsonSerializer.Serialize(writer, ServiceSettingsValue, options); + if (TaskSettingsValue is not null) + { + writer.WritePropertyName("task_settings"); + JsonSerializer.Serialize(writer, TaskSettingsValue, options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Inference/InferenceEndpointInfo.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Inference/InferenceEndpointInfo.g.cs new file mode 100644 index 0000000000..aee66bad66 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Inference/InferenceEndpointInfo.g.cs @@ -0,0 +1,76 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Inference; + +/// +/// +/// Represents an inference endpoint as returned by the GET API +/// +/// +public sealed partial class InferenceEndpointInfo +{ + /// + /// + /// The inference Id + /// + /// + [JsonInclude, JsonPropertyName("inference_id")] + public string InferenceId { get; init; } + + /// + /// + /// The service type + /// + /// + [JsonInclude, JsonPropertyName("service")] + public string Service { get; init; } + + /// + /// + /// Settings specific to the service + /// + /// + [JsonInclude, JsonPropertyName("service_settings")] + public object ServiceSettings { get; init; } + + /// + /// + /// Task settings specific to the service and task type + /// + /// + [JsonInclude, JsonPropertyName("task_settings")] + public object? TaskSettings { get; init; } + + /// + /// + /// The task type + /// + /// + [JsonInclude, JsonPropertyName("task_type")] + public Elastic.Clients.Elasticsearch.Serverless.Inference.TaskType TaskType { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/IpLocationProcessor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/IpLocationProcessor.g.cs new file mode 100644 index 0000000000..0f8ec6efef --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/IpLocationProcessor.g.cs @@ -0,0 +1,798 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; + +public sealed partial class IpLocationProcessor +{ + /// + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// + /// + [JsonInclude, JsonPropertyName("database_file")] + public string? DatabaseFile { get; set; } + + /// + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// + /// + [JsonInclude, JsonPropertyName("description")] + public string? Description { get; set; } + + /// + /// + /// If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. + /// Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index. + /// + /// + [JsonInclude, JsonPropertyName("download_database_on_pipeline_creation")] + public bool? DownloadDatabaseOnPipelineCreation { get; set; } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + [JsonInclude, JsonPropertyName("field")] + public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } + + /// + /// + /// If true, only the first found IP location data will be returned, even if the field contains an array. + /// + /// + [JsonInclude, JsonPropertyName("first_only")] + public bool? FirstOnly { get; set; } + + /// + /// + /// Conditionally execute the processor. + /// + /// + [JsonInclude, JsonPropertyName("if")] + public string? If { get; set; } + + /// + /// + /// Ignore failures for the processor. + /// + /// + [JsonInclude, JsonPropertyName("ignore_failure")] + public bool? IgnoreFailure { get; set; } + + /// + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// + /// + [JsonInclude, JsonPropertyName("ignore_missing")] + public bool? IgnoreMissing { get; set; } + + /// + /// + /// Handle failures for the processor. + /// + /// + [JsonInclude, JsonPropertyName("on_failure")] + public ICollection? OnFailure { get; set; } + + /// + /// + /// Controls what properties are added to the target_field based on the IP location lookup. + /// + /// + [JsonInclude, JsonPropertyName("properties")] + public ICollection? Properties { get; set; } + + /// + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// + /// + [JsonInclude, JsonPropertyName("tag")] + public string? Tag { get; set; } + + /// + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// + [JsonInclude, JsonPropertyName("target_field")] + public Elastic.Clients.Elasticsearch.Serverless.Field? TargetField { get; set; } + + public static implicit operator Elastic.Clients.Elasticsearch.Serverless.Ingest.Processor(IpLocationProcessor ipLocationProcessor) => Elastic.Clients.Elasticsearch.Serverless.Ingest.Processor.IpLocation(ipLocationProcessor); +} + +public sealed partial class IpLocationProcessorDescriptor : SerializableDescriptor> +{ + internal IpLocationProcessorDescriptor(Action> configure) => configure.Invoke(this); + + public IpLocationProcessorDescriptor() : base() + { + } + + private string? DatabaseFileValue { get; set; } + private string? DescriptionValue { get; set; } + private bool? DownloadDatabaseOnPipelineCreationValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } + private bool? FirstOnlyValue { get; set; } + private string? IfValue { get; set; } + private bool? IgnoreFailureValue { get; set; } + private bool? IgnoreMissingValue { get; set; } + private ICollection? OnFailureValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Ingest.ProcessorDescriptor OnFailureDescriptor { get; set; } + private Action> OnFailureDescriptorAction { get; set; } + private Action>[] OnFailureDescriptorActions { get; set; } + private ICollection? PropertiesValue { get; set; } + private string? TagValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } + + /// + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// + /// + public IpLocationProcessorDescriptor DatabaseFile(string? databaseFile) + { + DatabaseFileValue = databaseFile; + return Self; + } + + /// + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// + /// + public IpLocationProcessorDescriptor Description(string? description) + { + DescriptionValue = description; + return Self; + } + + /// + /// + /// If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. + /// Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index. + /// + /// + public IpLocationProcessorDescriptor DownloadDatabaseOnPipelineCreation(bool? downloadDatabaseOnPipelineCreation = true) + { + DownloadDatabaseOnPipelineCreationValue = downloadDatabaseOnPipelineCreation; + return Self; + } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + public IpLocationProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + public IpLocationProcessorDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + public IpLocationProcessorDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// If true, only the first found IP location data will be returned, even if the field contains an array. + /// + /// + public IpLocationProcessorDescriptor FirstOnly(bool? firstOnly = true) + { + FirstOnlyValue = firstOnly; + return Self; + } + + /// + /// + /// Conditionally execute the processor. + /// + /// + public IpLocationProcessorDescriptor If(string? value) + { + IfValue = value; + return Self; + } + + /// + /// + /// Ignore failures for the processor. + /// + /// + public IpLocationProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) + { + IgnoreFailureValue = ignoreFailure; + return Self; + } + + /// + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// + /// + public IpLocationProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) + { + IgnoreMissingValue = ignoreMissing; + return Self; + } + + /// + /// + /// Handle failures for the processor. + /// + /// + public IpLocationProcessorDescriptor OnFailure(ICollection? onFailure) + { + OnFailureDescriptor = null; + OnFailureDescriptorAction = null; + OnFailureDescriptorActions = null; + OnFailureValue = onFailure; + return Self; + } + + public IpLocationProcessorDescriptor OnFailure(Elastic.Clients.Elasticsearch.Serverless.Ingest.ProcessorDescriptor descriptor) + { + OnFailureValue = null; + OnFailureDescriptorAction = null; + OnFailureDescriptorActions = null; + OnFailureDescriptor = descriptor; + return Self; + } + + public IpLocationProcessorDescriptor OnFailure(Action> configure) + { + OnFailureValue = null; + OnFailureDescriptor = null; + OnFailureDescriptorActions = null; + OnFailureDescriptorAction = configure; + return Self; + } + + public IpLocationProcessorDescriptor OnFailure(params Action>[] configure) + { + OnFailureValue = null; + OnFailureDescriptor = null; + OnFailureDescriptorAction = null; + OnFailureDescriptorActions = configure; + return Self; + } + + /// + /// + /// Controls what properties are added to the target_field based on the IP location lookup. + /// + /// + public IpLocationProcessorDescriptor Properties(ICollection? properties) + { + PropertiesValue = properties; + return Self; + } + + /// + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// + /// + public IpLocationProcessorDescriptor Tag(string? tag) + { + TagValue = tag; + return Self; + } + + /// + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// + public IpLocationProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) + { + TargetFieldValue = targetField; + return Self; + } + + /// + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// + public IpLocationProcessorDescriptor TargetField(Expression> targetField) + { + TargetFieldValue = targetField; + return Self; + } + + /// + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// + public IpLocationProcessorDescriptor TargetField(Expression> targetField) + { + TargetFieldValue = targetField; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(DatabaseFileValue)) + { + writer.WritePropertyName("database_file"); + writer.WriteStringValue(DatabaseFileValue); + } + + if (!string.IsNullOrEmpty(DescriptionValue)) + { + writer.WritePropertyName("description"); + writer.WriteStringValue(DescriptionValue); + } + + if (DownloadDatabaseOnPipelineCreationValue.HasValue) + { + writer.WritePropertyName("download_database_on_pipeline_creation"); + writer.WriteBooleanValue(DownloadDatabaseOnPipelineCreationValue.Value); + } + + writer.WritePropertyName("field"); + JsonSerializer.Serialize(writer, FieldValue, options); + if (FirstOnlyValue.HasValue) + { + writer.WritePropertyName("first_only"); + writer.WriteBooleanValue(FirstOnlyValue.Value); + } + + if (!string.IsNullOrEmpty(IfValue)) + { + writer.WritePropertyName("if"); + writer.WriteStringValue(IfValue); + } + + if (IgnoreFailureValue.HasValue) + { + writer.WritePropertyName("ignore_failure"); + writer.WriteBooleanValue(IgnoreFailureValue.Value); + } + + if (IgnoreMissingValue.HasValue) + { + writer.WritePropertyName("ignore_missing"); + writer.WriteBooleanValue(IgnoreMissingValue.Value); + } + + if (OnFailureDescriptor is not null) + { + writer.WritePropertyName("on_failure"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, OnFailureDescriptor, options); + writer.WriteEndArray(); + } + else if (OnFailureDescriptorAction is not null) + { + writer.WritePropertyName("on_failure"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.Ingest.ProcessorDescriptor(OnFailureDescriptorAction), options); + writer.WriteEndArray(); + } + else if (OnFailureDescriptorActions is not null) + { + writer.WritePropertyName("on_failure"); + writer.WriteStartArray(); + foreach (var action in OnFailureDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.Ingest.ProcessorDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (OnFailureValue is not null) + { + writer.WritePropertyName("on_failure"); + JsonSerializer.Serialize(writer, OnFailureValue, options); + } + + if (PropertiesValue is not null) + { + writer.WritePropertyName("properties"); + JsonSerializer.Serialize(writer, PropertiesValue, options); + } + + if (!string.IsNullOrEmpty(TagValue)) + { + writer.WritePropertyName("tag"); + writer.WriteStringValue(TagValue); + } + + if (TargetFieldValue is not null) + { + writer.WritePropertyName("target_field"); + JsonSerializer.Serialize(writer, TargetFieldValue, options); + } + + writer.WriteEndObject(); + } +} + +public sealed partial class IpLocationProcessorDescriptor : SerializableDescriptor +{ + internal IpLocationProcessorDescriptor(Action configure) => configure.Invoke(this); + + public IpLocationProcessorDescriptor() : base() + { + } + + private string? DatabaseFileValue { get; set; } + private string? DescriptionValue { get; set; } + private bool? DownloadDatabaseOnPipelineCreationValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } + private bool? FirstOnlyValue { get; set; } + private string? IfValue { get; set; } + private bool? IgnoreFailureValue { get; set; } + private bool? IgnoreMissingValue { get; set; } + private ICollection? OnFailureValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Ingest.ProcessorDescriptor OnFailureDescriptor { get; set; } + private Action OnFailureDescriptorAction { get; set; } + private Action[] OnFailureDescriptorActions { get; set; } + private ICollection? PropertiesValue { get; set; } + private string? TagValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Field? TargetFieldValue { get; set; } + + /// + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// + /// + public IpLocationProcessorDescriptor DatabaseFile(string? databaseFile) + { + DatabaseFileValue = databaseFile; + return Self; + } + + /// + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// + /// + public IpLocationProcessorDescriptor Description(string? description) + { + DescriptionValue = description; + return Self; + } + + /// + /// + /// If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. + /// Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index. + /// + /// + public IpLocationProcessorDescriptor DownloadDatabaseOnPipelineCreation(bool? downloadDatabaseOnPipelineCreation = true) + { + DownloadDatabaseOnPipelineCreationValue = downloadDatabaseOnPipelineCreation; + return Self; + } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + public IpLocationProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + public IpLocationProcessorDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + public IpLocationProcessorDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// If true, only the first found IP location data will be returned, even if the field contains an array. + /// + /// + public IpLocationProcessorDescriptor FirstOnly(bool? firstOnly = true) + { + FirstOnlyValue = firstOnly; + return Self; + } + + /// + /// + /// Conditionally execute the processor. + /// + /// + public IpLocationProcessorDescriptor If(string? value) + { + IfValue = value; + return Self; + } + + /// + /// + /// Ignore failures for the processor. + /// + /// + public IpLocationProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) + { + IgnoreFailureValue = ignoreFailure; + return Self; + } + + /// + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// + /// + public IpLocationProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) + { + IgnoreMissingValue = ignoreMissing; + return Self; + } + + /// + /// + /// Handle failures for the processor. + /// + /// + public IpLocationProcessorDescriptor OnFailure(ICollection? onFailure) + { + OnFailureDescriptor = null; + OnFailureDescriptorAction = null; + OnFailureDescriptorActions = null; + OnFailureValue = onFailure; + return Self; + } + + public IpLocationProcessorDescriptor OnFailure(Elastic.Clients.Elasticsearch.Serverless.Ingest.ProcessorDescriptor descriptor) + { + OnFailureValue = null; + OnFailureDescriptorAction = null; + OnFailureDescriptorActions = null; + OnFailureDescriptor = descriptor; + return Self; + } + + public IpLocationProcessorDescriptor OnFailure(Action configure) + { + OnFailureValue = null; + OnFailureDescriptor = null; + OnFailureDescriptorActions = null; + OnFailureDescriptorAction = configure; + return Self; + } + + public IpLocationProcessorDescriptor OnFailure(params Action[] configure) + { + OnFailureValue = null; + OnFailureDescriptor = null; + OnFailureDescriptorAction = null; + OnFailureDescriptorActions = configure; + return Self; + } + + /// + /// + /// Controls what properties are added to the target_field based on the IP location lookup. + /// + /// + public IpLocationProcessorDescriptor Properties(ICollection? properties) + { + PropertiesValue = properties; + return Self; + } + + /// + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// + /// + public IpLocationProcessorDescriptor Tag(string? tag) + { + TagValue = tag; + return Self; + } + + /// + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// + public IpLocationProcessorDescriptor TargetField(Elastic.Clients.Elasticsearch.Serverless.Field? targetField) + { + TargetFieldValue = targetField; + return Self; + } + + /// + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// + public IpLocationProcessorDescriptor TargetField(Expression> targetField) + { + TargetFieldValue = targetField; + return Self; + } + + /// + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// + public IpLocationProcessorDescriptor TargetField(Expression> targetField) + { + TargetFieldValue = targetField; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(DatabaseFileValue)) + { + writer.WritePropertyName("database_file"); + writer.WriteStringValue(DatabaseFileValue); + } + + if (!string.IsNullOrEmpty(DescriptionValue)) + { + writer.WritePropertyName("description"); + writer.WriteStringValue(DescriptionValue); + } + + if (DownloadDatabaseOnPipelineCreationValue.HasValue) + { + writer.WritePropertyName("download_database_on_pipeline_creation"); + writer.WriteBooleanValue(DownloadDatabaseOnPipelineCreationValue.Value); + } + + writer.WritePropertyName("field"); + JsonSerializer.Serialize(writer, FieldValue, options); + if (FirstOnlyValue.HasValue) + { + writer.WritePropertyName("first_only"); + writer.WriteBooleanValue(FirstOnlyValue.Value); + } + + if (!string.IsNullOrEmpty(IfValue)) + { + writer.WritePropertyName("if"); + writer.WriteStringValue(IfValue); + } + + if (IgnoreFailureValue.HasValue) + { + writer.WritePropertyName("ignore_failure"); + writer.WriteBooleanValue(IgnoreFailureValue.Value); + } + + if (IgnoreMissingValue.HasValue) + { + writer.WritePropertyName("ignore_missing"); + writer.WriteBooleanValue(IgnoreMissingValue.Value); + } + + if (OnFailureDescriptor is not null) + { + writer.WritePropertyName("on_failure"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, OnFailureDescriptor, options); + writer.WriteEndArray(); + } + else if (OnFailureDescriptorAction is not null) + { + writer.WritePropertyName("on_failure"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.Ingest.ProcessorDescriptor(OnFailureDescriptorAction), options); + writer.WriteEndArray(); + } + else if (OnFailureDescriptorActions is not null) + { + writer.WritePropertyName("on_failure"); + writer.WriteStartArray(); + foreach (var action in OnFailureDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.Ingest.ProcessorDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (OnFailureValue is not null) + { + writer.WritePropertyName("on_failure"); + JsonSerializer.Serialize(writer, OnFailureValue, options); + } + + if (PropertiesValue is not null) + { + writer.WritePropertyName("properties"); + JsonSerializer.Serialize(writer, PropertiesValue, options); + } + + if (!string.IsNullOrEmpty(TagValue)) + { + writer.WritePropertyName("tag"); + writer.WriteStringValue(TagValue); + } + + if (TargetFieldValue is not null) + { + writer.WritePropertyName("target_field"); + JsonSerializer.Serialize(writer, TargetFieldValue, options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Processor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Processor.g.cs index a9e21af186..f464444d21 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Processor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Processor.g.cs @@ -68,6 +68,7 @@ internal Processor(string variantName, object variant) public static Processor Gsub(Elastic.Clients.Elasticsearch.Serverless.Ingest.GsubProcessor gsubProcessor) => new Processor("gsub", gsubProcessor); public static Processor HtmlStrip(Elastic.Clients.Elasticsearch.Serverless.Ingest.HtmlStripProcessor htmlStripProcessor) => new Processor("html_strip", htmlStripProcessor); public static Processor Inference(Elastic.Clients.Elasticsearch.Serverless.Ingest.InferenceProcessor inferenceProcessor) => new Processor("inference", inferenceProcessor); + public static Processor IpLocation(Elastic.Clients.Elasticsearch.Serverless.Ingest.IpLocationProcessor ipLocationProcessor) => new Processor("ip_location", ipLocationProcessor); public static Processor Join(Elastic.Clients.Elasticsearch.Serverless.Ingest.JoinProcessor joinProcessor) => new Processor("join", joinProcessor); public static Processor Json(Elastic.Clients.Elasticsearch.Serverless.Ingest.JsonProcessor jsonProcessor) => new Processor("json", jsonProcessor); public static Processor Kv(Elastic.Clients.Elasticsearch.Serverless.Ingest.KeyValueProcessor keyValueProcessor) => new Processor("kv", keyValueProcessor); @@ -283,6 +284,13 @@ public override Processor Read(ref Utf8JsonReader reader, Type typeToConvert, Js continue; } + if (propertyName == "ip_location") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + if (propertyName == "join") { variantValue = JsonSerializer.Deserialize(ref reader, options); @@ -518,6 +526,9 @@ public override void Write(Utf8JsonWriter writer, Processor value, JsonSerialize case "inference": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.Ingest.InferenceProcessor)value.Variant, options); break; + case "ip_location": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.Ingest.IpLocationProcessor)value.Variant, options); + break; case "join": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.Ingest.JoinProcessor)value.Variant, options); break; @@ -666,6 +677,8 @@ private ProcessorDescriptor Set(object variant, string variantName) public ProcessorDescriptor HtmlStrip(Action> configure) => Set(configure, "html_strip"); public ProcessorDescriptor Inference(Elastic.Clients.Elasticsearch.Serverless.Ingest.InferenceProcessor inferenceProcessor) => Set(inferenceProcessor, "inference"); public ProcessorDescriptor Inference(Action> configure) => Set(configure, "inference"); + public ProcessorDescriptor IpLocation(Elastic.Clients.Elasticsearch.Serverless.Ingest.IpLocationProcessor ipLocationProcessor) => Set(ipLocationProcessor, "ip_location"); + public ProcessorDescriptor IpLocation(Action> configure) => Set(configure, "ip_location"); public ProcessorDescriptor Join(Elastic.Clients.Elasticsearch.Serverless.Ingest.JoinProcessor joinProcessor) => Set(joinProcessor, "join"); public ProcessorDescriptor Join(Action> configure) => Set(configure, "join"); public ProcessorDescriptor Json(Elastic.Clients.Elasticsearch.Serverless.Ingest.JsonProcessor jsonProcessor) => Set(jsonProcessor, "json"); @@ -806,6 +819,8 @@ private ProcessorDescriptor Set(object variant, string variantName) public ProcessorDescriptor HtmlStrip(Action configure) => Set(configure, "html_strip"); public ProcessorDescriptor Inference(Elastic.Clients.Elasticsearch.Serverless.Ingest.InferenceProcessor inferenceProcessor) => Set(inferenceProcessor, "inference"); public ProcessorDescriptor Inference(Action configure) => Set(configure, "inference"); + public ProcessorDescriptor IpLocation(Elastic.Clients.Elasticsearch.Serverless.Ingest.IpLocationProcessor ipLocationProcessor) => Set(ipLocationProcessor, "ip_location"); + public ProcessorDescriptor IpLocation(Action configure) => Set(configure, "ip_location"); public ProcessorDescriptor Join(Elastic.Clients.Elasticsearch.Serverless.Ingest.JoinProcessor joinProcessor) => Set(joinProcessor, "join"); public ProcessorDescriptor Join(Action configure) => Set(configure, "join"); public ProcessorDescriptor Json(Elastic.Clients.Elasticsearch.Serverless.Ingest.JsonProcessor jsonProcessor) => Set(jsonProcessor, "json"); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnRetriever.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnRetriever.g.cs index fb0452abfb..12e19169c8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnRetriever.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/KnnRetriever.g.cs @@ -54,6 +54,14 @@ public sealed partial class KnnRetriever [JsonInclude, JsonPropertyName("k")] public int k { get; set; } + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + [JsonInclude, JsonPropertyName("min_score")] + public float? MinScore { get; set; } + /// /// /// Number of nearest neighbor candidates to consider per shard. @@ -103,6 +111,7 @@ public KnnRetrieverDescriptor() : base() private Action> FilterDescriptorAction { get; set; } private Action>[] FilterDescriptorActions { get; set; } private int kValue { get; set; } + private float? MinScoreValue { get; set; } private int NumCandidatesValue { get; set; } private ICollection? QueryVectorValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.QueryVectorBuilder? QueryVectorBuilderValue { get; set; } @@ -173,6 +182,17 @@ public KnnRetrieverDescriptor k(int k) return Self; } + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public KnnRetrieverDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + /// /// /// Number of nearest neighbor candidates to consider per shard. @@ -271,6 +291,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WritePropertyName("k"); writer.WriteNumberValue(kValue); + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + writer.WritePropertyName("num_candidates"); writer.WriteNumberValue(NumCandidatesValue); if (QueryVectorValue is not null) @@ -319,6 +345,7 @@ public KnnRetrieverDescriptor() : base() private Action FilterDescriptorAction { get; set; } private Action[] FilterDescriptorActions { get; set; } private int kValue { get; set; } + private float? MinScoreValue { get; set; } private int NumCandidatesValue { get; set; } private ICollection? QueryVectorValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.QueryVectorBuilder? QueryVectorBuilderValue { get; set; } @@ -389,6 +416,17 @@ public KnnRetrieverDescriptor k(int k) return Self; } + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public KnnRetrieverDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + /// /// /// Number of nearest neighbor candidates to consider per shard. @@ -487,6 +525,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WritePropertyName("k"); writer.WriteNumberValue(kValue); + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + writer.WritePropertyName("num_candidates"); writer.WriteNumberValue(NumCandidatesValue); if (QueryVectorValue is not null) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/GeoShapeProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/GeoShapeProperty.g.cs index 3010b77459..4329dd0d73 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/GeoShapeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/GeoShapeProperty.g.cs @@ -32,7 +32,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Mapping; /// The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles /// and polygons. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class GeoShapeProperty : IProperty { @@ -79,7 +79,7 @@ public sealed partial class GeoShapeProperty : IProperty /// The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles /// and polygons. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class GeoShapePropertyDescriptor : SerializableDescriptor>, IBuildableDescriptor { @@ -323,7 +323,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles /// and polygons. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class GeoShapePropertyDescriptor : SerializableDescriptor, IBuildableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ShapeProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ShapeProperty.g.cs index 814616b3ad..54089be8fe 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ShapeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/ShapeProperty.g.cs @@ -32,7 +32,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Mapping; /// The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as /// rectangles and polygons. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ShapeProperty : IProperty { @@ -77,7 +77,7 @@ public sealed partial class ShapeProperty : IProperty /// The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as /// rectangles and polygons. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ShapePropertyDescriptor : SerializableDescriptor>, IBuildableDescriptor { @@ -307,7 +307,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as /// rectangles and polygons. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ShapePropertyDescriptor : SerializableDescriptor, IBuildableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/Like.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/Like.g.cs index afdf01fd76..64351880ea 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/Like.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/Like.g.cs @@ -34,7 +34,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; /// /// Text that we want similar documents for or a lookup to a document's field for the text. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class Like : Union { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/Query.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/Query.g.cs index dda17d5a3b..a4fda51359 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/Query.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/Query.g.cs @@ -28,9 +28,6 @@ namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; -/// -/// Learn more about this API in the Elasticsearch documentation. -/// [JsonConverter(typeof(QueryConverter))] public sealed partial class Query { @@ -108,8 +105,6 @@ internal Query(string variantName, object variant) public static Query Term(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermQuery termQuery) => new Query("term", termQuery); public static Query Terms(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQuery termsQuery) => new Query("terms", termsQuery); public static Query TermsSet(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsSetQuery termsSetQuery) => new Query("terms_set", termsSetQuery); - public static Query TextExpansion(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TextExpansionQuery textExpansionQuery) => new Query("text_expansion", textExpansionQuery); - public static Query WeightedTokens(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.WeightedTokensQuery weightedTokensQuery) => new Query("weighted_tokens", weightedTokensQuery); public static Query Wildcard(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.WildcardQuery wildcardQuery) => new Query("wildcard", wildcardQuery); public static Query Wrapper(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.WrapperQuery wrapperQuery) => new Query("wrapper", wrapperQuery); @@ -529,20 +524,6 @@ public override Query Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSe continue; } - if (propertyName == "text_expansion") - { - variantValue = JsonSerializer.Deserialize(ref reader, options); - variantNameValue = propertyName; - continue; - } - - if (propertyName == "weighted_tokens") - { - variantValue = JsonSerializer.Deserialize(ref reader, options); - variantNameValue = propertyName; - continue; - } - if (propertyName == "wildcard") { variantValue = JsonSerializer.Deserialize(ref reader, options); @@ -734,12 +715,6 @@ public override void Write(Utf8JsonWriter writer, Query value, JsonSerializerOpt case "terms_set": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsSetQuery)value.Variant, options); break; - case "text_expansion": - JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TextExpansionQuery)value.Variant, options); - break; - case "weighted_tokens": - JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.QueryDsl.WeightedTokensQuery)value.Variant, options); - break; case "wildcard": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.QueryDsl.WildcardQuery)value.Variant, options); break; @@ -894,10 +869,6 @@ private QueryDescriptor Set(object variant, string variantName) public QueryDescriptor Terms(Action> configure) => Set(configure, "terms"); public QueryDescriptor TermsSet(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsSetQuery termsSetQuery) => Set(termsSetQuery, "terms_set"); public QueryDescriptor TermsSet(Action> configure) => Set(configure, "terms_set"); - public QueryDescriptor TextExpansion(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TextExpansionQuery textExpansionQuery) => Set(textExpansionQuery, "text_expansion"); - public QueryDescriptor TextExpansion(Action> configure) => Set(configure, "text_expansion"); - public QueryDescriptor WeightedTokens(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.WeightedTokensQuery weightedTokensQuery) => Set(weightedTokensQuery, "weighted_tokens"); - public QueryDescriptor WeightedTokens(Action> configure) => Set(configure, "weighted_tokens"); public QueryDescriptor Wildcard(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.WildcardQuery wildcardQuery) => Set(wildcardQuery, "wildcard"); public QueryDescriptor Wildcard(Action> configure) => Set(configure, "wildcard"); public QueryDescriptor Wrapper(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.WrapperQuery wrapperQuery) => Set(wrapperQuery, "wrapper"); @@ -1064,10 +1035,6 @@ private QueryDescriptor Set(object variant, string variantName) public QueryDescriptor Terms(Action configure) => Set(configure, "terms"); public QueryDescriptor TermsSet(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsSetQuery termsSetQuery) => Set(termsSetQuery, "terms_set"); public QueryDescriptor TermsSet(Action configure) => Set(configure, "terms_set"); - public QueryDescriptor TextExpansion(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TextExpansionQuery textExpansionQuery) => Set(textExpansionQuery, "text_expansion"); - public QueryDescriptor TextExpansion(Action configure) => Set(configure, "text_expansion"); - public QueryDescriptor WeightedTokens(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.WeightedTokensQuery weightedTokensQuery) => Set(weightedTokensQuery, "weighted_tokens"); - public QueryDescriptor WeightedTokens(Action configure) => Set(configure, "weighted_tokens"); public QueryDescriptor Wildcard(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.WildcardQuery wildcardQuery) => Set(wildcardQuery, "wildcard"); public QueryDescriptor Wildcard(Action configure) => Set(configure, "wildcard"); public QueryDescriptor Wrapper(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.WrapperQuery wrapperQuery) => Set(wrapperQuery, "wrapper"); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermsQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermsQuery.g.cs index c40bc83f2b..ed80e1a50a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermsQuery.g.cs @@ -53,7 +53,7 @@ public override TermsQuery Read(ref Utf8JsonReader reader, Type typeToConvert, J variant.Field = property; reader.Read(); - variant.Term = JsonSerializer.Deserialize(ref reader, options); + variant.Terms = JsonSerializer.Deserialize(ref reader, options); } } @@ -63,7 +63,7 @@ public override TermsQuery Read(ref Utf8JsonReader reader, Type typeToConvert, J public override void Write(Utf8JsonWriter writer, TermsQuery value, JsonSerializerOptions options) { writer.WriteStartObject(); - if (value.Field is not null && value.Term is not null) + if (value.Field is not null && value.Terms is not null) { if (!options.TryGetClientSettings(out var settings)) { @@ -72,7 +72,7 @@ public override void Write(Utf8JsonWriter writer, TermsQuery value, JsonSerializ var propertyName = settings.Inferrer.Field(value.Field); writer.WritePropertyName(propertyName); - JsonSerializer.Serialize(writer, value.Term, options); + JsonSerializer.Serialize(writer, value.Terms, options); } if (value.Boost.HasValue) @@ -105,7 +105,7 @@ public sealed partial class TermsQuery public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } public string? QueryName { get; set; } - public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQueryField Term { get; set; } + public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQueryField Terms { get; set; } public static implicit operator Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query(TermsQuery termsQuery) => Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query.Terms(termsQuery); public static implicit operator Elastic.Clients.Elasticsearch.Serverless.Security.ApiKeyQuery(TermsQuery termsQuery) => Elastic.Clients.Elasticsearch.Serverless.Security.ApiKeyQuery.Terms(termsQuery); @@ -124,7 +124,7 @@ public TermsQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } private string? QueryNameValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQueryField TermValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQueryField TermsValue { get; set; } /// /// @@ -164,20 +164,20 @@ public TermsQueryDescriptor QueryName(string? queryName) return Self; } - public TermsQueryDescriptor Term(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQueryField term) + public TermsQueryDescriptor Terms(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQueryField terms) { - TermValue = term; + TermsValue = terms; return Self; } protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); - if (FieldValue is not null && TermValue is not null) + if (FieldValue is not null && TermsValue is not null) { var propertyName = settings.Inferrer.Field(FieldValue); writer.WritePropertyName(propertyName); - JsonSerializer.Serialize(writer, TermValue, options); + JsonSerializer.Serialize(writer, TermsValue, options); } if (BoostValue.HasValue) @@ -207,7 +207,7 @@ public TermsQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } private string? QueryNameValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQueryField TermValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQueryField TermsValue { get; set; } /// /// @@ -247,20 +247,20 @@ public TermsQueryDescriptor QueryName(string? queryName) return Self; } - public TermsQueryDescriptor Term(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQueryField term) + public TermsQueryDescriptor Terms(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TermsQueryField terms) { - TermValue = term; + TermsValue = terms; return Self; } protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); - if (FieldValue is not null && TermValue is not null) + if (FieldValue is not null && TermsValue is not null) { var propertyName = settings.Inferrer.Field(FieldValue); writer.WritePropertyName(propertyName); - JsonSerializer.Serialize(writer, TermValue, options); + JsonSerializer.Serialize(writer, TermsValue, options); } if (BoostValue.HasValue) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs deleted file mode 100644 index c81b812bd6..0000000000 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs +++ /dev/null @@ -1,346 +0,0 @@ -// 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.Serverless.Fluent; -using Elastic.Clients.Elasticsearch.Serverless.Serialization; -using System; -using System.Collections.Generic; -using System.Linq.Expressions; -using System.Text.Json; -using System.Text.Json.Serialization; - -namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; - -internal sealed partial class TextExpansionQueryConverter : JsonConverter -{ - public override TextExpansionQuery Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) - { - if (reader.TokenType != JsonTokenType.StartObject) - throw new JsonException("Unexpected JSON detected."); - reader.Read(); - var fieldName = reader.GetString(); - reader.Read(); - var variant = new TextExpansionQuery(fieldName); - while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) - { - if (reader.TokenType == JsonTokenType.PropertyName) - { - var property = reader.GetString(); - if (property == "boost") - { - variant.Boost = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "model_id") - { - variant.ModelId = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "model_text") - { - variant.ModelText = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "_name") - { - variant.QueryName = JsonSerializer.Deserialize(ref reader, options); - continue; - } - } - } - - reader.Read(); - return variant; - } - - public override void Write(Utf8JsonWriter writer, TextExpansionQuery value, JsonSerializerOptions options) - { - if (value.Field is null) - throw new JsonException("Unable to serialize TextExpansionQuery because the `Field` property is not set. Field name queries must include a valid field name."); - if (!options.TryGetClientSettings(out var settings)) - throw new JsonException("Unable to retrieve client settings required to infer field."); - writer.WriteStartObject(); - writer.WritePropertyName(settings.Inferrer.Field(value.Field)); - writer.WriteStartObject(); - if (value.Boost.HasValue) - { - writer.WritePropertyName("boost"); - writer.WriteNumberValue(value.Boost.Value); - } - - writer.WritePropertyName("model_id"); - writer.WriteStringValue(value.ModelId); - writer.WritePropertyName("model_text"); - writer.WriteStringValue(value.ModelText); - if (!string.IsNullOrEmpty(value.QueryName)) - { - writer.WritePropertyName("_name"); - writer.WriteStringValue(value.QueryName); - } - - writer.WriteEndObject(); - writer.WriteEndObject(); - } -} - -[JsonConverter(typeof(TextExpansionQueryConverter))] -public sealed partial class TextExpansionQuery -{ - public TextExpansionQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) - { - if (field is null) - throw new ArgumentNullException(nameof(field)); - Field = field; - } - - /// - /// - /// Floating point number used to decrease or increase the relevance scores of the query. - /// Boost values are relative to the default value of 1.0. - /// A boost value between 0 and 1.0 decreases the relevance score. - /// A value greater than 1.0 increases the relevance score. - /// - /// - public float? Boost { get; set; } - public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } - - /// - /// - /// The text expansion NLP model to use - /// - /// - public string ModelId { get; set; } - - /// - /// - /// The query text - /// - /// - public string ModelText { get; set; } - public string? QueryName { get; set; } - - public static implicit operator Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query(TextExpansionQuery textExpansionQuery) => Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query.TextExpansion(textExpansionQuery); -} - -public sealed partial class TextExpansionQueryDescriptor : SerializableDescriptor> -{ - internal TextExpansionQueryDescriptor(Action> configure) => configure.Invoke(this); - - public TextExpansionQueryDescriptor() : base() - { - } - - private float? BoostValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } - private string ModelIdValue { get; set; } - private string ModelTextValue { get; set; } - private string? QueryNameValue { get; set; } - - /// - /// - /// Floating point number used to decrease or increase the relevance scores of the query. - /// Boost values are relative to the default value of 1.0. - /// A boost value between 0 and 1.0 decreases the relevance score. - /// A value greater than 1.0 increases the relevance score. - /// - /// - public TextExpansionQueryDescriptor Boost(float? boost) - { - BoostValue = boost; - return Self; - } - - public TextExpansionQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) - { - FieldValue = field; - return Self; - } - - public TextExpansionQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - public TextExpansionQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - /// - /// - /// The text expansion NLP model to use - /// - /// - public TextExpansionQueryDescriptor ModelId(string modelId) - { - ModelIdValue = modelId; - return Self; - } - - /// - /// - /// The query text - /// - /// - public TextExpansionQueryDescriptor ModelText(string modelText) - { - ModelTextValue = modelText; - return Self; - } - - public TextExpansionQueryDescriptor QueryName(string? queryName) - { - QueryNameValue = queryName; - return Self; - } - - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) - { - if (FieldValue is null) - throw new JsonException("Unable to serialize field name query descriptor with a null field. Ensure you use a suitable descriptor constructor or call the Field method, passing a non-null value for the field argument."); - writer.WriteStartObject(); - writer.WritePropertyName(settings.Inferrer.Field(FieldValue)); - writer.WriteStartObject(); - if (BoostValue.HasValue) - { - writer.WritePropertyName("boost"); - writer.WriteNumberValue(BoostValue.Value); - } - - writer.WritePropertyName("model_id"); - writer.WriteStringValue(ModelIdValue); - writer.WritePropertyName("model_text"); - writer.WriteStringValue(ModelTextValue); - if (!string.IsNullOrEmpty(QueryNameValue)) - { - writer.WritePropertyName("_name"); - writer.WriteStringValue(QueryNameValue); - } - - writer.WriteEndObject(); - writer.WriteEndObject(); - } -} - -public sealed partial class TextExpansionQueryDescriptor : SerializableDescriptor -{ - internal TextExpansionQueryDescriptor(Action configure) => configure.Invoke(this); - - public TextExpansionQueryDescriptor() : base() - { - } - - private float? BoostValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } - private string ModelIdValue { get; set; } - private string ModelTextValue { get; set; } - private string? QueryNameValue { get; set; } - - /// - /// - /// Floating point number used to decrease or increase the relevance scores of the query. - /// Boost values are relative to the default value of 1.0. - /// A boost value between 0 and 1.0 decreases the relevance score. - /// A value greater than 1.0 increases the relevance score. - /// - /// - public TextExpansionQueryDescriptor Boost(float? boost) - { - BoostValue = boost; - return Self; - } - - public TextExpansionQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) - { - FieldValue = field; - return Self; - } - - public TextExpansionQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - public TextExpansionQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - /// - /// - /// The text expansion NLP model to use - /// - /// - public TextExpansionQueryDescriptor ModelId(string modelId) - { - ModelIdValue = modelId; - return Self; - } - - /// - /// - /// The query text - /// - /// - public TextExpansionQueryDescriptor ModelText(string modelText) - { - ModelTextValue = modelText; - return Self; - } - - public TextExpansionQueryDescriptor QueryName(string? queryName) - { - QueryNameValue = queryName; - return Self; - } - - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) - { - if (FieldValue is null) - throw new JsonException("Unable to serialize field name query descriptor with a null field. Ensure you use a suitable descriptor constructor or call the Field method, passing a non-null value for the field argument."); - writer.WriteStartObject(); - writer.WritePropertyName(settings.Inferrer.Field(FieldValue)); - writer.WriteStartObject(); - if (BoostValue.HasValue) - { - writer.WritePropertyName("boost"); - writer.WriteNumberValue(BoostValue.Value); - } - - writer.WritePropertyName("model_id"); - writer.WriteStringValue(ModelIdValue); - writer.WritePropertyName("model_text"); - writer.WriteStringValue(ModelTextValue); - if (!string.IsNullOrEmpty(QueryNameValue)) - { - writer.WritePropertyName("_name"); - writer.WriteStringValue(QueryNameValue); - } - - writer.WriteEndObject(); - writer.WriteEndObject(); - } -} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TokenPruningConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TokenPruningConfig.g.cs deleted file mode 100644 index d88690d726..0000000000 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TokenPruningConfig.g.cs +++ /dev/null @@ -1,125 +0,0 @@ -// 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.Serverless.Fluent; -using Elastic.Clients.Elasticsearch.Serverless.Serialization; -using System; -using System.Collections.Generic; -using System.Linq.Expressions; -using System.Text.Json; -using System.Text.Json.Serialization; - -namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; - -public sealed partial class TokenPruningConfig -{ - /// - /// - /// Whether to only score pruned tokens, vs only scoring kept tokens. - /// - /// - [JsonInclude, JsonPropertyName("only_score_pruned_tokens")] - public bool? OnlyScorePrunedTokens { get; set; } - - /// - /// - /// Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. - /// - /// - [JsonInclude, JsonPropertyName("tokens_freq_ratio_threshold")] - public int? TokensFreqRatioThreshold { get; set; } - - /// - /// - /// Tokens whose weight is less than this threshold are considered nonsignificant and pruned. - /// - /// - [JsonInclude, JsonPropertyName("tokens_weight_threshold")] - public float? TokensWeightThreshold { get; set; } -} - -public sealed partial class TokenPruningConfigDescriptor : SerializableDescriptor -{ - internal TokenPruningConfigDescriptor(Action configure) => configure.Invoke(this); - - public TokenPruningConfigDescriptor() : base() - { - } - - private bool? OnlyScorePrunedTokensValue { get; set; } - private int? TokensFreqRatioThresholdValue { get; set; } - private float? TokensWeightThresholdValue { get; set; } - - /// - /// - /// Whether to only score pruned tokens, vs only scoring kept tokens. - /// - /// - public TokenPruningConfigDescriptor OnlyScorePrunedTokens(bool? onlyScorePrunedTokens = true) - { - OnlyScorePrunedTokensValue = onlyScorePrunedTokens; - return Self; - } - - /// - /// - /// Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. - /// - /// - public TokenPruningConfigDescriptor TokensFreqRatioThreshold(int? tokensFreqRatioThreshold) - { - TokensFreqRatioThresholdValue = tokensFreqRatioThreshold; - return Self; - } - - /// - /// - /// Tokens whose weight is less than this threshold are considered nonsignificant and pruned. - /// - /// - public TokenPruningConfigDescriptor TokensWeightThreshold(float? tokensWeightThreshold) - { - TokensWeightThresholdValue = tokensWeightThreshold; - return Self; - } - - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) - { - writer.WriteStartObject(); - if (OnlyScorePrunedTokensValue.HasValue) - { - writer.WritePropertyName("only_score_pruned_tokens"); - writer.WriteBooleanValue(OnlyScorePrunedTokensValue.Value); - } - - if (TokensFreqRatioThresholdValue.HasValue) - { - writer.WritePropertyName("tokens_freq_ratio_threshold"); - writer.WriteNumberValue(TokensFreqRatioThresholdValue.Value); - } - - if (TokensWeightThresholdValue.HasValue) - { - writer.WritePropertyName("tokens_weight_threshold"); - writer.WriteNumberValue(TokensWeightThresholdValue.Value); - } - - writer.WriteEndObject(); - } -} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs deleted file mode 100644 index 7a6599a9d2..0000000000 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs +++ /dev/null @@ -1,418 +0,0 @@ -// 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.Serverless.Fluent; -using Elastic.Clients.Elasticsearch.Serverless.Serialization; -using System; -using System.Collections.Generic; -using System.Linq.Expressions; -using System.Text.Json; -using System.Text.Json.Serialization; - -namespace Elastic.Clients.Elasticsearch.Serverless.QueryDsl; - -internal sealed partial class WeightedTokensQueryConverter : JsonConverter -{ - public override WeightedTokensQuery Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) - { - if (reader.TokenType != JsonTokenType.StartObject) - throw new JsonException("Unexpected JSON detected."); - reader.Read(); - var fieldName = reader.GetString(); - reader.Read(); - var variant = new WeightedTokensQuery(fieldName); - while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) - { - if (reader.TokenType == JsonTokenType.PropertyName) - { - var property = reader.GetString(); - if (property == "boost") - { - variant.Boost = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "pruning_config") - { - variant.PruningConfig = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "_name") - { - variant.QueryName = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "tokens") - { - variant.Tokens = JsonSerializer.Deserialize>(ref reader, options); - continue; - } - } - } - - reader.Read(); - return variant; - } - - public override void Write(Utf8JsonWriter writer, WeightedTokensQuery value, JsonSerializerOptions options) - { - if (value.Field is null) - throw new JsonException("Unable to serialize WeightedTokensQuery because the `Field` property is not set. Field name queries must include a valid field name."); - if (!options.TryGetClientSettings(out var settings)) - throw new JsonException("Unable to retrieve client settings required to infer field."); - writer.WriteStartObject(); - writer.WritePropertyName(settings.Inferrer.Field(value.Field)); - writer.WriteStartObject(); - if (value.Boost.HasValue) - { - writer.WritePropertyName("boost"); - writer.WriteNumberValue(value.Boost.Value); - } - - if (value.PruningConfig is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, value.PruningConfig, options); - } - - if (!string.IsNullOrEmpty(value.QueryName)) - { - writer.WritePropertyName("_name"); - writer.WriteStringValue(value.QueryName); - } - - writer.WritePropertyName("tokens"); - JsonSerializer.Serialize(writer, value.Tokens, options); - writer.WriteEndObject(); - writer.WriteEndObject(); - } -} - -[JsonConverter(typeof(WeightedTokensQueryConverter))] -public sealed partial class WeightedTokensQuery -{ - public WeightedTokensQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) - { - if (field is null) - throw new ArgumentNullException(nameof(field)); - Field = field; - } - - /// - /// - /// Floating point number used to decrease or increase the relevance scores of the query. - /// Boost values are relative to the default value of 1.0. - /// A boost value between 0 and 1.0 decreases the relevance score. - /// A value greater than 1.0 increases the relevance score. - /// - /// - public float? Boost { get; set; } - public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } - - /// - /// - /// Token pruning configurations - /// - /// - public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfig? PruningConfig { get; set; } - public string? QueryName { get; set; } - - /// - /// - /// The tokens representing this query - /// - /// - public IDictionary Tokens { get; set; } - - public static implicit operator Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query(WeightedTokensQuery weightedTokensQuery) => Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query.WeightedTokens(weightedTokensQuery); -} - -public sealed partial class WeightedTokensQueryDescriptor : SerializableDescriptor> -{ - internal WeightedTokensQueryDescriptor(Action> configure) => configure.Invoke(this); - - public WeightedTokensQueryDescriptor() : base() - { - } - - private float? BoostValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfig? PruningConfigValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfigDescriptor PruningConfigDescriptor { get; set; } - private Action PruningConfigDescriptorAction { get; set; } - private string? QueryNameValue { get; set; } - private IDictionary TokensValue { get; set; } - - /// - /// - /// Floating point number used to decrease or increase the relevance scores of the query. - /// Boost values are relative to the default value of 1.0. - /// A boost value between 0 and 1.0 decreases the relevance score. - /// A value greater than 1.0 increases the relevance score. - /// - /// - public WeightedTokensQueryDescriptor Boost(float? boost) - { - BoostValue = boost; - return Self; - } - - public WeightedTokensQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) - { - FieldValue = field; - return Self; - } - - public WeightedTokensQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - public WeightedTokensQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - /// - /// - /// Token pruning configurations - /// - /// - public WeightedTokensQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfig? pruningConfig) - { - PruningConfigDescriptor = null; - PruningConfigDescriptorAction = null; - PruningConfigValue = pruningConfig; - return Self; - } - - public WeightedTokensQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfigDescriptor descriptor) - { - PruningConfigValue = null; - PruningConfigDescriptorAction = null; - PruningConfigDescriptor = descriptor; - return Self; - } - - public WeightedTokensQueryDescriptor PruningConfig(Action configure) - { - PruningConfigValue = null; - PruningConfigDescriptor = null; - PruningConfigDescriptorAction = configure; - return Self; - } - - public WeightedTokensQueryDescriptor QueryName(string? queryName) - { - QueryNameValue = queryName; - return Self; - } - - /// - /// - /// The tokens representing this query - /// - /// - public WeightedTokensQueryDescriptor Tokens(Func, FluentDictionary> selector) - { - TokensValue = selector?.Invoke(new FluentDictionary()); - return Self; - } - - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) - { - if (FieldValue is null) - throw new JsonException("Unable to serialize field name query descriptor with a null field. Ensure you use a suitable descriptor constructor or call the Field method, passing a non-null value for the field argument."); - writer.WriteStartObject(); - writer.WritePropertyName(settings.Inferrer.Field(FieldValue)); - writer.WriteStartObject(); - if (BoostValue.HasValue) - { - writer.WritePropertyName("boost"); - writer.WriteNumberValue(BoostValue.Value); - } - - if (PruningConfigDescriptor is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, PruningConfigDescriptor, options); - } - else if (PruningConfigDescriptorAction is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfigDescriptor(PruningConfigDescriptorAction), options); - } - else if (PruningConfigValue is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, PruningConfigValue, options); - } - - if (!string.IsNullOrEmpty(QueryNameValue)) - { - writer.WritePropertyName("_name"); - writer.WriteStringValue(QueryNameValue); - } - - writer.WritePropertyName("tokens"); - JsonSerializer.Serialize(writer, TokensValue, options); - writer.WriteEndObject(); - writer.WriteEndObject(); - } -} - -public sealed partial class WeightedTokensQueryDescriptor : SerializableDescriptor -{ - internal WeightedTokensQueryDescriptor(Action configure) => configure.Invoke(this); - - public WeightedTokensQueryDescriptor() : base() - { - } - - private float? BoostValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfig? PruningConfigValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfigDescriptor PruningConfigDescriptor { get; set; } - private Action PruningConfigDescriptorAction { get; set; } - private string? QueryNameValue { get; set; } - private IDictionary TokensValue { get; set; } - - /// - /// - /// Floating point number used to decrease or increase the relevance scores of the query. - /// Boost values are relative to the default value of 1.0. - /// A boost value between 0 and 1.0 decreases the relevance score. - /// A value greater than 1.0 increases the relevance score. - /// - /// - public WeightedTokensQueryDescriptor Boost(float? boost) - { - BoostValue = boost; - return Self; - } - - public WeightedTokensQueryDescriptor Field(Elastic.Clients.Elasticsearch.Serverless.Field field) - { - FieldValue = field; - return Self; - } - - public WeightedTokensQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - public WeightedTokensQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - /// - /// - /// Token pruning configurations - /// - /// - public WeightedTokensQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfig? pruningConfig) - { - PruningConfigDescriptor = null; - PruningConfigDescriptorAction = null; - PruningConfigValue = pruningConfig; - return Self; - } - - public WeightedTokensQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfigDescriptor descriptor) - { - PruningConfigValue = null; - PruningConfigDescriptorAction = null; - PruningConfigDescriptor = descriptor; - return Self; - } - - public WeightedTokensQueryDescriptor PruningConfig(Action configure) - { - PruningConfigValue = null; - PruningConfigDescriptor = null; - PruningConfigDescriptorAction = configure; - return Self; - } - - public WeightedTokensQueryDescriptor QueryName(string? queryName) - { - QueryNameValue = queryName; - return Self; - } - - /// - /// - /// The tokens representing this query - /// - /// - public WeightedTokensQueryDescriptor Tokens(Func, FluentDictionary> selector) - { - TokensValue = selector?.Invoke(new FluentDictionary()); - return Self; - } - - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) - { - if (FieldValue is null) - throw new JsonException("Unable to serialize field name query descriptor with a null field. Ensure you use a suitable descriptor constructor or call the Field method, passing a non-null value for the field argument."); - writer.WriteStartObject(); - writer.WritePropertyName(settings.Inferrer.Field(FieldValue)); - writer.WriteStartObject(); - if (BoostValue.HasValue) - { - writer.WritePropertyName("boost"); - writer.WriteNumberValue(BoostValue.Value); - } - - if (PruningConfigDescriptor is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, PruningConfigDescriptor, options); - } - else if (PruningConfigDescriptorAction is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.QueryDsl.TokenPruningConfigDescriptor(PruningConfigDescriptorAction), options); - } - else if (PruningConfigValue is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, PruningConfigValue, options); - } - - if (!string.IsNullOrEmpty(QueryNameValue)) - { - writer.WritePropertyName("_name"); - writer.WriteStringValue(QueryNameValue); - } - - writer.WritePropertyName("tokens"); - JsonSerializer.Serialize(writer, TokensValue, options); - writer.WriteEndObject(); - writer.WriteEndObject(); - } -} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryRules/QueryRulesetMatchedRule.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryRules/QueryRulesetMatchedRule.g.cs new file mode 100644 index 0000000000..1cd9ee2fac --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryRules/QueryRulesetMatchedRule.g.cs @@ -0,0 +1,47 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.QueryRules; + +public sealed partial class QueryRulesetMatchedRule +{ + /// + /// + /// Rule unique identifier within that ruleset + /// + /// + [JsonInclude, JsonPropertyName("rule_id")] + public string RuleId { get; init; } + + /// + /// + /// Ruleset unique identifier + /// + /// + [JsonInclude, JsonPropertyName("ruleset_id")] + public string RulesetId { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RRFRetriever.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RRFRetriever.g.cs index 574be5754e..100f1f40cc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RRFRetriever.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RRFRetriever.g.cs @@ -38,6 +38,14 @@ public sealed partial class RRFRetriever [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] public ICollection? Filter { get; set; } + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + [JsonInclude, JsonPropertyName("min_score")] + public float? MinScore { get; set; } + /// /// /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. @@ -77,6 +85,7 @@ public RRFRetrieverDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor FilterDescriptor { get; set; } private Action> FilterDescriptorAction { get; set; } private Action>[] FilterDescriptorActions { get; set; } + private float? MinScoreValue { get; set; } private int? RankConstantValue { get; set; } private int? RankWindowSizeValue { get; set; } private ICollection RetrieversValue { get; set; } @@ -125,6 +134,17 @@ public RRFRetrieverDescriptor Filter(params Action + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public RRFRetrieverDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + /// /// /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. @@ -220,6 +240,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o SingleOrManySerializationHelper.Serialize(FilterValue, writer, options); } + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + if (RankConstantValue.HasValue) { writer.WritePropertyName("rank_constant"); @@ -279,6 +305,7 @@ public RRFRetrieverDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor FilterDescriptor { get; set; } private Action FilterDescriptorAction { get; set; } private Action[] FilterDescriptorActions { get; set; } + private float? MinScoreValue { get; set; } private int? RankConstantValue { get; set; } private int? RankWindowSizeValue { get; set; } private ICollection RetrieversValue { get; set; } @@ -327,6 +354,17 @@ public RRFRetrieverDescriptor Filter(params Action + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public RRFRetrieverDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + /// /// /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. @@ -422,6 +460,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o SingleOrManySerializationHelper.Serialize(FilterValue, writer, options); } + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + if (RankConstantValue.HasValue) { writer.WritePropertyName("rank_constant"); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Retriever.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Retriever.g.cs index 3c887d29e8..f6ba60c827 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Retriever.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Retriever.g.cs @@ -48,7 +48,9 @@ internal Retriever(string variantName, object variant) public static Retriever Knn(Elastic.Clients.Elasticsearch.Serverless.KnnRetriever knnRetriever) => new Retriever("knn", knnRetriever); public static Retriever Rrf(Elastic.Clients.Elasticsearch.Serverless.RRFRetriever rRFRetriever) => new Retriever("rrf", rRFRetriever); + public static Retriever Rule(Elastic.Clients.Elasticsearch.Serverless.RuleRetriever ruleRetriever) => new Retriever("rule", ruleRetriever); public static Retriever Standard(Elastic.Clients.Elasticsearch.Serverless.StandardRetriever standardRetriever) => new Retriever("standard", standardRetriever); + public static Retriever TextSimilarityReranker(Elastic.Clients.Elasticsearch.Serverless.TextSimilarityReranker textSimilarityReranker) => new Retriever("text_similarity_reranker", textSimilarityReranker); public bool TryGet([NotNullWhen(true)] out T? result) where T : class { @@ -102,6 +104,13 @@ public override Retriever Read(ref Utf8JsonReader reader, Type typeToConvert, Js continue; } + if (propertyName == "rule") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + if (propertyName == "standard") { variantValue = JsonSerializer.Deserialize(ref reader, options); @@ -109,6 +118,13 @@ public override Retriever Read(ref Utf8JsonReader reader, Type typeToConvert, Js continue; } + if (propertyName == "text_similarity_reranker") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + throw new JsonException($"Unknown property name '{propertyName}' received while deserializing the 'Retriever' from the response."); } @@ -130,9 +146,15 @@ public override void Write(Utf8JsonWriter writer, Retriever value, JsonSerialize case "rrf": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.RRFRetriever)value.Variant, options); break; + case "rule": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.RuleRetriever)value.Variant, options); + break; case "standard": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.StandardRetriever)value.Variant, options); break; + case "text_similarity_reranker": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.TextSimilarityReranker)value.Variant, options); + break; } } @@ -175,8 +197,12 @@ private RetrieverDescriptor Set(object variant, string variantName) public RetrieverDescriptor Knn(Action> configure) => Set(configure, "knn"); public RetrieverDescriptor Rrf(Elastic.Clients.Elasticsearch.Serverless.RRFRetriever rRFRetriever) => Set(rRFRetriever, "rrf"); public RetrieverDescriptor Rrf(Action> configure) => Set(configure, "rrf"); + public RetrieverDescriptor Rule(Elastic.Clients.Elasticsearch.Serverless.RuleRetriever ruleRetriever) => Set(ruleRetriever, "rule"); + public RetrieverDescriptor Rule(Action> configure) => Set(configure, "rule"); public RetrieverDescriptor Standard(Elastic.Clients.Elasticsearch.Serverless.StandardRetriever standardRetriever) => Set(standardRetriever, "standard"); public RetrieverDescriptor Standard(Action> configure) => Set(configure, "standard"); + public RetrieverDescriptor TextSimilarityReranker(Elastic.Clients.Elasticsearch.Serverless.TextSimilarityReranker textSimilarityReranker) => Set(textSimilarityReranker, "text_similarity_reranker"); + public RetrieverDescriptor TextSimilarityReranker(Action> configure) => Set(configure, "text_similarity_reranker"); protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { @@ -233,8 +259,12 @@ private RetrieverDescriptor Set(object variant, string variantName) public RetrieverDescriptor Knn(Action configure) => Set(configure, "knn"); public RetrieverDescriptor Rrf(Elastic.Clients.Elasticsearch.Serverless.RRFRetriever rRFRetriever) => Set(rRFRetriever, "rrf"); public RetrieverDescriptor Rrf(Action configure) => Set(configure, "rrf"); + public RetrieverDescriptor Rule(Elastic.Clients.Elasticsearch.Serverless.RuleRetriever ruleRetriever) => Set(ruleRetriever, "rule"); + public RetrieverDescriptor Rule(Action configure) => Set(configure, "rule"); public RetrieverDescriptor Standard(Elastic.Clients.Elasticsearch.Serverless.StandardRetriever standardRetriever) => Set(standardRetriever, "standard"); public RetrieverDescriptor Standard(Action configure) => Set(configure, "standard"); + public RetrieverDescriptor TextSimilarityReranker(Elastic.Clients.Elasticsearch.Serverless.TextSimilarityReranker textSimilarityReranker) => Set(textSimilarityReranker, "text_similarity_reranker"); + public RetrieverDescriptor TextSimilarityReranker(Action configure) => Set(configure, "text_similarity_reranker"); protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RuleRetriever.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RuleRetriever.g.cs new file mode 100644 index 0000000000..d4b7c4c087 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/RuleRetriever.g.cs @@ -0,0 +1,486 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless; + +public sealed partial class RuleRetriever +{ + /// + /// + /// Query to filter the documents that can match. + /// + /// + [JsonInclude, JsonPropertyName("filter")] + [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] + public ICollection? Filter { get; set; } + + /// + /// + /// The match criteria that will determine if a rule in the provided rulesets should be applied. + /// + /// + [JsonInclude, JsonPropertyName("match_criteria")] + public object MatchCriteria { get; set; } + + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + [JsonInclude, JsonPropertyName("min_score")] + public float? MinScore { get; set; } + + /// + /// + /// This value determines the size of the individual result set. + /// + /// + [JsonInclude, JsonPropertyName("rank_window_size")] + public int? RankWindowSize { get; set; } + + /// + /// + /// The retriever whose results rules should be applied to. + /// + /// + [JsonInclude, JsonPropertyName("retriever")] + public Elastic.Clients.Elasticsearch.Serverless.Retriever Retriever { get; set; } + + /// + /// + /// The ruleset IDs containing the rules this retriever is evaluating against. + /// + /// + [JsonInclude, JsonPropertyName("ruleset_ids")] + public ICollection RulesetIds { get; set; } + + public static implicit operator Elastic.Clients.Elasticsearch.Serverless.Retriever(RuleRetriever ruleRetriever) => Elastic.Clients.Elasticsearch.Serverless.Retriever.Rule(ruleRetriever); +} + +public sealed partial class RuleRetrieverDescriptor : SerializableDescriptor> +{ + internal RuleRetrieverDescriptor(Action> configure) => configure.Invoke(this); + + public RuleRetrieverDescriptor() : base() + { + } + + private ICollection? FilterValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor FilterDescriptor { get; set; } + private Action> FilterDescriptorAction { get; set; } + private Action>[] FilterDescriptorActions { get; set; } + private object MatchCriteriaValue { get; set; } + private float? MinScoreValue { get; set; } + private int? RankWindowSizeValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Retriever RetrieverValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.RetrieverDescriptor RetrieverDescriptor { get; set; } + private Action> RetrieverDescriptorAction { get; set; } + private ICollection RulesetIdsValue { get; set; } + + /// + /// + /// Query to filter the documents that can match. + /// + /// + public RuleRetrieverDescriptor Filter(ICollection? filter) + { + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterValue = filter; + return Self; + } + + public RuleRetrieverDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor descriptor) + { + FilterValue = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterDescriptor = descriptor; + return Self; + } + + public RuleRetrieverDescriptor Filter(Action> configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorActions = null; + FilterDescriptorAction = configure; + return Self; + } + + public RuleRetrieverDescriptor Filter(params Action>[] configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = configure; + return Self; + } + + /// + /// + /// The match criteria that will determine if a rule in the provided rulesets should be applied. + /// + /// + public RuleRetrieverDescriptor MatchCriteria(object matchCriteria) + { + MatchCriteriaValue = matchCriteria; + return Self; + } + + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public RuleRetrieverDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + + /// + /// + /// This value determines the size of the individual result set. + /// + /// + public RuleRetrieverDescriptor RankWindowSize(int? rankWindowSize) + { + RankWindowSizeValue = rankWindowSize; + return Self; + } + + /// + /// + /// The retriever whose results rules should be applied to. + /// + /// + public RuleRetrieverDescriptor Retriever(Elastic.Clients.Elasticsearch.Serverless.Retriever retriever) + { + RetrieverDescriptor = null; + RetrieverDescriptorAction = null; + RetrieverValue = retriever; + return Self; + } + + public RuleRetrieverDescriptor Retriever(Elastic.Clients.Elasticsearch.Serverless.RetrieverDescriptor descriptor) + { + RetrieverValue = null; + RetrieverDescriptorAction = null; + RetrieverDescriptor = descriptor; + return Self; + } + + public RuleRetrieverDescriptor Retriever(Action> configure) + { + RetrieverValue = null; + RetrieverDescriptor = null; + RetrieverDescriptorAction = configure; + return Self; + } + + /// + /// + /// The ruleset IDs containing the rules this retriever is evaluating against. + /// + /// + public RuleRetrieverDescriptor RulesetIds(ICollection rulesetIds) + { + RulesetIdsValue = rulesetIds; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (FilterDescriptor is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, FilterDescriptor, options); + } + else if (FilterDescriptorAction is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor(FilterDescriptorAction), options); + } + else if (FilterDescriptorActions is not null) + { + writer.WritePropertyName("filter"); + if (FilterDescriptorActions.Length != 1) + writer.WriteStartArray(); + foreach (var action in FilterDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor(action), options); + } + + if (FilterDescriptorActions.Length != 1) + writer.WriteEndArray(); + } + else if (FilterValue is not null) + { + writer.WritePropertyName("filter"); + SingleOrManySerializationHelper.Serialize(FilterValue, writer, options); + } + + writer.WritePropertyName("match_criteria"); + JsonSerializer.Serialize(writer, MatchCriteriaValue, options); + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + + if (RankWindowSizeValue.HasValue) + { + writer.WritePropertyName("rank_window_size"); + writer.WriteNumberValue(RankWindowSizeValue.Value); + } + + if (RetrieverDescriptor is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverDescriptor, options); + } + else if (RetrieverDescriptorAction is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.RetrieverDescriptor(RetrieverDescriptorAction), options); + } + else + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverValue, options); + } + + writer.WritePropertyName("ruleset_ids"); + JsonSerializer.Serialize(writer, RulesetIdsValue, options); + writer.WriteEndObject(); + } +} + +public sealed partial class RuleRetrieverDescriptor : SerializableDescriptor +{ + internal RuleRetrieverDescriptor(Action configure) => configure.Invoke(this); + + public RuleRetrieverDescriptor() : base() + { + } + + private ICollection? FilterValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor FilterDescriptor { get; set; } + private Action FilterDescriptorAction { get; set; } + private Action[] FilterDescriptorActions { get; set; } + private object MatchCriteriaValue { get; set; } + private float? MinScoreValue { get; set; } + private int? RankWindowSizeValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Retriever RetrieverValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.RetrieverDescriptor RetrieverDescriptor { get; set; } + private Action RetrieverDescriptorAction { get; set; } + private ICollection RulesetIdsValue { get; set; } + + /// + /// + /// Query to filter the documents that can match. + /// + /// + public RuleRetrieverDescriptor Filter(ICollection? filter) + { + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterValue = filter; + return Self; + } + + public RuleRetrieverDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor descriptor) + { + FilterValue = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterDescriptor = descriptor; + return Self; + } + + public RuleRetrieverDescriptor Filter(Action configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorActions = null; + FilterDescriptorAction = configure; + return Self; + } + + public RuleRetrieverDescriptor Filter(params Action[] configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = configure; + return Self; + } + + /// + /// + /// The match criteria that will determine if a rule in the provided rulesets should be applied. + /// + /// + public RuleRetrieverDescriptor MatchCriteria(object matchCriteria) + { + MatchCriteriaValue = matchCriteria; + return Self; + } + + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public RuleRetrieverDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + + /// + /// + /// This value determines the size of the individual result set. + /// + /// + public RuleRetrieverDescriptor RankWindowSize(int? rankWindowSize) + { + RankWindowSizeValue = rankWindowSize; + return Self; + } + + /// + /// + /// The retriever whose results rules should be applied to. + /// + /// + public RuleRetrieverDescriptor Retriever(Elastic.Clients.Elasticsearch.Serverless.Retriever retriever) + { + RetrieverDescriptor = null; + RetrieverDescriptorAction = null; + RetrieverValue = retriever; + return Self; + } + + public RuleRetrieverDescriptor Retriever(Elastic.Clients.Elasticsearch.Serverless.RetrieverDescriptor descriptor) + { + RetrieverValue = null; + RetrieverDescriptorAction = null; + RetrieverDescriptor = descriptor; + return Self; + } + + public RuleRetrieverDescriptor Retriever(Action configure) + { + RetrieverValue = null; + RetrieverDescriptor = null; + RetrieverDescriptorAction = configure; + return Self; + } + + /// + /// + /// The ruleset IDs containing the rules this retriever is evaluating against. + /// + /// + public RuleRetrieverDescriptor RulesetIds(ICollection rulesetIds) + { + RulesetIdsValue = rulesetIds; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (FilterDescriptor is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, FilterDescriptor, options); + } + else if (FilterDescriptorAction is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor(FilterDescriptorAction), options); + } + else if (FilterDescriptorActions is not null) + { + writer.WritePropertyName("filter"); + if (FilterDescriptorActions.Length != 1) + writer.WriteStartArray(); + foreach (var action in FilterDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor(action), options); + } + + if (FilterDescriptorActions.Length != 1) + writer.WriteEndArray(); + } + else if (FilterValue is not null) + { + writer.WritePropertyName("filter"); + SingleOrManySerializationHelper.Serialize(FilterValue, writer, options); + } + + writer.WritePropertyName("match_criteria"); + JsonSerializer.Serialize(writer, MatchCriteriaValue, options); + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + + if (RankWindowSizeValue.HasValue) + { + writer.WritePropertyName("rank_window_size"); + writer.WriteNumberValue(RankWindowSizeValue.Value); + } + + if (RetrieverDescriptor is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverDescriptor, options); + } + else if (RetrieverDescriptorAction is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.RetrieverDescriptor(RetrieverDescriptorAction), options); + } + else + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverValue, options); + } + + writer.WritePropertyName("ruleset_ids"); + JsonSerializer.Serialize(writer, RulesetIdsValue, options); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/IndicesPrivileges.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/IndicesPrivileges.g.cs index 8bf956852f..45feac6f03 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/IndicesPrivileges.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/IndicesPrivileges.g.cs @@ -43,6 +43,7 @@ public sealed partial class IndicesPrivileges /// /// [JsonInclude, JsonPropertyName("names")] + [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.IndexName))] public ICollection Names { get; set; } /// @@ -159,7 +160,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } writer.WritePropertyName("names"); - JsonSerializer.Serialize(writer, NamesValue, options); + SingleOrManySerializationHelper.Serialize(NamesValue, writer, options); writer.WritePropertyName("privileges"); JsonSerializer.Serialize(writer, PrivilegesValue, options); if (QueryValue is not null) @@ -269,7 +270,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } writer.WritePropertyName("names"); - JsonSerializer.Serialize(writer, NamesValue, options); + SingleOrManySerializationHelper.Serialize(NamesValue, writer, options); writer.WritePropertyName("privileges"); JsonSerializer.Serialize(writer, PrivilegesValue, options); if (QueryValue is not null) diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/QueryRole.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/QueryRole.g.cs index 1d0d895ca5..2c717cdc12 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/QueryRole.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/QueryRole.g.cs @@ -39,6 +39,7 @@ public override QueryRole Read(ref Utf8JsonReader reader, Type typeToConvert, Js IReadOnlyCollection? indices = default; IReadOnlyDictionary? metadata = default; string name = default; + Elastic.Clients.Elasticsearch.Serverless.Security.Restriction? restriction = default; IReadOnlyCollection? runAs = default; IReadOnlyCollection? sort = default; IReadOnlyDictionary? transientMetadata = default; @@ -83,6 +84,12 @@ public override QueryRole Read(ref Utf8JsonReader reader, Type typeToConvert, Js continue; } + if (property == "restriction") + { + restriction = JsonSerializer.Deserialize(ref reader, options); + continue; + } + if (property == "run_as") { runAs = JsonSerializer.Deserialize?>(ref reader, options); @@ -103,7 +110,7 @@ public override QueryRole Read(ref Utf8JsonReader reader, Type typeToConvert, Js } } - return new QueryRole { Applications = applications, Cluster = cluster, Description = description, Indices = indices, Metadata = metadata, Name = name, RunAs = runAs, Sort = sort, TransientMetadata = transientMetadata }; + return new QueryRole { Applications = applications, Cluster = cluster, Description = description, Indices = indices, Metadata = metadata, Name = name, Restriction = restriction, RunAs = runAs, Sort = sort, TransientMetadata = transientMetadata }; } public override void Write(Utf8JsonWriter writer, QueryRole value, JsonSerializerOptions options) @@ -157,6 +164,13 @@ public sealed partial class QueryRole /// public string Name { get; init; } + /// + /// + /// Restriction for when the role descriptor is allowed to be effective. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Security.Restriction? Restriction { get; init; } + /// /// /// A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected. diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/Restriction.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/Restriction.g.cs new file mode 100644 index 0000000000..0058fc7d32 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/Restriction.g.cs @@ -0,0 +1,59 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Security; + +public sealed partial class Restriction +{ + [JsonInclude, JsonPropertyName("workflows")] + public ICollection Workflows { get; set; } +} + +public sealed partial class RestrictionDescriptor : SerializableDescriptor +{ + internal RestrictionDescriptor(Action configure) => configure.Invoke(this); + + public RestrictionDescriptor() : base() + { + } + + private ICollection WorkflowsValue { get; set; } + + public RestrictionDescriptor Workflows(ICollection workflows) + { + WorkflowsValue = workflows; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("workflows"); + JsonSerializer.Serialize(writer, WorkflowsValue, options); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/Role.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/Role.g.cs index f78d20713c..96d69e55dd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/Role.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/Role.g.cs @@ -32,7 +32,7 @@ public sealed partial class Role [JsonInclude, JsonPropertyName("applications")] public IReadOnlyCollection Applications { get; init; } [JsonInclude, JsonPropertyName("cluster")] - public IReadOnlyCollection Cluster { get; init; } + public IReadOnlyCollection Cluster { get; init; } [JsonInclude, JsonPropertyName("global")] public IReadOnlyDictionary>>>? Global { get; init; } [JsonInclude, JsonPropertyName("indices")] diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/RoleDescriptor.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/RoleDescriptor.g.cs index 237f24160f..d12ecb7310 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/RoleDescriptor.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/RoleDescriptor.g.cs @@ -69,6 +69,12 @@ public override RoleDescriptor Read(ref Utf8JsonReader reader, Type typeToConver continue; } + if (property == "restriction") + { + variant.Restriction = JsonSerializer.Deserialize(ref reader, options); + continue; + } + if (property == "run_as") { variant.RunAs = JsonSerializer.Deserialize?>(ref reader, options); @@ -119,6 +125,12 @@ public override void Write(Utf8JsonWriter writer, RoleDescriptor value, JsonSeri JsonSerializer.Serialize(writer, value.Metadata, options); } + if (value.Restriction is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, value.Restriction, options); + } + if (value.RunAs is not null) { writer.WritePropertyName("run_as"); @@ -173,6 +185,13 @@ public sealed partial class RoleDescriptor /// public IDictionary? Metadata { get; set; } + /// + /// + /// Restriction for when the role descriptor is allowed to be effective. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Security.Restriction? Restriction { get; set; } + /// /// /// A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected. @@ -201,6 +220,9 @@ public RoleDescriptorDescriptor() : base() private Action> IndicesDescriptorAction { get; set; } private Action>[] IndicesDescriptorActions { get; set; } private IDictionary? MetadataValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Security.Restriction? RestrictionValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Security.RestrictionDescriptor RestrictionDescriptor { get; set; } + private Action RestrictionDescriptorAction { get; set; } private ICollection? RunAsValue { get; set; } private IDictionary? TransientMetadataValue { get; set; } @@ -319,6 +341,35 @@ public RoleDescriptorDescriptor Metadata(Func + /// + /// Restriction for when the role descriptor is allowed to be effective. + /// + /// + public RoleDescriptorDescriptor Restriction(Elastic.Clients.Elasticsearch.Serverless.Security.Restriction? restriction) + { + RestrictionDescriptor = null; + RestrictionDescriptorAction = null; + RestrictionValue = restriction; + return Self; + } + + public RoleDescriptorDescriptor Restriction(Elastic.Clients.Elasticsearch.Serverless.Security.RestrictionDescriptor descriptor) + { + RestrictionValue = null; + RestrictionDescriptorAction = null; + RestrictionDescriptor = descriptor; + return Self; + } + + public RoleDescriptorDescriptor Restriction(Action configure) + { + RestrictionValue = null; + RestrictionDescriptor = null; + RestrictionDescriptorAction = configure; + return Self; + } + /// /// /// A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected. @@ -419,6 +470,22 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, MetadataValue, options); } + if (RestrictionDescriptor is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, RestrictionDescriptor, options); + } + else if (RestrictionDescriptorAction is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.Security.RestrictionDescriptor(RestrictionDescriptorAction), options); + } + else if (RestrictionValue is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, RestrictionValue, options); + } + if (RunAsValue is not null) { writer.WritePropertyName("run_as"); @@ -454,6 +521,9 @@ public RoleDescriptorDescriptor() : base() private Action IndicesDescriptorAction { get; set; } private Action[] IndicesDescriptorActions { get; set; } private IDictionary? MetadataValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Security.Restriction? RestrictionValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Security.RestrictionDescriptor RestrictionDescriptor { get; set; } + private Action RestrictionDescriptorAction { get; set; } private ICollection? RunAsValue { get; set; } private IDictionary? TransientMetadataValue { get; set; } @@ -572,6 +642,35 @@ public RoleDescriptorDescriptor Metadata(Func, return Self; } + /// + /// + /// Restriction for when the role descriptor is allowed to be effective. + /// + /// + public RoleDescriptorDescriptor Restriction(Elastic.Clients.Elasticsearch.Serverless.Security.Restriction? restriction) + { + RestrictionDescriptor = null; + RestrictionDescriptorAction = null; + RestrictionValue = restriction; + return Self; + } + + public RoleDescriptorDescriptor Restriction(Elastic.Clients.Elasticsearch.Serverless.Security.RestrictionDescriptor descriptor) + { + RestrictionValue = null; + RestrictionDescriptorAction = null; + RestrictionDescriptor = descriptor; + return Self; + } + + public RoleDescriptorDescriptor Restriction(Action configure) + { + RestrictionValue = null; + RestrictionDescriptor = null; + RestrictionDescriptorAction = configure; + return Self; + } + /// /// /// A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected. @@ -672,6 +771,22 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, MetadataValue, options); } + if (RestrictionDescriptor is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, RestrictionDescriptor, options); + } + else if (RestrictionDescriptorAction is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.Security.RestrictionDescriptor(RestrictionDescriptorAction), options); + } + else if (RestrictionValue is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, RestrictionValue, options); + } + if (RunAsValue is not null) { writer.WritePropertyName("run_as"); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/RoleDescriptorRead.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/RoleDescriptorRead.g.cs index d34a6045e3..34ef826b7e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/RoleDescriptorRead.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/RoleDescriptorRead.g.cs @@ -38,6 +38,7 @@ public override RoleDescriptorRead Read(ref Utf8JsonReader reader, Type typeToCo string? description = default; IReadOnlyCollection indices = default; IReadOnlyDictionary? metadata = default; + Elastic.Clients.Elasticsearch.Serverless.Security.Restriction? restriction = default; IReadOnlyCollection? runAs = default; IReadOnlyDictionary? transientMetadata = default; while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) @@ -75,6 +76,12 @@ public override RoleDescriptorRead Read(ref Utf8JsonReader reader, Type typeToCo continue; } + if (property == "restriction") + { + restriction = JsonSerializer.Deserialize(ref reader, options); + continue; + } + if (property == "run_as") { runAs = JsonSerializer.Deserialize?>(ref reader, options); @@ -89,7 +96,7 @@ public override RoleDescriptorRead Read(ref Utf8JsonReader reader, Type typeToCo } } - return new RoleDescriptorRead { Applications = applications, Cluster = cluster, Description = description, Indices = indices, Metadata = metadata, RunAs = runAs, TransientMetadata = transientMetadata }; + return new RoleDescriptorRead { Applications = applications, Cluster = cluster, Description = description, Indices = indices, Metadata = metadata, Restriction = restriction, RunAs = runAs, TransientMetadata = transientMetadata }; } public override void Write(Utf8JsonWriter writer, RoleDescriptorRead value, JsonSerializerOptions options) @@ -136,6 +143,13 @@ public sealed partial class RoleDescriptorRead /// public IReadOnlyDictionary? Metadata { get; init; } + /// + /// + /// Restriction for when the role descriptor is allowed to be effective. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Security.Restriction? Restriction { get; init; } + /// /// /// A list of users that the API keys can impersonate. diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/UserIndicesPrivileges.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/UserIndicesPrivileges.g.cs index 10deebc168..3693ef101e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/UserIndicesPrivileges.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/UserIndicesPrivileges.g.cs @@ -51,6 +51,7 @@ public sealed partial class UserIndicesPrivileges /// /// [JsonInclude, JsonPropertyName("names")] + [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection Names { get; init; } /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TextSimilarityReranker.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TextSimilarityReranker.g.cs new file mode 100644 index 0000000000..c3ac989c0e --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/TextSimilarityReranker.g.cs @@ -0,0 +1,546 @@ +// 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.Serverless.Fluent; +using Elastic.Clients.Elasticsearch.Serverless.Serialization; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless; + +public sealed partial class TextSimilarityReranker +{ + /// + /// + /// The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text + /// + /// + [JsonInclude, JsonPropertyName("field")] + public string? Field { get; set; } + + /// + /// + /// Query to filter the documents that can match. + /// + /// + [JsonInclude, JsonPropertyName("filter")] + [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.Query))] + public ICollection? Filter { get; set; } + + /// + /// + /// Unique identifier of the inference endpoint created using the inference API. + /// + /// + [JsonInclude, JsonPropertyName("inference_id")] + public string? InferenceId { get; set; } + + /// + /// + /// The text snippet used as the basis for similarity comparison + /// + /// + [JsonInclude, JsonPropertyName("inference_text")] + public string? InferenceText { get; set; } + + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + [JsonInclude, JsonPropertyName("min_score")] + public float? MinScore { get; set; } + + /// + /// + /// This value determines how many documents we will consider from the nested retriever. + /// + /// + [JsonInclude, JsonPropertyName("rank_window_size")] + public int? RankWindowSize { get; set; } + + /// + /// + /// The nested retriever which will produce the first-level results, that will later be used for reranking. + /// + /// + [JsonInclude, JsonPropertyName("retriever")] + public Elastic.Clients.Elasticsearch.Serverless.Retriever Retriever { get; set; } + + public static implicit operator Elastic.Clients.Elasticsearch.Serverless.Retriever(TextSimilarityReranker textSimilarityReranker) => Elastic.Clients.Elasticsearch.Serverless.Retriever.TextSimilarityReranker(textSimilarityReranker); +} + +public sealed partial class TextSimilarityRerankerDescriptor : SerializableDescriptor> +{ + internal TextSimilarityRerankerDescriptor(Action> configure) => configure.Invoke(this); + + public TextSimilarityRerankerDescriptor() : base() + { + } + + private string? FieldValue { get; set; } + private ICollection? FilterValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor FilterDescriptor { get; set; } + private Action> FilterDescriptorAction { get; set; } + private Action>[] FilterDescriptorActions { get; set; } + private string? InferenceIdValue { get; set; } + private string? InferenceTextValue { get; set; } + private float? MinScoreValue { get; set; } + private int? RankWindowSizeValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Retriever RetrieverValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.RetrieverDescriptor RetrieverDescriptor { get; set; } + private Action> RetrieverDescriptorAction { get; set; } + + /// + /// + /// The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text + /// + /// + public TextSimilarityRerankerDescriptor Field(string? field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// Query to filter the documents that can match. + /// + /// + public TextSimilarityRerankerDescriptor Filter(ICollection? filter) + { + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterValue = filter; + return Self; + } + + public TextSimilarityRerankerDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor descriptor) + { + FilterValue = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterDescriptor = descriptor; + return Self; + } + + public TextSimilarityRerankerDescriptor Filter(Action> configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorActions = null; + FilterDescriptorAction = configure; + return Self; + } + + public TextSimilarityRerankerDescriptor Filter(params Action>[] configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = configure; + return Self; + } + + /// + /// + /// Unique identifier of the inference endpoint created using the inference API. + /// + /// + public TextSimilarityRerankerDescriptor InferenceId(string? inferenceId) + { + InferenceIdValue = inferenceId; + return Self; + } + + /// + /// + /// The text snippet used as the basis for similarity comparison + /// + /// + public TextSimilarityRerankerDescriptor InferenceText(string? inferenceText) + { + InferenceTextValue = inferenceText; + return Self; + } + + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public TextSimilarityRerankerDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + + /// + /// + /// This value determines how many documents we will consider from the nested retriever. + /// + /// + public TextSimilarityRerankerDescriptor RankWindowSize(int? rankWindowSize) + { + RankWindowSizeValue = rankWindowSize; + return Self; + } + + /// + /// + /// The nested retriever which will produce the first-level results, that will later be used for reranking. + /// + /// + public TextSimilarityRerankerDescriptor Retriever(Elastic.Clients.Elasticsearch.Serverless.Retriever retriever) + { + RetrieverDescriptor = null; + RetrieverDescriptorAction = null; + RetrieverValue = retriever; + return Self; + } + + public TextSimilarityRerankerDescriptor Retriever(Elastic.Clients.Elasticsearch.Serverless.RetrieverDescriptor descriptor) + { + RetrieverValue = null; + RetrieverDescriptorAction = null; + RetrieverDescriptor = descriptor; + return Self; + } + + public TextSimilarityRerankerDescriptor Retriever(Action> configure) + { + RetrieverValue = null; + RetrieverDescriptor = null; + RetrieverDescriptorAction = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(FieldValue)) + { + writer.WritePropertyName("field"); + writer.WriteStringValue(FieldValue); + } + + if (FilterDescriptor is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, FilterDescriptor, options); + } + else if (FilterDescriptorAction is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor(FilterDescriptorAction), options); + } + else if (FilterDescriptorActions is not null) + { + writer.WritePropertyName("filter"); + if (FilterDescriptorActions.Length != 1) + writer.WriteStartArray(); + foreach (var action in FilterDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor(action), options); + } + + if (FilterDescriptorActions.Length != 1) + writer.WriteEndArray(); + } + else if (FilterValue is not null) + { + writer.WritePropertyName("filter"); + SingleOrManySerializationHelper.Serialize(FilterValue, writer, options); + } + + if (!string.IsNullOrEmpty(InferenceIdValue)) + { + writer.WritePropertyName("inference_id"); + writer.WriteStringValue(InferenceIdValue); + } + + if (!string.IsNullOrEmpty(InferenceTextValue)) + { + writer.WritePropertyName("inference_text"); + writer.WriteStringValue(InferenceTextValue); + } + + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + + if (RankWindowSizeValue.HasValue) + { + writer.WritePropertyName("rank_window_size"); + writer.WriteNumberValue(RankWindowSizeValue.Value); + } + + if (RetrieverDescriptor is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverDescriptor, options); + } + else if (RetrieverDescriptorAction is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.RetrieverDescriptor(RetrieverDescriptorAction), options); + } + else + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverValue, options); + } + + writer.WriteEndObject(); + } +} + +public sealed partial class TextSimilarityRerankerDescriptor : SerializableDescriptor +{ + internal TextSimilarityRerankerDescriptor(Action configure) => configure.Invoke(this); + + public TextSimilarityRerankerDescriptor() : base() + { + } + + private string? FieldValue { get; set; } + private ICollection? FilterValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor FilterDescriptor { get; set; } + private Action FilterDescriptorAction { get; set; } + private Action[] FilterDescriptorActions { get; set; } + private string? InferenceIdValue { get; set; } + private string? InferenceTextValue { get; set; } + private float? MinScoreValue { get; set; } + private int? RankWindowSizeValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Retriever RetrieverValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.RetrieverDescriptor RetrieverDescriptor { get; set; } + private Action RetrieverDescriptorAction { get; set; } + + /// + /// + /// The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text + /// + /// + public TextSimilarityRerankerDescriptor Field(string? field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// Query to filter the documents that can match. + /// + /// + public TextSimilarityRerankerDescriptor Filter(ICollection? filter) + { + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterValue = filter; + return Self; + } + + public TextSimilarityRerankerDescriptor Filter(Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor descriptor) + { + FilterValue = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterDescriptor = descriptor; + return Self; + } + + public TextSimilarityRerankerDescriptor Filter(Action configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorActions = null; + FilterDescriptorAction = configure; + return Self; + } + + public TextSimilarityRerankerDescriptor Filter(params Action[] configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = configure; + return Self; + } + + /// + /// + /// Unique identifier of the inference endpoint created using the inference API. + /// + /// + public TextSimilarityRerankerDescriptor InferenceId(string? inferenceId) + { + InferenceIdValue = inferenceId; + return Self; + } + + /// + /// + /// The text snippet used as the basis for similarity comparison + /// + /// + public TextSimilarityRerankerDescriptor InferenceText(string? inferenceText) + { + InferenceTextValue = inferenceText; + return Self; + } + + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public TextSimilarityRerankerDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + + /// + /// + /// This value determines how many documents we will consider from the nested retriever. + /// + /// + public TextSimilarityRerankerDescriptor RankWindowSize(int? rankWindowSize) + { + RankWindowSizeValue = rankWindowSize; + return Self; + } + + /// + /// + /// The nested retriever which will produce the first-level results, that will later be used for reranking. + /// + /// + public TextSimilarityRerankerDescriptor Retriever(Elastic.Clients.Elasticsearch.Serverless.Retriever retriever) + { + RetrieverDescriptor = null; + RetrieverDescriptorAction = null; + RetrieverValue = retriever; + return Self; + } + + public TextSimilarityRerankerDescriptor Retriever(Elastic.Clients.Elasticsearch.Serverless.RetrieverDescriptor descriptor) + { + RetrieverValue = null; + RetrieverDescriptorAction = null; + RetrieverDescriptor = descriptor; + return Self; + } + + public TextSimilarityRerankerDescriptor Retriever(Action configure) + { + RetrieverValue = null; + RetrieverDescriptor = null; + RetrieverDescriptorAction = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(FieldValue)) + { + writer.WritePropertyName("field"); + writer.WriteStringValue(FieldValue); + } + + if (FilterDescriptor is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, FilterDescriptor, options); + } + else if (FilterDescriptorAction is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor(FilterDescriptorAction), options); + } + else if (FilterDescriptorActions is not null) + { + writer.WritePropertyName("filter"); + if (FilterDescriptorActions.Length != 1) + writer.WriteStartArray(); + foreach (var action in FilterDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.QueryDsl.QueryDescriptor(action), options); + } + + if (FilterDescriptorActions.Length != 1) + writer.WriteEndArray(); + } + else if (FilterValue is not null) + { + writer.WritePropertyName("filter"); + SingleOrManySerializationHelper.Serialize(FilterValue, writer, options); + } + + if (!string.IsNullOrEmpty(InferenceIdValue)) + { + writer.WritePropertyName("inference_id"); + writer.WriteStringValue(InferenceIdValue); + } + + if (!string.IsNullOrEmpty(InferenceTextValue)) + { + writer.WritePropertyName("inference_text"); + writer.WriteStringValue(InferenceTextValue); + } + + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + + if (RankWindowSizeValue.HasValue) + { + writer.WritePropertyName("rank_window_size"); + writer.WriteNumberValue(RankWindowSizeValue.Value); + } + + if (RetrieverDescriptor is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverDescriptor, options); + } + else if (RetrieverDescriptorAction is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.RetrieverDescriptor(RetrieverDescriptorAction), options); + } + else + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverValue, options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Xpack/Features.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Xpack/Features.g.cs index 8fced1722f..9b76bc470f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Xpack/Features.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Xpack/Features.g.cs @@ -49,6 +49,8 @@ public sealed partial class Features public Elastic.Clients.Elasticsearch.Serverless.Xpack.Feature Graph { get; init; } [JsonInclude, JsonPropertyName("ilm")] public Elastic.Clients.Elasticsearch.Serverless.Xpack.Feature Ilm { get; init; } + [JsonInclude, JsonPropertyName("logsdb")] + public Elastic.Clients.Elasticsearch.Serverless.Xpack.Feature Logsdb { get; init; } [JsonInclude, JsonPropertyName("logstash")] public Elastic.Clients.Elasticsearch.Serverless.Xpack.Feature Logstash { get; init; } [JsonInclude, JsonPropertyName("ml")] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs index 05feceafbc..537089cf96 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs @@ -279,6 +279,7 @@ internal static class ApiUrlLookup internal static ApiUrls QueryRulesListRulesets = new ApiUrls(new[] { "_query_rules" }); internal static ApiUrls QueryRulesPutRule = new ApiUrls(new[] { "_query_rules/{ruleset_id}/_rule/{rule_id}" }); internal static ApiUrls QueryRulesPutRuleset = new ApiUrls(new[] { "_query_rules/{ruleset_id}" }); + internal static ApiUrls QueryRulesTest = new ApiUrls(new[] { "_query_rules/{ruleset_id}/_test" }); internal static ApiUrls RollupDeleteJob = new ApiUrls(new[] { "_rollup/job/{id}" }); internal static ApiUrls RollupGetJobs = new ApiUrls(new[] { "_rollup/job/{id}", "_rollup/job" }); internal static ApiUrls RollupGetRollupCaps = new ApiUrls(new[] { "_rollup/data/{id}", "_rollup/data" }); @@ -310,6 +311,7 @@ internal static class ApiUrlLookup internal static ApiUrls SecurityClearCachedRoles = new ApiUrls(new[] { "_security/role/{name}/_clear_cache" }); internal static ApiUrls SecurityClearCachedServiceTokens = new ApiUrls(new[] { "_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache" }); internal static ApiUrls SecurityCreateApiKey = new ApiUrls(new[] { "_security/api_key" }); + internal static ApiUrls SecurityCreateCrossClusterApiKey = new ApiUrls(new[] { "_security/cross_cluster/api_key" }); internal static ApiUrls SecurityCreateServiceToken = new ApiUrls(new[] { "_security/service/{namespace}/{service}/credential/token/{name}", "_security/service/{namespace}/{service}/credential/token" }); internal static ApiUrls SecurityDeletePrivileges = new ApiUrls(new[] { "_security/privilege/{application}/{name}" }); internal static ApiUrls SecurityDeleteRole = new ApiUrls(new[] { "_security/role/{name}" }); @@ -353,6 +355,7 @@ internal static class ApiUrlLookup internal static ApiUrls SecuritySamlServiceProviderMetadata = new ApiUrls(new[] { "_security/saml/metadata/{realm_name}" }); internal static ApiUrls SecuritySuggestUserProfiles = new ApiUrls(new[] { "_security/profile/_suggest" }); internal static ApiUrls SecurityUpdateApiKey = new ApiUrls(new[] { "_security/api_key/{id}" }); + internal static ApiUrls SecurityUpdateCrossClusterApiKey = new ApiUrls(new[] { "_security/cross_cluster/api_key/{id}" }); internal static ApiUrls SecurityUpdateUserProfileData = new ApiUrls(new[] { "_security/profile/{uid}/_data" }); internal static ApiUrls SnapshotCleanupRepository = new ApiUrls(new[] { "_snapshot/{repository}/_cleanup" }); internal static ApiUrls SnapshotClone = new ApiUrls(new[] { "_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}" }); @@ -371,6 +374,7 @@ internal static class ApiUrlLookup internal static ApiUrls SnapshotLifecycleManagementPutLifecycle = new ApiUrls(new[] { "_slm/policy/{policy_id}" }); internal static ApiUrls SnapshotLifecycleManagementStart = new ApiUrls(new[] { "_slm/start" }); internal static ApiUrls SnapshotLifecycleManagementStop = new ApiUrls(new[] { "_slm/stop" }); + internal static ApiUrls SnapshotRepositoryVerifyIntegrity = new ApiUrls(new[] { "_snapshot/{repository}/_verify_integrity" }); internal static ApiUrls SnapshotRestore = new ApiUrls(new[] { "_snapshot/{repository}/{snapshot}/_restore" }); internal static ApiUrls SnapshotStatus = new ApiUrls(new[] { "_snapshot/_status", "_snapshot/{repository}/_status", "_snapshot/{repository}/{snapshot}/_status" }); internal static ApiUrls SnapshotVerifyRepository = new ApiUrls(new[] { "_snapshot/{repository}/_verify" }); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs index 15213e6dde..ddd279f7d4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs @@ -36,8 +36,10 @@ public sealed partial class AsyncSearchStatusRequestParameters : RequestParamete /// /// -/// Get async search status -/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. +/// Get the async search status. +/// +/// +/// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// /// @@ -58,8 +60,10 @@ public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => /// /// -/// Get async search status -/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. +/// Get the async search status. +/// +/// +/// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// /// @@ -92,8 +96,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Get async search status -/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. +/// Get the async search status. +/// +/// +/// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs index 335427c313..e59001fda7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs @@ -36,8 +36,10 @@ public sealed partial class DeleteAsyncSearchRequestParameters : RequestParamete /// /// -/// Deletes an async search by identifier. -/// If the search is still running, the search request will be cancelled. +/// Delete an async search. +/// +/// +/// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// @@ -59,8 +61,10 @@ public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => /// /// -/// Deletes an async search by identifier. -/// If the search is still running, the search request will be cancelled. +/// Delete an async search. +/// +/// +/// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// @@ -94,8 +98,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes an async search by identifier. -/// If the search is still running, the search request will be cancelled. +/// Delete an async search. +/// +/// +/// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs index 7014f6ae88..c2884fe1b4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs @@ -62,7 +62,10 @@ public sealed partial class GetAsyncSearchRequestParameters : RequestParameters /// /// -/// Retrieves the results of a previously submitted async search request given its identifier. +/// Get async search results. +/// +/// +/// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// /// @@ -113,7 +116,10 @@ public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r. /// /// -/// Retrieves the results of a previously submitted async search request given its identifier. +/// Get async search results. +/// +/// +/// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// /// @@ -150,7 +156,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieves the results of a previously submitted async search request given its identifier. +/// Get async search results. +/// +/// +/// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs index 070370fb9a..3612227015 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs @@ -138,7 +138,6 @@ public sealed partial class SubmitAsyncSearchRequestParameters : RequestParamete /// /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } - public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// /// @@ -652,10 +651,16 @@ public override void Write(Utf8JsonWriter writer, SubmitAsyncSearchRequest value /// /// -/// Runs a search request asynchronously. -/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. -/// Warning: Async search does not support scroll nor search requests that only include the suggest section. -/// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. +/// Run an async search. +/// +/// +/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. +/// +/// +/// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. +/// +/// +/// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// /// @@ -799,8 +804,6 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) /// [JsonIgnore] public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } - [JsonIgnore] - public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// /// @@ -1145,10 +1148,16 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) /// /// -/// Runs a search request asynchronously. -/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. -/// Warning: Async search does not support scroll nor search requests that only include the suggest section. -/// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. +/// Run an async search. +/// +/// +/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. +/// +/// +/// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. +/// +/// +/// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// /// @@ -1187,7 +1196,6 @@ public SubmitAsyncSearchRequestDescriptor() public SubmitAsyncSearchRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true) => Qs("keep_on_completion", keepOnCompletion); public SubmitAsyncSearchRequestDescriptor Lenient(bool? lenient = true) => Qs("lenient", lenient); public SubmitAsyncSearchRequestDescriptor MaxConcurrentShardRequests(long? maxConcurrentShardRequests) => Qs("max_concurrent_shard_requests", maxConcurrentShardRequests); - public SubmitAsyncSearchRequestDescriptor MinCompatibleShardNode(string? minCompatibleShardNode) => Qs("min_compatible_shard_node", minCompatibleShardNode); public SubmitAsyncSearchRequestDescriptor Preference(string? preference) => Qs("preference", preference); public SubmitAsyncSearchRequestDescriptor PreFilterShardSize(long? preFilterShardSize) => Qs("pre_filter_shard_size", preFilterShardSize); public SubmitAsyncSearchRequestDescriptor QueryLuceneSyntax(string? queryLuceneSyntax) => Qs("q", queryLuceneSyntax); @@ -2264,10 +2272,16 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Runs a search request asynchronously. -/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. -/// Warning: Async search does not support scroll nor search requests that only include the suggest section. -/// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. +/// Run an async search. +/// +/// +/// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. +/// +/// +/// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. +/// +/// +/// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// /// @@ -2306,7 +2320,6 @@ public SubmitAsyncSearchRequestDescriptor() public SubmitAsyncSearchRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true) => Qs("keep_on_completion", keepOnCompletion); public SubmitAsyncSearchRequestDescriptor Lenient(bool? lenient = true) => Qs("lenient", lenient); public SubmitAsyncSearchRequestDescriptor MaxConcurrentShardRequests(long? maxConcurrentShardRequests) => Qs("max_concurrent_shard_requests", maxConcurrentShardRequests); - public SubmitAsyncSearchRequestDescriptor MinCompatibleShardNode(string? minCompatibleShardNode) => Qs("min_compatible_shard_node", minCompatibleShardNode); public SubmitAsyncSearchRequestDescriptor Preference(string? preference) => Qs("preference", preference); public SubmitAsyncSearchRequestDescriptor PreFilterShardSize(long? preFilterShardSize) => Qs("pre_filter_shard_size", preFilterShardSize); public SubmitAsyncSearchRequestDescriptor QueryLuceneSyntax(string? queryLuceneSyntax) => Qs("q", queryLuceneSyntax); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClearScrollRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClearScrollRequest.g.cs index 44a39a87f9..156d7b5084 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClearScrollRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClearScrollRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class ClearScrollRequestParameters : RequestParameters /// /// -/// Clears the search context and results for a scrolling search. +/// Clear a scrolling search. +/// +/// +/// Clear the search context and results for a scrolling search. /// /// public sealed partial class ClearScrollRequest : PlainRequest @@ -61,7 +64,10 @@ public sealed partial class ClearScrollRequest : PlainRequest /// -/// Clears the search context and results for a scrolling search. +/// Clear a scrolling search. +/// +/// +/// Clear the search context and results for a scrolling search. /// /// public sealed partial class ClearScrollRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClosePointInTimeRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClosePointInTimeRequest.g.cs index 9b343cb279..4bc64124f7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClosePointInTimeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClosePointInTimeRequest.g.cs @@ -36,7 +36,13 @@ public sealed partial class ClosePointInTimeRequestParameters : RequestParameter /// /// -/// Closes a point-in-time. +/// Close a point in time. +/// +/// +/// A point in time must be opened explicitly before being used in search requests. +/// The keep_alive parameter tells Elasticsearch how long it should persist. +/// A point in time is automatically closed when the keep_alive period has elapsed. +/// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. /// /// public sealed partial class ClosePointInTimeRequest : PlainRequest @@ -60,7 +66,13 @@ public sealed partial class ClosePointInTimeRequest : PlainRequest /// -/// Closes a point-in-time. +/// Close a point in time. +/// +/// +/// A point in time must be opened explicitly before being used in search requests. +/// The keep_alive parameter tells Elasticsearch how long it should persist. +/// A point in time is automatically closed when the keep_alive period has elapsed. +/// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. /// /// public sealed partial class ClosePointInTimeRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowRequest.g.cs index 34e1fcbab0..3280b6931a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowRequest.g.cs @@ -34,7 +34,10 @@ public sealed partial class FollowRequestParameters : RequestParameters { /// /// - /// Sets the number of shard copies that must be active before returning. Defaults to 0. Set to all for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) + /// Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be + /// active. + /// A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the + /// remote Lucene segment files to the follower index. /// /// public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } @@ -61,35 +64,131 @@ public FollowRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r => /// /// - /// Sets the number of shard copies that must be active before returning. Defaults to 0. Set to all for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) + /// Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be + /// active. + /// A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the + /// remote Lucene segment files to the follower index. /// /// [JsonIgnore] public Elastic.Clients.Elasticsearch.WaitForActiveShards? WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } + + /// + /// + /// If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed. + /// + /// + [JsonInclude, JsonPropertyName("data_stream_name")] + public string? DataStreamName { get; set; } + + /// + /// + /// The name of the index in the leader cluster to follow. + /// + /// [JsonInclude, JsonPropertyName("leader_index")] - public Elastic.Clients.Elasticsearch.IndexName? LeaderIndex { get; set; } + public Elastic.Clients.Elasticsearch.IndexName LeaderIndex { get; set; } + + /// + /// + /// The maximum number of outstanding reads requests from the remote cluster. + /// + /// [JsonInclude, JsonPropertyName("max_outstanding_read_requests")] public long? MaxOutstandingReadRequests { get; set; } + + /// + /// + /// The maximum number of outstanding write requests on the follower. + /// + /// [JsonInclude, JsonPropertyName("max_outstanding_write_requests")] - public long? MaxOutstandingWriteRequests { get; set; } + public int? MaxOutstandingWriteRequests { get; set; } + + /// + /// + /// The maximum number of operations to pull per read from the remote cluster. + /// + /// [JsonInclude, JsonPropertyName("max_read_request_operation_count")] - public long? MaxReadRequestOperationCount { get; set; } + public int? MaxReadRequestOperationCount { get; set; } + + /// + /// + /// The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. + /// + /// [JsonInclude, JsonPropertyName("max_read_request_size")] - public string? MaxReadRequestSize { get; set; } + public Elastic.Clients.Elasticsearch.ByteSize? MaxReadRequestSize { get; set; } + + /// + /// + /// The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when + /// retrying. + /// + /// [JsonInclude, JsonPropertyName("max_retry_delay")] public Elastic.Clients.Elasticsearch.Duration? MaxRetryDelay { get; set; } + + /// + /// + /// The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be + /// deferred until the number of queued operations goes below the limit. + /// + /// [JsonInclude, JsonPropertyName("max_write_buffer_count")] - public long? MaxWriteBufferCount { get; set; } + public int? MaxWriteBufferCount { get; set; } + + /// + /// + /// The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will + /// be deferred until the total bytes of queued operations goes below the limit. + /// + /// [JsonInclude, JsonPropertyName("max_write_buffer_size")] - public string? MaxWriteBufferSize { get; set; } + public Elastic.Clients.Elasticsearch.ByteSize? MaxWriteBufferSize { get; set; } + + /// + /// + /// The maximum number of operations per bulk write request executed on the follower. + /// + /// [JsonInclude, JsonPropertyName("max_write_request_operation_count")] - public long? MaxWriteRequestOperationCount { get; set; } + public int? MaxWriteRequestOperationCount { get; set; } + + /// + /// + /// The maximum total bytes of operations per bulk write request executed on the follower. + /// + /// [JsonInclude, JsonPropertyName("max_write_request_size")] - public string? MaxWriteRequestSize { get; set; } + public Elastic.Clients.Elasticsearch.ByteSize? MaxWriteRequestSize { get; set; } + + /// + /// + /// The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. + /// When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. + /// Then the follower will immediately attempt to read from the leader again. + /// + /// [JsonInclude, JsonPropertyName("read_poll_timeout")] public Elastic.Clients.Elasticsearch.Duration? ReadPollTimeout { get; set; } + + /// + /// + /// The remote cluster containing the leader index. + /// + /// [JsonInclude, JsonPropertyName("remote_cluster")] - public string? RemoteCluster { get; set; } + public string RemoteCluster { get; set; } + + /// + /// + /// Settings to override from the leader index. + /// + /// + [JsonInclude, JsonPropertyName("settings")] + public Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? Settings { get; set; } } /// @@ -125,100 +224,211 @@ public FollowRequestDescriptor Index(Elastic.Clients.Elasticsearch.In return Self; } - private Elastic.Clients.Elasticsearch.IndexName? LeaderIndexValue { get; set; } + private string? DataStreamNameValue { get; set; } + private Elastic.Clients.Elasticsearch.IndexName LeaderIndexValue { get; set; } private long? MaxOutstandingReadRequestsValue { get; set; } - private long? MaxOutstandingWriteRequestsValue { get; set; } - private long? MaxReadRequestOperationCountValue { get; set; } - private string? MaxReadRequestSizeValue { get; set; } + private int? MaxOutstandingWriteRequestsValue { get; set; } + private int? MaxReadRequestOperationCountValue { get; set; } + private Elastic.Clients.Elasticsearch.ByteSize? MaxReadRequestSizeValue { get; set; } private Elastic.Clients.Elasticsearch.Duration? MaxRetryDelayValue { get; set; } - private long? MaxWriteBufferCountValue { get; set; } - private string? MaxWriteBufferSizeValue { get; set; } - private long? MaxWriteRequestOperationCountValue { get; set; } - private string? MaxWriteRequestSizeValue { get; set; } + private int? MaxWriteBufferCountValue { get; set; } + private Elastic.Clients.Elasticsearch.ByteSize? MaxWriteBufferSizeValue { get; set; } + private int? MaxWriteRequestOperationCountValue { get; set; } + private Elastic.Clients.Elasticsearch.ByteSize? MaxWriteRequestSizeValue { get; set; } private Elastic.Clients.Elasticsearch.Duration? ReadPollTimeoutValue { get; set; } - private string? RemoteClusterValue { get; set; } + private string RemoteClusterValue { get; set; } + private Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? SettingsValue { get; set; } + private Elastic.Clients.Elasticsearch.IndexManagement.IndexSettingsDescriptor SettingsDescriptor { get; set; } + private Action> SettingsDescriptorAction { get; set; } - public FollowRequestDescriptor LeaderIndex(Elastic.Clients.Elasticsearch.IndexName? leaderIndex) + /// + /// + /// If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed. + /// + /// + public FollowRequestDescriptor DataStreamName(string? dataStreamName) + { + DataStreamNameValue = dataStreamName; + return Self; + } + + /// + /// + /// The name of the index in the leader cluster to follow. + /// + /// + public FollowRequestDescriptor LeaderIndex(Elastic.Clients.Elasticsearch.IndexName leaderIndex) { LeaderIndexValue = leaderIndex; return Self; } + /// + /// + /// The maximum number of outstanding reads requests from the remote cluster. + /// + /// public FollowRequestDescriptor MaxOutstandingReadRequests(long? maxOutstandingReadRequests) { MaxOutstandingReadRequestsValue = maxOutstandingReadRequests; return Self; } - public FollowRequestDescriptor MaxOutstandingWriteRequests(long? maxOutstandingWriteRequests) + /// + /// + /// The maximum number of outstanding write requests on the follower. + /// + /// + public FollowRequestDescriptor MaxOutstandingWriteRequests(int? maxOutstandingWriteRequests) { MaxOutstandingWriteRequestsValue = maxOutstandingWriteRequests; return Self; } - public FollowRequestDescriptor MaxReadRequestOperationCount(long? maxReadRequestOperationCount) + /// + /// + /// The maximum number of operations to pull per read from the remote cluster. + /// + /// + public FollowRequestDescriptor MaxReadRequestOperationCount(int? maxReadRequestOperationCount) { MaxReadRequestOperationCountValue = maxReadRequestOperationCount; return Self; } - public FollowRequestDescriptor MaxReadRequestSize(string? maxReadRequestSize) + /// + /// + /// The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. + /// + /// + public FollowRequestDescriptor MaxReadRequestSize(Elastic.Clients.Elasticsearch.ByteSize? maxReadRequestSize) { MaxReadRequestSizeValue = maxReadRequestSize; return Self; } + /// + /// + /// The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when + /// retrying. + /// + /// public FollowRequestDescriptor MaxRetryDelay(Elastic.Clients.Elasticsearch.Duration? maxRetryDelay) { MaxRetryDelayValue = maxRetryDelay; return Self; } - public FollowRequestDescriptor MaxWriteBufferCount(long? maxWriteBufferCount) + /// + /// + /// The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be + /// deferred until the number of queued operations goes below the limit. + /// + /// + public FollowRequestDescriptor MaxWriteBufferCount(int? maxWriteBufferCount) { MaxWriteBufferCountValue = maxWriteBufferCount; return Self; } - public FollowRequestDescriptor MaxWriteBufferSize(string? maxWriteBufferSize) + /// + /// + /// The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will + /// be deferred until the total bytes of queued operations goes below the limit. + /// + /// + public FollowRequestDescriptor MaxWriteBufferSize(Elastic.Clients.Elasticsearch.ByteSize? maxWriteBufferSize) { MaxWriteBufferSizeValue = maxWriteBufferSize; return Self; } - public FollowRequestDescriptor MaxWriteRequestOperationCount(long? maxWriteRequestOperationCount) + /// + /// + /// The maximum number of operations per bulk write request executed on the follower. + /// + /// + public FollowRequestDescriptor MaxWriteRequestOperationCount(int? maxWriteRequestOperationCount) { MaxWriteRequestOperationCountValue = maxWriteRequestOperationCount; return Self; } - public FollowRequestDescriptor MaxWriteRequestSize(string? maxWriteRequestSize) + /// + /// + /// The maximum total bytes of operations per bulk write request executed on the follower. + /// + /// + public FollowRequestDescriptor MaxWriteRequestSize(Elastic.Clients.Elasticsearch.ByteSize? maxWriteRequestSize) { MaxWriteRequestSizeValue = maxWriteRequestSize; return Self; } + /// + /// + /// The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. + /// When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. + /// Then the follower will immediately attempt to read from the leader again. + /// + /// public FollowRequestDescriptor ReadPollTimeout(Elastic.Clients.Elasticsearch.Duration? readPollTimeout) { ReadPollTimeoutValue = readPollTimeout; return Self; } - public FollowRequestDescriptor RemoteCluster(string? remoteCluster) + /// + /// + /// The remote cluster containing the leader index. + /// + /// + public FollowRequestDescriptor RemoteCluster(string remoteCluster) { RemoteClusterValue = remoteCluster; return Self; } + /// + /// + /// Settings to override from the leader index. + /// + /// + public FollowRequestDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? settings) + { + SettingsDescriptor = null; + SettingsDescriptorAction = null; + SettingsValue = settings; + return Self; + } + + public FollowRequestDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettingsDescriptor descriptor) + { + SettingsValue = null; + SettingsDescriptorAction = null; + SettingsDescriptor = descriptor; + return Self; + } + + public FollowRequestDescriptor Settings(Action> configure) + { + SettingsValue = null; + SettingsDescriptor = null; + SettingsDescriptorAction = configure; + return Self; + } + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); - if (LeaderIndexValue is not null) + if (!string.IsNullOrEmpty(DataStreamNameValue)) { - writer.WritePropertyName("leader_index"); - JsonSerializer.Serialize(writer, LeaderIndexValue, options); + writer.WritePropertyName("data_stream_name"); + writer.WriteStringValue(DataStreamNameValue); } + writer.WritePropertyName("leader_index"); + JsonSerializer.Serialize(writer, LeaderIndexValue, options); if (MaxOutstandingReadRequestsValue.HasValue) { writer.WritePropertyName("max_outstanding_read_requests"); @@ -237,10 +447,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(MaxReadRequestOperationCountValue.Value); } - if (!string.IsNullOrEmpty(MaxReadRequestSizeValue)) + if (MaxReadRequestSizeValue is not null) { writer.WritePropertyName("max_read_request_size"); - writer.WriteStringValue(MaxReadRequestSizeValue); + JsonSerializer.Serialize(writer, MaxReadRequestSizeValue, options); } if (MaxRetryDelayValue is not null) @@ -255,10 +465,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(MaxWriteBufferCountValue.Value); } - if (!string.IsNullOrEmpty(MaxWriteBufferSizeValue)) + if (MaxWriteBufferSizeValue is not null) { writer.WritePropertyName("max_write_buffer_size"); - writer.WriteStringValue(MaxWriteBufferSizeValue); + JsonSerializer.Serialize(writer, MaxWriteBufferSizeValue, options); } if (MaxWriteRequestOperationCountValue.HasValue) @@ -267,10 +477,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(MaxWriteRequestOperationCountValue.Value); } - if (!string.IsNullOrEmpty(MaxWriteRequestSizeValue)) + if (MaxWriteRequestSizeValue is not null) { writer.WritePropertyName("max_write_request_size"); - writer.WriteStringValue(MaxWriteRequestSizeValue); + JsonSerializer.Serialize(writer, MaxWriteRequestSizeValue, options); } if (ReadPollTimeoutValue is not null) @@ -279,10 +489,22 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, ReadPollTimeoutValue, options); } - if (!string.IsNullOrEmpty(RemoteClusterValue)) + writer.WritePropertyName("remote_cluster"); + writer.WriteStringValue(RemoteClusterValue); + if (SettingsDescriptor is not null) + { + writer.WritePropertyName("settings"); + JsonSerializer.Serialize(writer, SettingsDescriptor, options); + } + else if (SettingsDescriptorAction is not null) + { + writer.WritePropertyName("settings"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.IndexManagement.IndexSettingsDescriptor(SettingsDescriptorAction), options); + } + else if (SettingsValue is not null) { - writer.WritePropertyName("remote_cluster"); - writer.WriteStringValue(RemoteClusterValue); + writer.WritePropertyName("settings"); + JsonSerializer.Serialize(writer, SettingsValue, options); } writer.WriteEndObject(); @@ -318,100 +540,211 @@ public FollowRequestDescriptor Index(Elastic.Clients.Elasticsearch.IndexName ind return Self; } - private Elastic.Clients.Elasticsearch.IndexName? LeaderIndexValue { get; set; } + private string? DataStreamNameValue { get; set; } + private Elastic.Clients.Elasticsearch.IndexName LeaderIndexValue { get; set; } private long? MaxOutstandingReadRequestsValue { get; set; } - private long? MaxOutstandingWriteRequestsValue { get; set; } - private long? MaxReadRequestOperationCountValue { get; set; } - private string? MaxReadRequestSizeValue { get; set; } + private int? MaxOutstandingWriteRequestsValue { get; set; } + private int? MaxReadRequestOperationCountValue { get; set; } + private Elastic.Clients.Elasticsearch.ByteSize? MaxReadRequestSizeValue { get; set; } private Elastic.Clients.Elasticsearch.Duration? MaxRetryDelayValue { get; set; } - private long? MaxWriteBufferCountValue { get; set; } - private string? MaxWriteBufferSizeValue { get; set; } - private long? MaxWriteRequestOperationCountValue { get; set; } - private string? MaxWriteRequestSizeValue { get; set; } + private int? MaxWriteBufferCountValue { get; set; } + private Elastic.Clients.Elasticsearch.ByteSize? MaxWriteBufferSizeValue { get; set; } + private int? MaxWriteRequestOperationCountValue { get; set; } + private Elastic.Clients.Elasticsearch.ByteSize? MaxWriteRequestSizeValue { get; set; } private Elastic.Clients.Elasticsearch.Duration? ReadPollTimeoutValue { get; set; } - private string? RemoteClusterValue { get; set; } + private string RemoteClusterValue { get; set; } + private Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? SettingsValue { get; set; } + private Elastic.Clients.Elasticsearch.IndexManagement.IndexSettingsDescriptor SettingsDescriptor { get; set; } + private Action SettingsDescriptorAction { get; set; } + + /// + /// + /// If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed. + /// + /// + public FollowRequestDescriptor DataStreamName(string? dataStreamName) + { + DataStreamNameValue = dataStreamName; + return Self; + } - public FollowRequestDescriptor LeaderIndex(Elastic.Clients.Elasticsearch.IndexName? leaderIndex) + /// + /// + /// The name of the index in the leader cluster to follow. + /// + /// + public FollowRequestDescriptor LeaderIndex(Elastic.Clients.Elasticsearch.IndexName leaderIndex) { LeaderIndexValue = leaderIndex; return Self; } + /// + /// + /// The maximum number of outstanding reads requests from the remote cluster. + /// + /// public FollowRequestDescriptor MaxOutstandingReadRequests(long? maxOutstandingReadRequests) { MaxOutstandingReadRequestsValue = maxOutstandingReadRequests; return Self; } - public FollowRequestDescriptor MaxOutstandingWriteRequests(long? maxOutstandingWriteRequests) + /// + /// + /// The maximum number of outstanding write requests on the follower. + /// + /// + public FollowRequestDescriptor MaxOutstandingWriteRequests(int? maxOutstandingWriteRequests) { MaxOutstandingWriteRequestsValue = maxOutstandingWriteRequests; return Self; } - public FollowRequestDescriptor MaxReadRequestOperationCount(long? maxReadRequestOperationCount) + /// + /// + /// The maximum number of operations to pull per read from the remote cluster. + /// + /// + public FollowRequestDescriptor MaxReadRequestOperationCount(int? maxReadRequestOperationCount) { MaxReadRequestOperationCountValue = maxReadRequestOperationCount; return Self; } - public FollowRequestDescriptor MaxReadRequestSize(string? maxReadRequestSize) + /// + /// + /// The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. + /// + /// + public FollowRequestDescriptor MaxReadRequestSize(Elastic.Clients.Elasticsearch.ByteSize? maxReadRequestSize) { MaxReadRequestSizeValue = maxReadRequestSize; return Self; } + /// + /// + /// The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when + /// retrying. + /// + /// public FollowRequestDescriptor MaxRetryDelay(Elastic.Clients.Elasticsearch.Duration? maxRetryDelay) { MaxRetryDelayValue = maxRetryDelay; return Self; } - public FollowRequestDescriptor MaxWriteBufferCount(long? maxWriteBufferCount) + /// + /// + /// The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be + /// deferred until the number of queued operations goes below the limit. + /// + /// + public FollowRequestDescriptor MaxWriteBufferCount(int? maxWriteBufferCount) { MaxWriteBufferCountValue = maxWriteBufferCount; return Self; } - public FollowRequestDescriptor MaxWriteBufferSize(string? maxWriteBufferSize) + /// + /// + /// The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will + /// be deferred until the total bytes of queued operations goes below the limit. + /// + /// + public FollowRequestDescriptor MaxWriteBufferSize(Elastic.Clients.Elasticsearch.ByteSize? maxWriteBufferSize) { MaxWriteBufferSizeValue = maxWriteBufferSize; return Self; } - public FollowRequestDescriptor MaxWriteRequestOperationCount(long? maxWriteRequestOperationCount) + /// + /// + /// The maximum number of operations per bulk write request executed on the follower. + /// + /// + public FollowRequestDescriptor MaxWriteRequestOperationCount(int? maxWriteRequestOperationCount) { MaxWriteRequestOperationCountValue = maxWriteRequestOperationCount; return Self; } - public FollowRequestDescriptor MaxWriteRequestSize(string? maxWriteRequestSize) + /// + /// + /// The maximum total bytes of operations per bulk write request executed on the follower. + /// + /// + public FollowRequestDescriptor MaxWriteRequestSize(Elastic.Clients.Elasticsearch.ByteSize? maxWriteRequestSize) { MaxWriteRequestSizeValue = maxWriteRequestSize; return Self; } + /// + /// + /// The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. + /// When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. + /// Then the follower will immediately attempt to read from the leader again. + /// + /// public FollowRequestDescriptor ReadPollTimeout(Elastic.Clients.Elasticsearch.Duration? readPollTimeout) { ReadPollTimeoutValue = readPollTimeout; return Self; } - public FollowRequestDescriptor RemoteCluster(string? remoteCluster) + /// + /// + /// The remote cluster containing the leader index. + /// + /// + public FollowRequestDescriptor RemoteCluster(string remoteCluster) { RemoteClusterValue = remoteCluster; return Self; } + /// + /// + /// Settings to override from the leader index. + /// + /// + public FollowRequestDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettings? settings) + { + SettingsDescriptor = null; + SettingsDescriptorAction = null; + SettingsValue = settings; + return Self; + } + + public FollowRequestDescriptor Settings(Elastic.Clients.Elasticsearch.IndexManagement.IndexSettingsDescriptor descriptor) + { + SettingsValue = null; + SettingsDescriptorAction = null; + SettingsDescriptor = descriptor; + return Self; + } + + public FollowRequestDescriptor Settings(Action configure) + { + SettingsValue = null; + SettingsDescriptor = null; + SettingsDescriptorAction = configure; + return Self; + } + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); - if (LeaderIndexValue is not null) + if (!string.IsNullOrEmpty(DataStreamNameValue)) { - writer.WritePropertyName("leader_index"); - JsonSerializer.Serialize(writer, LeaderIndexValue, options); + writer.WritePropertyName("data_stream_name"); + writer.WriteStringValue(DataStreamNameValue); } + writer.WritePropertyName("leader_index"); + JsonSerializer.Serialize(writer, LeaderIndexValue, options); if (MaxOutstandingReadRequestsValue.HasValue) { writer.WritePropertyName("max_outstanding_read_requests"); @@ -430,10 +763,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(MaxReadRequestOperationCountValue.Value); } - if (!string.IsNullOrEmpty(MaxReadRequestSizeValue)) + if (MaxReadRequestSizeValue is not null) { writer.WritePropertyName("max_read_request_size"); - writer.WriteStringValue(MaxReadRequestSizeValue); + JsonSerializer.Serialize(writer, MaxReadRequestSizeValue, options); } if (MaxRetryDelayValue is not null) @@ -448,10 +781,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(MaxWriteBufferCountValue.Value); } - if (!string.IsNullOrEmpty(MaxWriteBufferSizeValue)) + if (MaxWriteBufferSizeValue is not null) { writer.WritePropertyName("max_write_buffer_size"); - writer.WriteStringValue(MaxWriteBufferSizeValue); + JsonSerializer.Serialize(writer, MaxWriteBufferSizeValue, options); } if (MaxWriteRequestOperationCountValue.HasValue) @@ -460,10 +793,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(MaxWriteRequestOperationCountValue.Value); } - if (!string.IsNullOrEmpty(MaxWriteRequestSizeValue)) + if (MaxWriteRequestSizeValue is not null) { writer.WritePropertyName("max_write_request_size"); - writer.WriteStringValue(MaxWriteRequestSizeValue); + JsonSerializer.Serialize(writer, MaxWriteRequestSizeValue, options); } if (ReadPollTimeoutValue is not null) @@ -472,10 +805,22 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, ReadPollTimeoutValue, options); } - if (!string.IsNullOrEmpty(RemoteClusterValue)) + writer.WritePropertyName("remote_cluster"); + writer.WriteStringValue(RemoteClusterValue); + if (SettingsDescriptor is not null) + { + writer.WritePropertyName("settings"); + JsonSerializer.Serialize(writer, SettingsDescriptor, options); + } + else if (SettingsDescriptorAction is not null) + { + writer.WritePropertyName("settings"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.IndexManagement.IndexSettingsDescriptor(SettingsDescriptorAction), options); + } + else if (SettingsValue is not null) { - writer.WritePropertyName("remote_cluster"); - writer.WriteStringValue(RemoteClusterValue); + writer.WritePropertyName("settings"); + JsonSerializer.Serialize(writer, SettingsValue, options); } writer.WriteEndObject(); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DanglingIndices/ListDanglingIndicesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DanglingIndices/ListDanglingIndicesRequest.g.cs index d7bfa075ba..651b65cef0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DanglingIndices/ListDanglingIndicesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DanglingIndices/ListDanglingIndicesRequest.g.cs @@ -36,7 +36,14 @@ public sealed partial class ListDanglingIndicesRequestParameters : RequestParame /// /// -/// Returns all dangling indices. +/// Get the dangling indices. +/// +/// +/// If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. +/// For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline. +/// +/// +/// Use this API to list dangling indices, which you can then import or delete. /// /// public sealed partial class ListDanglingIndicesRequest : PlainRequest @@ -52,7 +59,14 @@ public sealed partial class ListDanglingIndicesRequest : PlainRequest /// -/// Returns all dangling indices. +/// Get the dangling indices. +/// +/// +/// If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. +/// For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline. +/// +/// +/// Use this API to list dangling indices, which you can then import or delete. /// /// public sealed partial class ListDanglingIndicesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs index e425b31ccc..2b09f0d917 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/DeleteByQueryRethrottleRequest.g.cs @@ -42,7 +42,11 @@ public sealed partial class DeleteByQueryRethrottleRequestParameters : RequestPa /// /// -/// Changes the number of requests per second for a particular Delete By Query operation. +/// Throttle a delete by query operation. +/// +/// +/// Change the number of requests per second for a particular delete by query operation. +/// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// public sealed partial class DeleteByQueryRethrottleRequest : PlainRequest @@ -70,7 +74,11 @@ public DeleteByQueryRethrottleRequest(Elastic.Clients.Elasticsearch.TaskId taskI /// /// -/// Changes the number of requests per second for a particular Delete By Query operation. +/// Throttle a delete by query operation. +/// +/// +/// Change the number of requests per second for a particular delete by query operation. +/// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// public sealed partial class DeleteByQueryRethrottleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchRequest.g.cs index c5e18996c7..20a29d1a6c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchRequest.g.cs @@ -115,6 +115,16 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r [JsonInclude, JsonPropertyName("keep_on_completion")] public bool? KeepOnCompletion { get; set; } + /// + /// + /// By default, the response of a sample query contains up to 10 samples, with one sample per unique set of join keys. Use the size + /// parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the + /// max_samples_per_key parameter. Pipes are not supported for sample queries. + /// + /// + [JsonInclude, JsonPropertyName("max_samples_per_key")] + public int? MaxSamplesPerKey { get; set; } + /// /// /// EQL query you wish to run. @@ -202,6 +212,7 @@ public EqlSearchRequestDescriptor Indices(Elastic.Clients.Elasticsear private Action>[] FilterDescriptorActions { get; set; } private Elastic.Clients.Elasticsearch.Duration? KeepAliveValue { get; set; } private bool? KeepOnCompletionValue { get; set; } + private int? MaxSamplesPerKeyValue { get; set; } private string QueryValue { get; set; } private Elastic.Clients.Elasticsearch.Eql.ResultPosition? ResultPositionValue { get; set; } private IDictionary> RuntimeMappingsValue { get; set; } @@ -354,6 +365,19 @@ public EqlSearchRequestDescriptor KeepOnCompletion(bool? keepOnComple return Self; } + /// + /// + /// By default, the response of a sample query contains up to 10 samples, with one sample per unique set of join keys. Use the size + /// parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the + /// max_samples_per_key parameter. Pipes are not supported for sample queries. + /// + /// + public EqlSearchRequestDescriptor MaxSamplesPerKey(int? maxSamplesPerKey) + { + MaxSamplesPerKeyValue = maxSamplesPerKey; + return Self; + } + /// /// /// EQL query you wish to run. @@ -551,6 +575,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteBooleanValue(KeepOnCompletionValue.Value); } + if (MaxSamplesPerKeyValue.HasValue) + { + writer.WritePropertyName("max_samples_per_key"); + writer.WriteNumberValue(MaxSamplesPerKeyValue.Value); + } + writer.WritePropertyName("query"); writer.WriteStringValue(QueryValue); if (ResultPositionValue is not null) @@ -637,6 +667,7 @@ public EqlSearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices private Action[] FilterDescriptorActions { get; set; } private Elastic.Clients.Elasticsearch.Duration? KeepAliveValue { get; set; } private bool? KeepOnCompletionValue { get; set; } + private int? MaxSamplesPerKeyValue { get; set; } private string QueryValue { get; set; } private Elastic.Clients.Elasticsearch.Eql.ResultPosition? ResultPositionValue { get; set; } private IDictionary RuntimeMappingsValue { get; set; } @@ -789,6 +820,19 @@ public EqlSearchRequestDescriptor KeepOnCompletion(bool? keepOnCompletion = true return Self; } + /// + /// + /// By default, the response of a sample query contains up to 10 samples, with one sample per unique set of join keys. Use the size + /// parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the + /// max_samples_per_key parameter. Pipes are not supported for sample queries. + /// + /// + public EqlSearchRequestDescriptor MaxSamplesPerKey(int? maxSamplesPerKey) + { + MaxSamplesPerKeyValue = maxSamplesPerKey; + return Self; + } + /// /// /// EQL query you wish to run. @@ -986,6 +1030,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteBooleanValue(KeepOnCompletionValue.Value); } + if (MaxSamplesPerKeyValue.HasValue) + { + writer.WritePropertyName("max_samples_per_key"); + writer.WriteNumberValue(MaxSamplesPerKeyValue.Value); + } + writer.WritePropertyName("query"); writer.WriteStringValue(QueryValue); if (ResultPositionValue is not null) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/FieldCapsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/FieldCapsRequest.g.cs index 4ff7e9fbd9..40ca0aa914 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/FieldCapsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/FieldCapsRequest.g.cs @@ -86,9 +86,15 @@ public sealed partial class FieldCapsRequestParameters : RequestParameters /// /// -/// The field capabilities API returns the information about the capabilities of fields among multiple indices. -/// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type -/// of keyword is returned as any other field that belongs to the keyword family. +/// Get the field capabilities. +/// +/// +/// Get information about the capabilities of fields among multiple indices. +/// +/// +/// For data streams, the API returns field capabilities among the stream’s backing indices. +/// It returns runtime fields like any other field. +/// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// public sealed partial class FieldCapsRequest : PlainRequest @@ -196,9 +202,15 @@ public FieldCapsRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r /// /// -/// The field capabilities API returns the information about the capabilities of fields among multiple indices. -/// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type -/// of keyword is returned as any other field that belongs to the keyword family. +/// Get the field capabilities. +/// +/// +/// Get information about the capabilities of fields among multiple indices. +/// +/// +/// For data streams, the API returns field capabilities among the stream’s backing indices. +/// It returns runtime fields like any other field. +/// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// public sealed partial class FieldCapsRequestDescriptor : RequestDescriptor, FieldCapsRequestParameters> @@ -330,9 +342,15 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// The field capabilities API returns the information about the capabilities of fields among multiple indices. -/// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type -/// of keyword is returned as any other field that belongs to the keyword family. +/// Get the field capabilities. +/// +/// +/// Get information about the capabilities of fields among multiple indices. +/// +/// +/// For data streams, the API returns field capabilities among the stream’s backing indices. +/// It returns runtime fields like any other field. +/// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// public sealed partial class FieldCapsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptContextRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptContextRequest.g.cs index 57912b0d58..4364f3b5fe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptContextRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptContextRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class GetScriptContextRequestParameters : RequestParameter /// /// -/// Returns all script contexts. +/// Get script contexts. +/// +/// +/// Get a list of supported script contexts and their methods. /// /// public sealed partial class GetScriptContextRequest : PlainRequest @@ -52,7 +55,10 @@ public sealed partial class GetScriptContextRequest : PlainRequest /// -/// Returns all script contexts. +/// Get script contexts. +/// +/// +/// Get a list of supported script contexts and their methods. /// /// public sealed partial class GetScriptContextRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptLanguagesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptLanguagesRequest.g.cs index fe59cc63fa..eb6c1779d1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptLanguagesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/GetScriptLanguagesRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class GetScriptLanguagesRequestParameters : RequestParamet /// /// -/// Returns available script types, languages and contexts +/// Get script languages. +/// +/// +/// Get a list of available script types, languages, and contexts. /// /// public sealed partial class GetScriptLanguagesRequest : PlainRequest @@ -52,7 +55,10 @@ public sealed partial class GetScriptLanguagesRequest : PlainRequest /// -/// Returns available script types, languages and contexts +/// Get script languages. +/// +/// +/// Get a list of available script types, languages, and contexts. /// /// public sealed partial class GetScriptLanguagesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs index 03931786ce..0a17e30d21 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class AnalyzeIndexRequestParameters : RequestParameters /// /// -/// Performs analysis on a text string and returns the resulting tokens. +/// Get tokens from text analysis. +/// The analyze API performs analysis on a text string and returns the resulting tokens. /// /// public sealed partial class AnalyzeIndexRequest : PlainRequest @@ -137,7 +138,8 @@ public AnalyzeIndexRequest(Elastic.Clients.Elasticsearch.IndexName? index) : bas /// /// -/// Performs analysis on a text string and returns the resulting tokens. +/// Get tokens from text analysis. +/// The analyze API performs analysis on a text string and returns the resulting tokens. /// /// public sealed partial class AnalyzeIndexRequestDescriptor : RequestDescriptor, AnalyzeIndexRequestParameters> @@ -368,7 +370,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Performs analysis on a text string and returns the resulting tokens. +/// Get tokens from text analysis. +/// The analyze API performs analysis on a text string and returns the resulting tokens. /// /// public sealed partial class AnalyzeIndexRequestDescriptor : 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 6edfd5890c..497533fe19 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs @@ -56,13 +56,6 @@ public sealed partial class ExistsAliasRequestParameters : RequestParameters /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - - /// - /// - /// If true, the request retrieves information from the local node only. - /// - /// - public bool? Local { get => Q("local"); set => Q("local", value); } } /// @@ -116,14 +109,6 @@ public ExistsAliasRequest(Elastic.Clients.Elasticsearch.Indices? indices, Elasti /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - - /// - /// - /// If true, the request retrieves information from the local node only. - /// - /// - [JsonIgnore] - public bool? Local { get => Q("local"); set => Q("local", value); } } /// @@ -155,7 +140,6 @@ public ExistsAliasRequestDescriptor(Elastic.Clients.Elasticsearch.Names name) : public ExistsAliasRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); public ExistsAliasRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public ExistsAliasRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public ExistsAliasRequestDescriptor Local(bool? local = true) => Qs("local", local); public ExistsAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -203,7 +187,6 @@ public ExistsAliasRequestDescriptor(Elastic.Clients.Elasticsearch.Names name) : public ExistsAliasRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); public ExistsAliasRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public ExistsAliasRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public ExistsAliasRequestDescriptor Local(bool? local = true) => Qs("local", local); public ExistsAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { 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 cf9ce0876a..dde2e261da 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs @@ -56,13 +56,6 @@ public sealed partial class GetAliasRequestParameters : RequestParameters /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - - /// - /// - /// If true, the request retrieves information from the local node only. - /// - /// - public bool? Local { get => Q("local"); set => Q("local", value); } } /// @@ -124,14 +117,6 @@ public GetAliasRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - - /// - /// - /// If true, the request retrieves information from the local node only. - /// - /// - [JsonIgnore] - public bool? Local { get => Q("local"); set => Q("local", value); } } /// @@ -163,7 +148,6 @@ public GetAliasRequestDescriptor() public GetAliasRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); public GetAliasRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public GetAliasRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public GetAliasRequestDescriptor Local(bool? local = true) => Qs("local", local); public GetAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -211,7 +195,6 @@ public GetAliasRequestDescriptor() public GetAliasRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); public GetAliasRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public GetAliasRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public GetAliasRequestDescriptor Local(bool? local = true) => Qs("local", local); public GetAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { 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 34af04025a..85d023869c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutDataLifecycleRequest.g.cs @@ -65,7 +65,7 @@ public sealed partial class PutDataLifecycleRequestParameters : RequestParameter /// Update the data stream lifecycle of the specified data streams. /// /// -public sealed partial class PutDataLifecycleRequest : PlainRequest +public sealed partial class PutDataLifecycleRequest : PlainRequest, ISelfSerializable { public PutDataLifecycleRequest(Elastic.Clients.Elasticsearch.DataStreamNames name) : base(r => r.Required("name", name)) { @@ -107,25 +107,13 @@ public PutDataLifecycleRequest(Elastic.Clients.Elasticsearch.DataStreamNames nam /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + [JsonIgnore] + public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle Lifecycle { 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. - /// - /// - [JsonInclude, JsonPropertyName("data_retention")] - public Elastic.Clients.Elasticsearch.Duration? DataRetention { get; set; } - - /// - /// - /// If defined, every backing index will execute the configured downsampling configuration after the backing - /// index is not the data stream write index anymore. - /// - /// - [JsonInclude, JsonPropertyName("downsampling")] - public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsampling? Downsampling { get; set; } + void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + JsonSerializer.Serialize(writer, Lifecycle, options); + } } /// @@ -137,10 +125,7 @@ public PutDataLifecycleRequest(Elastic.Clients.Elasticsearch.DataStreamNames nam public sealed partial class PutDataLifecycleRequestDescriptor : RequestDescriptor { internal PutDataLifecycleRequestDescriptor(Action configure) => configure.Invoke(this); - - public PutDataLifecycleRequestDescriptor(Elastic.Clients.Elasticsearch.DataStreamNames name) : base(r => r.Required("name", name)) - { - } + public PutDataLifecycleRequestDescriptor(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle lifecycle, Elastic.Clients.Elasticsearch.DataStreamNames name) : base(r => r.Required("name", name)) => LifecycleValue = lifecycle; internal override ApiUrls ApiUrls => ApiUrlLookup.IndexManagementPutDataLifecycle; @@ -160,79 +145,36 @@ public PutDataLifecycleRequestDescriptor Name(Elastic.Clients.Elasticsearch.Data return Self; } - private Elastic.Clients.Elasticsearch.Duration? DataRetentionValue { get; set; } - private Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsampling? DownsamplingValue { get; set; } - private Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsamplingDescriptor DownsamplingDescriptor { get; set; } - private Action DownsamplingDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle LifecycleValue { get; set; } + private Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDescriptor LifecycleDescriptor { get; set; } + private Action LifecycleDescriptorAction { 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; - return Self; - } - - /// - /// - /// If defined, every backing index will execute the configured downsampling configuration after the backing - /// index is not the data stream write index anymore. - /// - /// - public PutDataLifecycleRequestDescriptor Downsampling(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsampling? downsampling) + public PutDataLifecycleRequestDescriptor Lifecycle(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle lifecycle) { - DownsamplingDescriptor = null; - DownsamplingDescriptorAction = null; - DownsamplingValue = downsampling; + LifecycleDescriptor = null; + LifecycleDescriptorAction = null; + LifecycleValue = lifecycle; return Self; } - public PutDataLifecycleRequestDescriptor Downsampling(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsamplingDescriptor descriptor) + public PutDataLifecycleRequestDescriptor Lifecycle(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDescriptor descriptor) { - DownsamplingValue = null; - DownsamplingDescriptorAction = null; - DownsamplingDescriptor = descriptor; + LifecycleValue = null; + LifecycleDescriptorAction = null; + LifecycleDescriptor = descriptor; return Self; } - public PutDataLifecycleRequestDescriptor Downsampling(Action configure) + public PutDataLifecycleRequestDescriptor Lifecycle(Action configure) { - DownsamplingValue = null; - DownsamplingDescriptor = null; - DownsamplingDescriptorAction = configure; + LifecycleValue = null; + LifecycleDescriptor = null; + LifecycleDescriptorAction = configure; return Self; } protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { - writer.WriteStartObject(); - if (DataRetentionValue is not null) - { - writer.WritePropertyName("data_retention"); - JsonSerializer.Serialize(writer, DataRetentionValue, options); - } - - if (DownsamplingDescriptor is not null) - { - writer.WritePropertyName("downsampling"); - JsonSerializer.Serialize(writer, DownsamplingDescriptor, options); - } - else if (DownsamplingDescriptorAction is not null) - { - writer.WritePropertyName("downsampling"); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsamplingDescriptor(DownsamplingDescriptorAction), options); - } - else if (DownsamplingValue is not null) - { - writer.WritePropertyName("downsampling"); - JsonSerializer.Serialize(writer, DownsamplingValue, options); - } - - writer.WriteEndObject(); + JsonSerializer.Serialize(writer, LifecycleValue, options); } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SegmentsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SegmentsRequest.g.cs index 6d61bb45be..b96487dc82 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SegmentsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SegmentsRequest.g.cs @@ -56,13 +56,6 @@ public sealed partial class SegmentsRequestParameters : RequestParameters /// /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - - /// - /// - /// If true, the request returns a verbose response. - /// - /// - public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// @@ -116,14 +109,6 @@ public SegmentsRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - - /// - /// - /// If true, the request returns a verbose response. - /// - /// - [JsonIgnore] - public bool? Verbose { get => Q("verbose"); set => Q("verbose", value); } } /// @@ -155,7 +140,6 @@ public SegmentsRequestDescriptor() public SegmentsRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); public SegmentsRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public SegmentsRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public SegmentsRequestDescriptor Verbose(bool? verbose = true) => Qs("verbose", verbose); public SegmentsRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -197,7 +181,6 @@ public SegmentsRequestDescriptor() public SegmentsRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); public SegmentsRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public SegmentsRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public SegmentsRequestDescriptor Verbose(bool? verbose = true) => Qs("verbose", verbose); public SegmentsRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs index 1170526449..85695b4b40 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs @@ -254,7 +254,12 @@ public override void Write(Utf8JsonWriter writer, PutDatafeedRequest value, Json /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). -/// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. +/// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had +/// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, +/// those credentials are used instead. +/// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed +/// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// [JsonConverter(typeof(PutDatafeedRequestConverter))] @@ -438,7 +443,12 @@ public PutDatafeedRequest() /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). -/// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. +/// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had +/// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, +/// those credentials are used instead. +/// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed +/// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// public sealed partial class PutDatafeedRequestDescriptor : RequestDescriptor, PutDatafeedRequestParameters> @@ -871,7 +881,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). -/// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. +/// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. +/// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had +/// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, +/// those credentials are used instead. +/// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed +/// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// public sealed partial class PutDatafeedRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiGetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiGetRequest.g.cs index 479a8447f3..192b345d95 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiGetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiGetRequest.g.cs @@ -103,7 +103,12 @@ public sealed partial class MultiGetRequestParameters : RequestParameters /// /// -/// Allows to get multiple documents in one request. +/// Get multiple documents. +/// +/// +/// Get multiple JSON documents by ID from one or more indices. +/// If you specify an index in the request URI, you only need to specify the document IDs in the request body. +/// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// public sealed partial class MultiGetRequest : PlainRequest @@ -220,7 +225,12 @@ public MultiGetRequest(Elastic.Clients.Elasticsearch.IndexName? index) : base(r /// /// -/// Allows to get multiple documents in one request. +/// Get multiple documents. +/// +/// +/// Get multiple JSON documents by ID from one or more indices. +/// If you specify an index in the request URI, you only need to specify the document IDs in the request body. +/// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// public sealed partial class MultiGetRequestDescriptor : RequestDescriptor, MultiGetRequestParameters> @@ -363,7 +373,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Allows to get multiple documents in one request. +/// Get multiple documents. +/// +/// +/// Get multiple JSON documents by ID from one or more indices. +/// If you specify an index in the request URI, you only need to specify the document IDs in the request body. +/// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// public sealed partial class MultiGetRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchRequest.g.cs index 0142870ccb..526b27fa61 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchRequest.g.cs @@ -121,7 +121,25 @@ public sealed partial class MultiSearchRequestParameters : RequestParameters /// /// -/// Allows to execute several search operations in one request. +/// Run multiple searches. +/// +/// +/// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. +/// The structure is as follows: +/// +/// +/// header\n +/// body\n +/// header\n +/// body\n +/// +/// +/// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. +/// +/// +/// IMPORTANT: The final line of data must end with a newline character \n. +/// Each newline character may be preceded by a carriage return \r. +/// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// public sealed partial class MultiSearchRequest : PlainRequest, IStreamSerializable @@ -264,7 +282,25 @@ async Task IStreamSerializable.SerializeAsync(Stream stream, IElasticsearchClien /// /// -/// Allows to execute several search operations in one request. +/// Run multiple searches. +/// +/// +/// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. +/// The structure is as follows: +/// +/// +/// header\n +/// body\n +/// header\n +/// body\n +/// +/// +/// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. +/// +/// +/// IMPORTANT: The final line of data must end with a newline character \n. +/// Each newline character may be preceded by a carriage return \r. +/// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// public sealed partial class MultiSearchRequestDescriptor : RequestDescriptor, MultiSearchRequestParameters>, IStreamSerializable @@ -343,7 +379,25 @@ public MultiSearchRequestDescriptor AddSearches(Elastic.Clients.Elast /// /// -/// Allows to execute several search operations in one request. +/// Run multiple searches. +/// +/// +/// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. +/// The structure is as follows: +/// +/// +/// header\n +/// body\n +/// header\n +/// body\n +/// +/// +/// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. +/// +/// +/// IMPORTANT: The final line of data must end with a newline character \n. +/// Each newline character may be preceded by a carriage return \r. +/// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// public sealed partial class MultiSearchRequestDescriptor : RequestDescriptor, IStreamSerializable diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchTemplateRequest.g.cs index c987991b8c..2c558db006 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiSearchTemplateRequest.g.cs @@ -74,7 +74,7 @@ public sealed partial class MultiSearchTemplateRequestParameters : RequestParame /// /// -/// Runs multiple templated searches with a single request. +/// Run multiple templated searches. /// /// public sealed partial class MultiSearchTemplateRequest : PlainRequest, IStreamSerializable @@ -163,7 +163,7 @@ async Task IStreamSerializable.SerializeAsync(Stream stream, IElasticsearchClien /// /// -/// Runs multiple templated searches with a single request. +/// Run multiple templated searches. /// /// public sealed partial class MultiSearchTemplateRequestDescriptor : RequestDescriptor, MultiSearchTemplateRequestParameters>, IStreamSerializable @@ -235,7 +235,7 @@ public MultiSearchTemplateRequestDescriptor AddSearchTemplates(Elasti /// /// -/// Runs multiple templated searches with a single request. +/// Run multiple templated searches. /// /// public sealed partial class MultiSearchTemplateRequestDescriptor : RequestDescriptor, IStreamSerializable diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiTermVectorsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiTermVectorsRequest.g.cs index 03b4da10f0..9a6c3ba720 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiTermVectorsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiTermVectorsRequest.g.cs @@ -114,7 +114,13 @@ public sealed partial class MultiTermVectorsRequestParameters : RequestParameter /// /// -/// Returns multiple termvectors in one request. +/// Get multiple term vectors. +/// +/// +/// You can specify existing documents by index and ID or provide artificial documents in the body of the request. +/// You can specify the index in the request body or request URI. +/// The response contains a docs array with all the fetched termvectors. +/// Each element has the structure provided by the termvectors API. /// /// public sealed partial class MultiTermVectorsRequest : PlainRequest @@ -244,7 +250,13 @@ public MultiTermVectorsRequest(Elastic.Clients.Elasticsearch.IndexName? index) : /// /// -/// Returns multiple termvectors in one request. +/// Get multiple term vectors. +/// +/// +/// You can specify existing documents by index and ID or provide artificial documents in the body of the request. +/// You can specify the index in the request body or request URI. +/// The response contains a docs array with all the fetched termvectors. +/// Each element has the structure provided by the termvectors API. /// /// public sealed partial class MultiTermVectorsRequestDescriptor : RequestDescriptor, MultiTermVectorsRequestParameters> @@ -389,7 +401,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns multiple termvectors in one request. +/// Get multiple term vectors. +/// +/// +/// You can specify existing documents by index and ID or provide artificial documents in the body of the request. +/// You can specify the index in the request body or request URI. +/// The response contains a docs array with all the fetched termvectors. +/// Each element has the structure provided by the termvectors API. /// /// public sealed partial class MultiTermVectorsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/OpenPointInTimeRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/OpenPointInTimeRequest.g.cs index 7eba519c3b..14c783d145 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/OpenPointInTimeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/OpenPointInTimeRequest.g.cs @@ -73,13 +73,20 @@ public sealed partial class OpenPointInTimeRequestParameters : RequestParameters /// /// -/// A search request by default executes against the most recent visible data of the target indices, +/// Open a point in time. +/// +/// +/// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// +/// +/// A point in time must be opened explicitly before being used in search requests. +/// The keep_alive parameter tells Elasticsearch how long it should persist. +/// /// public sealed partial class OpenPointInTimeRequest : PlainRequest { @@ -149,13 +156,20 @@ public OpenPointInTimeRequest(Elastic.Clients.Elasticsearch.Indices indices) : b /// /// -/// A search request by default executes against the most recent visible data of the target indices, +/// Open a point in time. +/// +/// +/// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// +/// +/// A point in time must be opened explicitly before being used in search requests. +/// The keep_alive parameter tells Elasticsearch how long it should persist. +/// /// public sealed partial class OpenPointInTimeRequestDescriptor : RequestDescriptor, OpenPointInTimeRequestParameters> { @@ -247,13 +261,20 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// A search request by default executes against the most recent visible data of the target indices, +/// Open a point in time. +/// +/// +/// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// +/// +/// A point in time must be opened explicitly before being used in search requests. +/// The keep_alive parameter tells Elasticsearch how long it should persist. +/// /// public sealed partial class OpenPointInTimeRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/TestRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/TestRequest.g.cs new file mode 100644 index 0000000000..1e726728bd --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/TestRequest.g.cs @@ -0,0 +1,102 @@ +// 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.Requests; +using Elastic.Clients.Elasticsearch.Serialization; +using Elastic.Transport; +using Elastic.Transport.Extensions; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.QueryRules; + +public sealed partial class TestRequestParameters : RequestParameters +{ +} + +/// +/// +/// Creates or updates a query ruleset. +/// +/// +public sealed partial class TestRequest : PlainRequest +{ + public TestRequest(Elastic.Clients.Elasticsearch.Id rulesetId) : base(r => r.Required("ruleset_id", rulesetId)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.QueryRulesTest; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => true; + + internal override string OperationName => "query_rules.test"; + + [JsonInclude, JsonPropertyName("match_criteria")] + public IDictionary MatchCriteria { get; set; } +} + +/// +/// +/// Creates or updates a query ruleset. +/// +/// +public sealed partial class TestRequestDescriptor : RequestDescriptor +{ + internal TestRequestDescriptor(Action configure) => configure.Invoke(this); + + public TestRequestDescriptor(Elastic.Clients.Elasticsearch.Id rulesetId) : base(r => r.Required("ruleset_id", rulesetId)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.QueryRulesTest; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => true; + + internal override string OperationName => "query_rules.test"; + + public TestRequestDescriptor RulesetId(Elastic.Clients.Elasticsearch.Id rulesetId) + { + RouteValues.Required("ruleset_id", rulesetId); + return Self; + } + + private IDictionary MatchCriteriaValue { get; set; } + + public TestRequestDescriptor MatchCriteria(Func, FluentDictionary> selector) + { + MatchCriteriaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("match_criteria"); + JsonSerializer.Serialize(writer, MatchCriteriaValue, options); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/TestResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/TestResponse.g.cs new file mode 100644 index 0000000000..6afa8a862e --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/TestResponse.g.cs @@ -0,0 +1,35 @@ +// 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 Elastic.Transport.Products.Elasticsearch; +using System; +using System.Collections.Generic; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.QueryRules; + +public sealed partial class TestResponse : ElasticsearchResponse +{ + [JsonInclude, JsonPropertyName("matched_rules")] + public IReadOnlyCollection MatchedRules { get; init; } + [JsonInclude, JsonPropertyName("total_matched_rules")] + public int TotalMatchedRules { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/RankEvalRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/RankEvalRequest.g.cs index a883c183c8..c42ede2ec9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/RankEvalRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/RankEvalRequest.g.cs @@ -63,7 +63,10 @@ public sealed partial class RankEvalRequestParameters : RequestParameters /// /// -/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// Evaluate ranked search results. +/// +/// +/// Evaluate the quality of ranked search results over a set of typical search queries. /// /// public sealed partial class RankEvalRequest : PlainRequest @@ -135,7 +138,10 @@ public RankEvalRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r /// /// -/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// Evaluate ranked search results. +/// +/// +/// Evaluate the quality of ranked search results over a set of typical search queries. /// /// public sealed partial class RankEvalRequestDescriptor : RequestDescriptor, RankEvalRequestParameters> @@ -303,7 +309,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Enables you to evaluate the quality of ranked search results over a set of typical search queries. +/// Evaluate ranked search results. +/// +/// +/// Evaluate the quality of ranked search results over a set of typical search queries. /// /// public sealed partial class RankEvalRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ReindexRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ReindexRethrottleRequest.g.cs index c5b605c9aa..88bf92f8d8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ReindexRethrottleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ReindexRethrottleRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class ReindexRethrottleRequestParameters : RequestParamete /// /// -/// Copies documents from a source to a destination. +/// Throttle a reindex operation. +/// +/// +/// Change the number of requests per second for a particular reindex operation. /// /// public sealed partial class ReindexRethrottleRequest : PlainRequest @@ -70,7 +73,10 @@ public ReindexRethrottleRequest(Elastic.Clients.Elasticsearch.Id taskId) : base( /// /// -/// Copies documents from a source to a destination. +/// Throttle a reindex operation. +/// +/// +/// Change the number of requests per second for a particular reindex operation. /// /// public sealed partial class ReindexRethrottleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/RenderSearchTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/RenderSearchTemplateRequest.g.cs index 3271a22412..26361bc0ec 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/RenderSearchTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/RenderSearchTemplateRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class RenderSearchTemplateRequestParameters : RequestParam /// /// -/// Renders a search template as a search request body. +/// Render a search template. +/// +/// +/// Render a search template as a search request body. /// /// public sealed partial class RenderSearchTemplateRequest : PlainRequest @@ -84,7 +87,10 @@ public RenderSearchTemplateRequest(Elastic.Clients.Elasticsearch.Id? id) : base( /// /// -/// Renders a search template as a search request body. +/// Render a search template. +/// +/// +/// Render a search template as a search request body. /// /// public sealed partial class RenderSearchTemplateRequestDescriptor : RequestDescriptor, RenderSearchTemplateRequestParameters> @@ -177,7 +183,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Renders a search template as a search request body. +/// Render a search template. +/// +/// +/// Render a search template as a search request body. /// /// public sealed partial class RenderSearchTemplateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScrollRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScrollRequest.g.cs index 1d1f64d6ab..71eeba5ada 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScrollRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScrollRequest.g.cs @@ -42,7 +42,24 @@ public sealed partial class ScrollRequestParameters : RequestParameters /// /// -/// Allows to retrieve a large numbers of results from a single search request. +/// Run a scrolling search. +/// +/// +/// IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the search_after parameter with a point in time (PIT). +/// +/// +/// The scroll API gets large sets of results from a single scrolling search request. +/// To get the necessary scroll ID, submit a search API request that includes an argument for the scroll query parameter. +/// The scroll parameter indicates how long Elasticsearch should retain the search context for the request. +/// The search response returns a scroll ID in the _scroll_id response body parameter. +/// You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. +/// If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. +/// +/// +/// You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. +/// +/// +/// IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. /// /// public sealed partial class ScrollRequest : PlainRequest @@ -82,7 +99,24 @@ public sealed partial class ScrollRequest : PlainRequest /// -/// Allows to retrieve a large numbers of results from a single search request. +/// Run a scrolling search. +/// +/// +/// IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the search_after parameter with a point in time (PIT). +/// +/// +/// The scroll API gets large sets of results from a single scrolling search request. +/// To get the necessary scroll ID, submit a search API request that includes an argument for the scroll query parameter. +/// The scroll parameter indicates how long Elasticsearch should retain the search context for the request. +/// The search response returns a scroll ID in the _scroll_id response body parameter. +/// You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. +/// If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. +/// +/// +/// You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. +/// +/// +/// IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. /// /// public sealed partial class ScrollRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetSearchApplicationResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetSearchApplicationResponse.g.cs index 13bcb8d584..e8dfe37f8c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetSearchApplicationResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/GetSearchApplicationResponse.g.cs @@ -46,7 +46,7 @@ public sealed partial class GetSearchApplicationResponse : ElasticsearchResponse /// /// - /// Search Application name. + /// Search Application name /// /// [JsonInclude, JsonPropertyName("name")] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/ListResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/ListResponse.g.cs index 634f03fc46..c1945b4a69 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/ListResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/ListResponse.g.cs @@ -31,5 +31,5 @@ public sealed partial class ListResponse : ElasticsearchResponse [JsonInclude, JsonPropertyName("count")] public long Count { get; init; } [JsonInclude, JsonPropertyName("results")] - public IReadOnlyCollection Results { get; init; } + public IReadOnlyCollection Results { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutSearchApplicationRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutSearchApplicationRequest.g.cs index 30d3c43450..09736ffa1d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutSearchApplicationRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchApplication/PutSearchApplicationRequest.g.cs @@ -67,7 +67,7 @@ public PutSearchApplicationRequest(Elastic.Clients.Elasticsearch.Name name) : ba [JsonIgnore] public bool? Create { get => Q("create"); set => Q("create", value); } [JsonIgnore] - public Elastic.Clients.Elasticsearch.SearchApplication.SearchApplication SearchApplication { get; set; } + public Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationParameters SearchApplication { get; set; } void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { @@ -83,7 +83,7 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op public sealed partial class PutSearchApplicationRequestDescriptor : RequestDescriptor { internal PutSearchApplicationRequestDescriptor(Action configure) => configure.Invoke(this); - public PutSearchApplicationRequestDescriptor(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplication searchApplication, Elastic.Clients.Elasticsearch.Name name) : base(r => r.Required("name", name)) => SearchApplicationValue = searchApplication; + public PutSearchApplicationRequestDescriptor(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationParameters searchApplication, Elastic.Clients.Elasticsearch.Name name) : base(r => r.Required("name", name)) => SearchApplicationValue = searchApplication; internal override ApiUrls ApiUrls => ApiUrlLookup.SearchApplicationPut; @@ -101,11 +101,11 @@ public PutSearchApplicationRequestDescriptor Name(Elastic.Clients.Elasticsearch. return Self; } - private Elastic.Clients.Elasticsearch.SearchApplication.SearchApplication SearchApplicationValue { get; set; } - private Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationDescriptor SearchApplicationDescriptor { get; set; } - private Action SearchApplicationDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationParameters SearchApplicationValue { get; set; } + private Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationParametersDescriptor SearchApplicationDescriptor { get; set; } + private Action SearchApplicationDescriptorAction { get; set; } - public PutSearchApplicationRequestDescriptor SearchApplication(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplication searchApplication) + public PutSearchApplicationRequestDescriptor SearchApplication(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationParameters searchApplication) { SearchApplicationDescriptor = null; SearchApplicationDescriptorAction = null; @@ -113,7 +113,7 @@ public PutSearchApplicationRequestDescriptor SearchApplication(Elastic.Clients.E return Self; } - public PutSearchApplicationRequestDescriptor SearchApplication(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationDescriptor descriptor) + public PutSearchApplicationRequestDescriptor SearchApplication(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationParametersDescriptor descriptor) { SearchApplicationValue = null; SearchApplicationDescriptorAction = null; @@ -121,7 +121,7 @@ public PutSearchApplicationRequestDescriptor SearchApplication(Elastic.Clients.E return Self; } - public PutSearchApplicationRequestDescriptor SearchApplication(Action configure) + public PutSearchApplicationRequestDescriptor SearchApplication(Action configure) { SearchApplicationValue = null; SearchApplicationDescriptor = null; diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchMvtRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchMvtRequest.g.cs index 7e67b3cc67..2863e25726 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchMvtRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchMvtRequest.g.cs @@ -37,7 +37,9 @@ public sealed partial class SearchMvtRequestParameters : RequestParameters /// /// /// Search a vector tile. -/// Searches a vector tile for geospatial values. +/// +/// +/// Search a vector tile for geospatial values. /// /// public sealed partial class SearchMvtRequest : PlainRequest @@ -221,7 +223,9 @@ public SearchMvtRequest(Elastic.Clients.Elasticsearch.Indices indices, Elastic.C /// /// /// Search a vector tile. -/// Searches a vector tile for geospatial values. +/// +/// +/// Search a vector tile for geospatial values. /// /// public sealed partial class SearchMvtRequestDescriptor : RequestDescriptor, SearchMvtRequestParameters> @@ -672,7 +676,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// /// Search a vector tile. -/// Searches a vector tile for geospatial values. +/// +/// +/// Search a vector tile for geospatial values. /// /// public sealed partial class SearchMvtRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchRequest.g.cs index 31266e7e69..7c11901438 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchRequest.g.cs @@ -143,14 +143,6 @@ public sealed partial class SearchRequestParameters : RequestParameters /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } - /// - /// - /// The minimum version of the node that can handle the request - /// Any handling node with a lower version will fail the request. - /// - /// - public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } - /// /// /// Nodes and shards used for the search. @@ -715,7 +707,10 @@ public override void Write(Utf8JsonWriter writer, SearchRequest value, JsonSeria /// /// -/// Returns search hits that match the query defined in the request. +/// Run a search. +/// +/// +/// Get 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. /// @@ -864,15 +859,6 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => [JsonIgnore] public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } - /// - /// - /// The minimum version of the node that can handle the request - /// Any handling node with a lower version will fail the request. - /// - /// - [JsonIgnore] - public string? MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } - /// /// /// Nodes and shards used for the search. @@ -1326,7 +1312,10 @@ public SearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => /// /// -/// Returns search hits that match the query defined in the request. +/// Run a search. +/// +/// +/// Get 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. /// @@ -1365,7 +1354,6 @@ public SearchRequestDescriptor() public SearchRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); public SearchRequestDescriptor Lenient(bool? lenient = true) => Qs("lenient", lenient); public SearchRequestDescriptor MaxConcurrentShardRequests(long? maxConcurrentShardRequests) => Qs("max_concurrent_shard_requests", maxConcurrentShardRequests); - public SearchRequestDescriptor MinCompatibleShardNode(string? minCompatibleShardNode) => Qs("min_compatible_shard_node", minCompatibleShardNode); public SearchRequestDescriptor Preference(string? preference) => Qs("preference", preference); public SearchRequestDescriptor PreFilterShardSize(long? preFilterShardSize) => Qs("pre_filter_shard_size", preFilterShardSize); public SearchRequestDescriptor QueryLuceneSyntax(string? queryLuceneSyntax) => Qs("q", queryLuceneSyntax); @@ -2594,7 +2582,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns search hits that match the query defined in the request. +/// Run a search. +/// +/// +/// Get 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. /// @@ -2633,7 +2624,6 @@ public SearchRequestDescriptor() public SearchRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); public SearchRequestDescriptor Lenient(bool? lenient = true) => Qs("lenient", lenient); public SearchRequestDescriptor MaxConcurrentShardRequests(long? maxConcurrentShardRequests) => Qs("max_concurrent_shard_requests", maxConcurrentShardRequests); - public SearchRequestDescriptor MinCompatibleShardNode(string? minCompatibleShardNode) => Qs("min_compatible_shard_node", minCompatibleShardNode); public SearchRequestDescriptor Preference(string? preference) => Qs("preference", preference); public SearchRequestDescriptor PreFilterShardSize(long? preFilterShardSize) => Qs("pre_filter_shard_size", preFilterShardSize); public SearchRequestDescriptor QueryLuceneSyntax(string? queryLuceneSyntax) => Qs("q", queryLuceneSyntax); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchShardsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchShardsRequest.g.cs index 7bd1c72a26..9e3baa8588 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchShardsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchShardsRequest.g.cs @@ -83,7 +83,12 @@ public sealed partial class SearchShardsRequestParameters : RequestParameters /// /// -/// Returns information about the indices and shards that a search request would be executed against. +/// Get the search shards. +/// +/// +/// Get the indices and shards that a search request would be run against. +/// This information can be useful for working out issues or planning optimizations with routing and shard preferences. +/// When filtered aliases are used, the filter is returned as part of the indices section. /// /// public sealed partial class SearchShardsRequest : PlainRequest @@ -161,7 +166,12 @@ public SearchShardsRequest(Elastic.Clients.Elasticsearch.Indices? indices) : bas /// /// -/// Returns information about the indices and shards that a search request would be executed against. +/// Get the search shards. +/// +/// +/// Get the indices and shards that a search request would be run against. +/// This information can be useful for working out issues or planning optimizations with routing and shard preferences. +/// When filtered aliases are used, the filter is returned as part of the indices section. /// /// public sealed partial class SearchShardsRequestDescriptor : RequestDescriptor, SearchShardsRequestParameters> @@ -204,7 +214,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns information about the indices and shards that a search request would be executed against. +/// Get the search shards. +/// +/// +/// Get the indices and shards that a search request would be run against. +/// This information can be useful for working out issues or planning optimizations with routing and shard preferences. +/// When filtered aliases are used, the filter is returned as part of the indices section. /// /// public sealed partial class SearchShardsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchTemplateRequest.g.cs index 923f66d1ae..79f27aa043 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchTemplateRequest.g.cs @@ -119,7 +119,7 @@ public sealed partial class SearchTemplateRequestParameters : RequestParameters /// /// -/// Runs a search with a search template. +/// Run a search with a search template. /// /// public sealed partial class SearchTemplateRequest : PlainRequest @@ -283,7 +283,7 @@ public SearchTemplateRequest(Elastic.Clients.Elasticsearch.Indices? indices) : b /// /// -/// Runs a search with a search template. +/// Run a search with a search template. /// /// public sealed partial class SearchTemplateRequestDescriptor : RequestDescriptor, SearchTemplateRequestParameters> @@ -429,7 +429,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Runs a search with a search template. +/// Run a search with a search template. /// /// public sealed partial class SearchTemplateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ActivateUserProfileRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ActivateUserProfileRequest.g.cs index cff16e81b4..6efb0a6afa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ActivateUserProfileRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ActivateUserProfileRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class ActivateUserProfileRequestParameters : RequestParame /// /// -/// Creates or updates a user profile on behalf of another user. +/// Activate a user profile. +/// +/// +/// Create or update a user profile on behalf of another user. /// /// public sealed partial class ActivateUserProfileRequest : PlainRequest @@ -61,7 +64,10 @@ public sealed partial class ActivateUserProfileRequest : PlainRequest /// -/// Creates or updates a user profile on behalf of another user. +/// Activate a user profile. +/// +/// +/// Create or update a user profile on behalf of another user. /// /// public sealed partial class ActivateUserProfileRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/AuthenticateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/AuthenticateRequest.g.cs index ee6d297fcd..e070e72ef8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/AuthenticateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/AuthenticateRequest.g.cs @@ -37,6 +37,8 @@ public sealed partial class AuthenticateRequestParameters : RequestParameters /// /// /// Authenticate a user. +/// +/// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -57,6 +59,8 @@ public sealed partial class AuthenticateRequest : PlainRequest /// /// Authenticate a user. +/// +/// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/BulkDeleteRoleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/BulkDeleteRoleRequest.g.cs index c1b5560347..c078ddfd77 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/BulkDeleteRoleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/BulkDeleteRoleRequest.g.cs @@ -42,6 +42,9 @@ public sealed partial class BulkDeleteRoleRequestParameters : RequestParameters /// /// +/// Bulk delete roles. +/// +/// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -75,6 +78,9 @@ public sealed partial class BulkDeleteRoleRequest : PlainRequest /// +/// Bulk delete roles. +/// +/// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/BulkPutRoleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/BulkPutRoleRequest.g.cs index 120d3068d6..15cd7c4439 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/BulkPutRoleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/BulkPutRoleRequest.g.cs @@ -42,6 +42,9 @@ public sealed partial class BulkPutRoleRequestParameters : RequestParameters /// /// +/// Bulk create or update roles. +/// +/// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -75,6 +78,9 @@ public sealed partial class BulkPutRoleRequest : PlainRequest /// +/// Bulk create or update roles. +/// +/// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -121,6 +127,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// +/// Bulk create or update roles. +/// +/// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ChangePasswordRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ChangePasswordRequest.g.cs index d25c22e0aa..4c48313838 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ChangePasswordRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ChangePasswordRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class ChangePasswordRequestParameters : RequestParameters /// /// -/// Changes the passwords of users in the native realm and built-in users. +/// Change passwords. +/// +/// +/// Change the passwords of users in the native realm and built-in users. /// /// public sealed partial class ChangePasswordRequest : PlainRequest @@ -93,7 +96,10 @@ public ChangePasswordRequest(Elastic.Clients.Elasticsearch.Username? username) : /// /// -/// Changes the passwords of users in the native realm and built-in users. +/// Change passwords. +/// +/// +/// Change the passwords of users in the native realm and built-in users. /// /// public sealed partial class ChangePasswordRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearApiKeyCacheRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearApiKeyCacheRequest.g.cs index a62551acf2..48b0f59887 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearApiKeyCacheRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearApiKeyCacheRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class ClearApiKeyCacheRequestParameters : RequestParameter /// /// -/// Evicts a subset of all entries from the API key cache. +/// Clear the API key cache. +/// +/// +/// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// @@ -57,7 +60,10 @@ public ClearApiKeyCacheRequest(Elastic.Clients.Elasticsearch.Ids ids) : base(r = /// /// -/// Evicts a subset of all entries from the API key cache. +/// Clear the API key cache. +/// +/// +/// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedPrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedPrivilegesRequest.g.cs index a9170d3c2f..19bedb531d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedPrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedPrivilegesRequest.g.cs @@ -36,7 +36,11 @@ public sealed partial class ClearCachedPrivilegesRequestParameters : RequestPara /// /// -/// Evicts application privileges from the native application privileges cache. +/// Clear the privileges cache. +/// +/// +/// Evict privileges from the native application privilege cache. +/// The cache is also automatically cleared for applications that have their privileges updated. /// /// public sealed partial class ClearCachedPrivilegesRequest : PlainRequest @@ -56,7 +60,11 @@ public ClearCachedPrivilegesRequest(Elastic.Clients.Elasticsearch.Name applicati /// /// -/// Evicts application privileges from the native application privileges cache. +/// Clear the privileges cache. +/// +/// +/// Evict privileges from the native application privilege cache. +/// The cache is also automatically cleared for applications that have their privileges updated. /// /// public sealed partial class ClearCachedPrivilegesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedRealmsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedRealmsRequest.g.cs index 6873cadc5f..0687c5d5d4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedRealmsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedRealmsRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class ClearCachedRealmsRequestParameters : RequestParamete /// /// -/// Evicts users from the user cache. Can completely clear the cache or evict specific users. +/// Clear the user cache. +/// +/// +/// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// public sealed partial class ClearCachedRealmsRequest : PlainRequest @@ -70,7 +73,10 @@ public ClearCachedRealmsRequest(Elastic.Clients.Elasticsearch.Names realms) : ba /// /// -/// Evicts users from the user cache. Can completely clear the cache or evict specific users. +/// Clear the user cache. +/// +/// +/// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// public sealed partial class ClearCachedRealmsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedRolesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedRolesRequest.g.cs index 60ef63b37b..1b630f2adf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedRolesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedRolesRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class ClearCachedRolesRequestParameters : RequestParameter /// /// -/// Evicts roles from the native role cache. +/// Clear the roles cache. +/// +/// +/// Evict roles from the native role cache. /// /// public sealed partial class ClearCachedRolesRequest : PlainRequest @@ -56,7 +59,10 @@ public ClearCachedRolesRequest(Elastic.Clients.Elasticsearch.Names name) : base( /// /// -/// Evicts roles from the native role cache. +/// Clear the roles cache. +/// +/// +/// Evict roles from the native role cache. /// /// public sealed partial class ClearCachedRolesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedServiceTokensRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedServiceTokensRequest.g.cs index 9988ce2644..a018b729fd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedServiceTokensRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/ClearCachedServiceTokensRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class ClearCachedServiceTokensRequestParameters : RequestP /// /// -/// Evicts tokens from the service account token caches. +/// Clear service account token caches. +/// +/// +/// Evict a subset of all entries from the service account token caches. /// /// public sealed partial class ClearCachedServiceTokensRequest : PlainRequest @@ -56,7 +59,10 @@ public ClearCachedServiceTokensRequest(string ns, string service, Elastic.Client /// /// -/// Evicts tokens from the service account token caches. +/// Clear service account token caches. +/// +/// +/// Evict a subset of all entries from the service account token caches. /// /// public sealed partial class ClearCachedServiceTokensRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateApiKeyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateApiKeyRequest.g.cs index b09feb4d12..cc79ddf427 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateApiKeyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateApiKeyRequest.g.cs @@ -43,7 +43,9 @@ public sealed partial class CreateApiKeyRequestParameters : RequestParameters /// /// /// Create an API key. -/// Creates an API key for access without requiring basic authentication. +/// +/// +/// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -103,7 +105,9 @@ public sealed partial class CreateApiKeyRequest : PlainRequest /// /// Create an API key. -/// Creates an API key for access without requiring basic authentication. +/// +/// +/// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -210,7 +214,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// /// Create an API key. -/// Creates an API key for access without requiring basic authentication. +/// +/// +/// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateCrossClusterApiKeyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateCrossClusterApiKeyRequest.g.cs new file mode 100644 index 0000000000..2ca3d9d6e1 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateCrossClusterApiKeyRequest.g.cs @@ -0,0 +1,433 @@ +// 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.Requests; +using Elastic.Clients.Elasticsearch.Serialization; +using Elastic.Transport; +using Elastic.Transport.Extensions; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Security; + +public sealed partial class CreateCrossClusterApiKeyRequestParameters : RequestParameters +{ +} + +/// +/// +/// Create a cross-cluster API key. +/// +/// +/// Create an API key of the cross_cluster type for the API key based remote cluster access. +/// A cross_cluster API key cannot be used to authenticate through the REST interface. +/// +/// +/// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. +/// +/// +/// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. +/// +/// +/// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. +/// +/// +/// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. +/// +/// +/// By default, API keys never expire. You can specify expiration information when you create the API keys. +/// +/// +/// Cross-cluster API keys can only be updated with the update cross-cluster API key API. +/// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. +/// +/// +public sealed partial class CreateCrossClusterApiKeyRequest : PlainRequest +{ + internal override ApiUrls ApiUrls => ApiUrlLookup.SecurityCreateCrossClusterApiKey; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => true; + + internal override string OperationName => "security.create_cross_cluster_api_key"; + + /// + /// + /// The access to be granted to this API key. + /// The access is composed of permissions for cross-cluster search and cross-cluster replication. + /// At least one of them must be specified. + /// + /// + /// NOTE: No explicit privileges should be specified for either search or replication access. + /// The creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly. + /// + /// + [JsonInclude, JsonPropertyName("access")] + public Elastic.Clients.Elasticsearch.Security.Access Access { get; set; } + + /// + /// + /// Expiration time for the API key. + /// By default, API keys never expire. + /// + /// + [JsonInclude, JsonPropertyName("expiration")] + public Elastic.Clients.Elasticsearch.Duration? Expiration { get; set; } + + /// + /// + /// Arbitrary metadata that you want to associate with the API key. + /// It supports nested data structure. + /// Within the metadata object, keys beginning with _ are reserved for system usage. + /// + /// + [JsonInclude, JsonPropertyName("metadata")] + public IDictionary? Metadata { get; set; } + + /// + /// + /// Specifies the name for this API key. + /// + /// + [JsonInclude, JsonPropertyName("name")] + public Elastic.Clients.Elasticsearch.Name Name { get; set; } +} + +/// +/// +/// Create a cross-cluster API key. +/// +/// +/// Create an API key of the cross_cluster type for the API key based remote cluster access. +/// A cross_cluster API key cannot be used to authenticate through the REST interface. +/// +/// +/// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. +/// +/// +/// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. +/// +/// +/// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. +/// +/// +/// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. +/// +/// +/// By default, API keys never expire. You can specify expiration information when you create the API keys. +/// +/// +/// Cross-cluster API keys can only be updated with the update cross-cluster API key API. +/// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. +/// +/// +public sealed partial class CreateCrossClusterApiKeyRequestDescriptor : RequestDescriptor, CreateCrossClusterApiKeyRequestParameters> +{ + internal CreateCrossClusterApiKeyRequestDescriptor(Action> configure) => configure.Invoke(this); + + public CreateCrossClusterApiKeyRequestDescriptor() + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.SecurityCreateCrossClusterApiKey; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => true; + + internal override string OperationName => "security.create_cross_cluster_api_key"; + + private Elastic.Clients.Elasticsearch.Security.Access AccessValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.AccessDescriptor AccessDescriptor { get; set; } + private Action> AccessDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.Duration? ExpirationValue { get; set; } + private IDictionary? MetadataValue { get; set; } + private Elastic.Clients.Elasticsearch.Name NameValue { get; set; } + + /// + /// + /// The access to be granted to this API key. + /// The access is composed of permissions for cross-cluster search and cross-cluster replication. + /// At least one of them must be specified. + /// + /// + /// NOTE: No explicit privileges should be specified for either search or replication access. + /// The creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly. + /// + /// + public CreateCrossClusterApiKeyRequestDescriptor Access(Elastic.Clients.Elasticsearch.Security.Access access) + { + AccessDescriptor = null; + AccessDescriptorAction = null; + AccessValue = access; + return Self; + } + + public CreateCrossClusterApiKeyRequestDescriptor Access(Elastic.Clients.Elasticsearch.Security.AccessDescriptor descriptor) + { + AccessValue = null; + AccessDescriptorAction = null; + AccessDescriptor = descriptor; + return Self; + } + + public CreateCrossClusterApiKeyRequestDescriptor Access(Action> configure) + { + AccessValue = null; + AccessDescriptor = null; + AccessDescriptorAction = configure; + return Self; + } + + /// + /// + /// Expiration time for the API key. + /// By default, API keys never expire. + /// + /// + public CreateCrossClusterApiKeyRequestDescriptor Expiration(Elastic.Clients.Elasticsearch.Duration? expiration) + { + ExpirationValue = expiration; + return Self; + } + + /// + /// + /// Arbitrary metadata that you want to associate with the API key. + /// It supports nested data structure. + /// Within the metadata object, keys beginning with _ are reserved for system usage. + /// + /// + public CreateCrossClusterApiKeyRequestDescriptor Metadata(Func, FluentDictionary> selector) + { + MetadataValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + /// + /// + /// Specifies the name for this API key. + /// + /// + public CreateCrossClusterApiKeyRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name name) + { + NameValue = name; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (AccessDescriptor is not null) + { + writer.WritePropertyName("access"); + JsonSerializer.Serialize(writer, AccessDescriptor, options); + } + else if (AccessDescriptorAction is not null) + { + writer.WritePropertyName("access"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.AccessDescriptor(AccessDescriptorAction), options); + } + else + { + writer.WritePropertyName("access"); + JsonSerializer.Serialize(writer, AccessValue, options); + } + + if (ExpirationValue is not null) + { + writer.WritePropertyName("expiration"); + JsonSerializer.Serialize(writer, ExpirationValue, options); + } + + if (MetadataValue is not null) + { + writer.WritePropertyName("metadata"); + JsonSerializer.Serialize(writer, MetadataValue, options); + } + + writer.WritePropertyName("name"); + JsonSerializer.Serialize(writer, NameValue, options); + writer.WriteEndObject(); + } +} + +/// +/// +/// Create a cross-cluster API key. +/// +/// +/// Create an API key of the cross_cluster type for the API key based remote cluster access. +/// A cross_cluster API key cannot be used to authenticate through the REST interface. +/// +/// +/// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. +/// +/// +/// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. +/// +/// +/// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. +/// +/// +/// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. +/// +/// +/// By default, API keys never expire. You can specify expiration information when you create the API keys. +/// +/// +/// Cross-cluster API keys can only be updated with the update cross-cluster API key API. +/// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. +/// +/// +public sealed partial class CreateCrossClusterApiKeyRequestDescriptor : RequestDescriptor +{ + internal CreateCrossClusterApiKeyRequestDescriptor(Action configure) => configure.Invoke(this); + + public CreateCrossClusterApiKeyRequestDescriptor() + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.SecurityCreateCrossClusterApiKey; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => true; + + internal override string OperationName => "security.create_cross_cluster_api_key"; + + private Elastic.Clients.Elasticsearch.Security.Access AccessValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.AccessDescriptor AccessDescriptor { get; set; } + private Action AccessDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.Duration? ExpirationValue { get; set; } + private IDictionary? MetadataValue { get; set; } + private Elastic.Clients.Elasticsearch.Name NameValue { get; set; } + + /// + /// + /// The access to be granted to this API key. + /// The access is composed of permissions for cross-cluster search and cross-cluster replication. + /// At least one of them must be specified. + /// + /// + /// NOTE: No explicit privileges should be specified for either search or replication access. + /// The creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly. + /// + /// + public CreateCrossClusterApiKeyRequestDescriptor Access(Elastic.Clients.Elasticsearch.Security.Access access) + { + AccessDescriptor = null; + AccessDescriptorAction = null; + AccessValue = access; + return Self; + } + + public CreateCrossClusterApiKeyRequestDescriptor Access(Elastic.Clients.Elasticsearch.Security.AccessDescriptor descriptor) + { + AccessValue = null; + AccessDescriptorAction = null; + AccessDescriptor = descriptor; + return Self; + } + + public CreateCrossClusterApiKeyRequestDescriptor Access(Action configure) + { + AccessValue = null; + AccessDescriptor = null; + AccessDescriptorAction = configure; + return Self; + } + + /// + /// + /// Expiration time for the API key. + /// By default, API keys never expire. + /// + /// + public CreateCrossClusterApiKeyRequestDescriptor Expiration(Elastic.Clients.Elasticsearch.Duration? expiration) + { + ExpirationValue = expiration; + return Self; + } + + /// + /// + /// Arbitrary metadata that you want to associate with the API key. + /// It supports nested data structure. + /// Within the metadata object, keys beginning with _ are reserved for system usage. + /// + /// + public CreateCrossClusterApiKeyRequestDescriptor Metadata(Func, FluentDictionary> selector) + { + MetadataValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + /// + /// + /// Specifies the name for this API key. + /// + /// + public CreateCrossClusterApiKeyRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name name) + { + NameValue = name; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (AccessDescriptor is not null) + { + writer.WritePropertyName("access"); + JsonSerializer.Serialize(writer, AccessDescriptor, options); + } + else if (AccessDescriptorAction is not null) + { + writer.WritePropertyName("access"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.AccessDescriptor(AccessDescriptorAction), options); + } + else + { + writer.WritePropertyName("access"); + JsonSerializer.Serialize(writer, AccessValue, options); + } + + if (ExpirationValue is not null) + { + writer.WritePropertyName("expiration"); + JsonSerializer.Serialize(writer, ExpirationValue, options); + } + + if (MetadataValue is not null) + { + writer.WritePropertyName("metadata"); + JsonSerializer.Serialize(writer, MetadataValue, options); + } + + writer.WritePropertyName("name"); + JsonSerializer.Serialize(writer, NameValue, options); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationListItem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateCrossClusterApiKeyResponse.g.cs similarity index 65% rename from src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationListItem.g.cs rename to src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateCrossClusterApiKeyResponse.g.cs index f660ec1cfd..3dcac6531a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationListItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateCrossClusterApiKeyResponse.g.cs @@ -19,45 +19,54 @@ using Elastic.Clients.Elasticsearch.Fluent; using Elastic.Clients.Elasticsearch.Serialization; +using Elastic.Transport.Products.Elasticsearch; using System; using System.Collections.Generic; -using System.Linq.Expressions; -using System.Text.Json; using System.Text.Json.Serialization; -namespace Elastic.Clients.Elasticsearch.SearchApplication; +namespace Elastic.Clients.Elasticsearch.Security; -public sealed partial class SearchApplicationListItem +public sealed partial class CreateCrossClusterApiKeyResponse : ElasticsearchResponse { /// /// - /// Analytics collection associated to the Search Application + /// Generated API key. /// /// - [JsonInclude, JsonPropertyName("analytics_collection_name")] - public string? AnalyticsCollectionName { get; init; } + [JsonInclude, JsonPropertyName("api_key")] + public string ApiKey { get; init; } /// /// - /// Indices that are part of the Search Application + /// API key credentials which is the base64-encoding of + /// the UTF-8 representation of id and api_key joined + /// by a colon (:). /// /// - [JsonInclude, JsonPropertyName("indices")] - public IReadOnlyCollection Indices { get; init; } + [JsonInclude, JsonPropertyName("encoded")] + public string Encoded { get; init; } /// /// - /// Search Application name + /// Expiration in milliseconds for the API key. /// /// - [JsonInclude, JsonPropertyName("name")] - public string Name { get; init; } + [JsonInclude, JsonPropertyName("expiration")] + public long? Expiration { get; init; } /// /// - /// Last time the Search Application was updated + /// Unique ID for this API key. /// /// - [JsonInclude, JsonPropertyName("updated_at_millis")] - public long UpdatedAtMillis { get; init; } + [JsonInclude, JsonPropertyName("id")] + public string Id { get; init; } + + /// + /// + /// Specifies the name for this API key. + /// + /// + [JsonInclude, JsonPropertyName("name")] + public string Name { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateServiceTokenRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateServiceTokenRequest.g.cs index 82f0154e7e..6b8dd3f406 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateServiceTokenRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateServiceTokenRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class CreateServiceTokenRequestParameters : RequestParamet /// /// -/// Creates a service accounts token for access without requiring basic authentication. +/// Create a service account token. +/// +/// +/// Create a service accounts token for access without requiring basic authentication. /// /// public sealed partial class CreateServiceTokenRequest : PlainRequest @@ -74,7 +77,10 @@ public CreateServiceTokenRequest(string ns, string service) : base(r => r.Requir /// /// -/// Creates a service accounts token for access without requiring basic authentication. +/// Create a service account token. +/// +/// +/// Create a service accounts token for access without requiring basic authentication. /// /// public sealed partial class CreateServiceTokenRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeletePrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeletePrivilegesRequest.g.cs index 55d79f9287..320489f143 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeletePrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeletePrivilegesRequest.g.cs @@ -42,7 +42,7 @@ public sealed partial class DeletePrivilegesRequestParameters : RequestParameter /// /// -/// Removes application privileges. +/// Delete application privileges. /// /// public sealed partial class DeletePrivilegesRequest : PlainRequest @@ -70,7 +70,7 @@ public DeletePrivilegesRequest(Elastic.Clients.Elasticsearch.Name application, E /// /// -/// Removes application privileges. +/// Delete application privileges. /// /// public sealed partial class DeletePrivilegesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteRoleMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteRoleMappingRequest.g.cs index aafbd9fe70..2421e54047 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteRoleMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteRoleMappingRequest.g.cs @@ -42,7 +42,7 @@ public sealed partial class DeleteRoleMappingRequestParameters : RequestParamete /// /// -/// Removes role mappings. +/// Delete role mappings. /// /// public sealed partial class DeleteRoleMappingRequest : PlainRequest @@ -70,7 +70,7 @@ public DeleteRoleMappingRequest(Elastic.Clients.Elasticsearch.Name name) : base( /// /// -/// Removes role mappings. +/// Delete role mappings. /// /// public sealed partial class DeleteRoleMappingRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteRoleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteRoleRequest.g.cs index 2bf1ca5061..fd976f508f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteRoleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteRoleRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class DeleteRoleRequestParameters : RequestParameters /// /// -/// Removes roles in the native realm. +/// Delete roles. +/// +/// +/// Delete roles in the native realm. /// /// public sealed partial class DeleteRoleRequest : PlainRequest @@ -70,7 +73,10 @@ public DeleteRoleRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => r. /// /// -/// Removes roles in the native realm. +/// Delete roles. +/// +/// +/// Delete roles in the native realm. /// /// public sealed partial class DeleteRoleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteServiceTokenRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteServiceTokenRequest.g.cs index 6183ce9641..94441f708b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteServiceTokenRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteServiceTokenRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class DeleteServiceTokenRequestParameters : RequestParamet /// /// -/// Deletes a service account token. +/// Delete service account tokens. +/// +/// +/// Delete service account tokens for a service in a specified namespace. /// /// public sealed partial class DeleteServiceTokenRequest : PlainRequest @@ -70,7 +73,10 @@ public DeleteServiceTokenRequest(string ns, string service, Elastic.Clients.Elas /// /// -/// Deletes a service account token. +/// Delete service account tokens. +/// +/// +/// Delete service account tokens for a service in a specified namespace. /// /// public sealed partial class DeleteServiceTokenRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteUserRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteUserRequest.g.cs index 6c01fdbe59..90e38b4765 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteUserRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DeleteUserRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class DeleteUserRequestParameters : RequestParameters /// /// -/// Deletes users from the native realm. +/// Delete users. +/// +/// +/// Delete users from the native realm. /// /// public sealed partial class DeleteUserRequest : PlainRequest @@ -70,7 +73,10 @@ public DeleteUserRequest(Elastic.Clients.Elasticsearch.Username username) : base /// /// -/// Deletes users from the native realm. +/// Delete users. +/// +/// +/// Delete users from the native realm. /// /// public sealed partial class DeleteUserRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DisableUserProfileRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DisableUserProfileRequest.g.cs index c0d51b9860..ee4991e79c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DisableUserProfileRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DisableUserProfileRequest.g.cs @@ -44,7 +44,10 @@ public sealed partial class DisableUserProfileRequestParameters : RequestParamet /// /// -/// Disables a user profile so it's not visible in user profile searches. +/// Disable a user profile. +/// +/// +/// Disable user profiles so that they are not visible in user profile searches. /// /// public sealed partial class DisableUserProfileRequest : PlainRequest @@ -74,7 +77,10 @@ public DisableUserProfileRequest(string uid) : base(r => r.Required("uid", uid)) /// /// -/// Disables a user profile so it's not visible in user profile searches. +/// Disable a user profile. +/// +/// +/// Disable user profiles so that they are not visible in user profile searches. /// /// public sealed partial class DisableUserProfileRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DisableUserRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DisableUserRequest.g.cs index 1c98402cd4..e8f286a5a8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DisableUserRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/DisableUserRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class DisableUserRequestParameters : RequestParameters /// /// -/// Disables users in the native realm. +/// Disable users. +/// +/// +/// Disable users in the native realm. /// /// public sealed partial class DisableUserRequest : PlainRequest @@ -70,7 +73,10 @@ public DisableUserRequest(Elastic.Clients.Elasticsearch.Username username) : bas /// /// -/// Disables users in the native realm. +/// Disable users. +/// +/// +/// Disable users in the native realm. /// /// public sealed partial class DisableUserRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnableUserProfileRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnableUserProfileRequest.g.cs index 423075f388..725a566580 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnableUserProfileRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnableUserProfileRequest.g.cs @@ -44,7 +44,10 @@ public sealed partial class EnableUserProfileRequestParameters : RequestParamete /// /// -/// Enables a user profile so it's visible in user profile searches. +/// Enable a user profile. +/// +/// +/// Enable user profiles to make them visible in user profile searches. /// /// public sealed partial class EnableUserProfileRequest : PlainRequest @@ -74,7 +77,10 @@ public EnableUserProfileRequest(string uid) : base(r => r.Required("uid", uid)) /// /// -/// Enables a user profile so it's visible in user profile searches. +/// Enable a user profile. +/// +/// +/// Enable user profiles to make them visible in user profile searches. /// /// public sealed partial class EnableUserProfileRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnableUserRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnableUserRequest.g.cs index 019ff052db..4758880e9f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnableUserRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnableUserRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class EnableUserRequestParameters : RequestParameters /// /// -/// Enables users in the native realm. +/// Enable users. +/// +/// +/// Enable users in the native realm. /// /// public sealed partial class EnableUserRequest : PlainRequest @@ -70,7 +73,10 @@ public EnableUserRequest(Elastic.Clients.Elasticsearch.Username username) : base /// /// -/// Enables users in the native realm. +/// Enable users. +/// +/// +/// Enable users in the native realm. /// /// public sealed partial class EnableUserRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnrollKibanaRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnrollKibanaRequest.g.cs index 83ced516fb..51c0a32e14 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnrollKibanaRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnrollKibanaRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class EnrollKibanaRequestParameters : RequestParameters /// /// -/// Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. +/// Enroll Kibana. +/// +/// +/// Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. /// /// public sealed partial class EnrollKibanaRequest : PlainRequest @@ -52,7 +55,10 @@ public sealed partial class EnrollKibanaRequest : PlainRequest /// -/// Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. +/// Enroll Kibana. +/// +/// +/// Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. /// /// public sealed partial class EnrollKibanaRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnrollNodeRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnrollNodeRequest.g.cs index 19c4869476..580b4bc0b0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnrollNodeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/EnrollNodeRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class EnrollNodeRequestParameters : RequestParameters /// /// -/// Allows a new node to join an existing cluster with security features enabled. +/// Enroll a node. +/// +/// +/// Enroll a new node to allow it to join an existing cluster with security features enabled. /// /// public sealed partial class EnrollNodeRequest : PlainRequest @@ -52,7 +55,10 @@ public sealed partial class EnrollNodeRequest : PlainRequest /// -/// Allows a new node to join an existing cluster with security features enabled. +/// Enroll a node. +/// +/// +/// Enroll a new node to allow it to join an existing cluster with security features enabled. /// /// public sealed partial class EnrollNodeRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetApiKeyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetApiKeyRequest.g.cs index 996c419b3f..57ce8199ac 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetApiKeyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetApiKeyRequest.g.cs @@ -101,6 +101,8 @@ public sealed partial class GetApiKeyRequestParameters : RequestParameters /// /// /// Get API key information. +/// +/// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -193,6 +195,8 @@ public sealed partial class GetApiKeyRequest : PlainRequest /// /// Get API key information. +/// +/// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetBuiltinPrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetBuiltinPrivilegesRequest.g.cs index 86da44c586..218da5b567 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetBuiltinPrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetBuiltinPrivilegesRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class GetBuiltinPrivilegesRequestParameters : RequestParam /// /// -/// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. +/// Get builtin privileges. +/// +/// +/// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// public sealed partial class GetBuiltinPrivilegesRequest : PlainRequest @@ -52,7 +55,10 @@ public sealed partial class GetBuiltinPrivilegesRequest : PlainRequest /// -/// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. +/// Get builtin privileges. +/// +/// +/// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// public sealed partial class GetBuiltinPrivilegesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetBuiltinPrivilegesResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetBuiltinPrivilegesResponse.g.cs index 0f19d1b9a0..2410a2d777 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetBuiltinPrivilegesResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetBuiltinPrivilegesResponse.g.cs @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Security; public sealed partial class GetBuiltinPrivilegesResponse : ElasticsearchResponse { [JsonInclude, JsonPropertyName("cluster")] - public IReadOnlyCollection Cluster { get; init; } + public IReadOnlyCollection Cluster { get; init; } [JsonInclude, JsonPropertyName("index")] public IReadOnlyCollection Index { get; init; } + [JsonInclude, JsonPropertyName("remote_cluster")] + public IReadOnlyCollection RemoteCluster { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetPrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetPrivilegesRequest.g.cs index e9b962cc0f..54604deb0a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetPrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetPrivilegesRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class GetPrivilegesRequestParameters : RequestParameters /// /// -/// Retrieves application privileges. +/// Get application privileges. /// /// public sealed partial class GetPrivilegesRequest : PlainRequest @@ -64,7 +64,7 @@ public GetPrivilegesRequest(Elastic.Clients.Elasticsearch.Name? application, Ela /// /// -/// Retrieves application privileges. +/// Get application privileges. /// /// public sealed partial class GetPrivilegesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetRoleMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetRoleMappingRequest.g.cs index 3eb5c006fc..8a4c6a97c4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetRoleMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetRoleMappingRequest.g.cs @@ -36,7 +36,12 @@ public sealed partial class GetRoleMappingRequestParameters : RequestParameters /// /// -/// Retrieves role mappings. +/// Get role mappings. +/// +/// +/// Role mappings define which roles are assigned to each user. +/// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. +/// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// public sealed partial class GetRoleMappingRequest : PlainRequest @@ -60,7 +65,12 @@ public GetRoleMappingRequest(Elastic.Clients.Elasticsearch.Names? name) : base(r /// /// -/// Retrieves role mappings. +/// Get role mappings. +/// +/// +/// Role mappings define which roles are assigned to each user. +/// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. +/// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// public sealed partial class GetRoleMappingRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetRoleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetRoleRequest.g.cs index 277814202e..9269177ee8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetRoleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetRoleRequest.g.cs @@ -36,8 +36,10 @@ public sealed partial class GetRoleRequestParameters : RequestParameters /// /// -/// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. -/// The get roles API cannot retrieve roles that are defined in roles files. +/// Get roles. +/// +/// +/// Get roles in the native realm. /// /// public sealed partial class GetRoleRequest : PlainRequest @@ -61,8 +63,10 @@ public GetRoleRequest(Elastic.Clients.Elasticsearch.Names? name) : base(r => r.O /// /// -/// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. -/// The get roles API cannot retrieve roles that are defined in roles files. +/// Get roles. +/// +/// +/// Get roles in the native realm. /// /// public sealed partial class GetRoleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetServiceAccountsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetServiceAccountsRequest.g.cs index 157e7bb90e..921b203f23 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetServiceAccountsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetServiceAccountsRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class GetServiceAccountsRequestParameters : RequestParamet /// /// -/// This API returns a list of service accounts that match the provided path parameter(s). +/// Get service accounts. +/// +/// +/// Get a list of service accounts that match the provided path parameters. /// /// public sealed partial class GetServiceAccountsRequest : PlainRequest @@ -64,7 +67,10 @@ public GetServiceAccountsRequest(string? ns) : base(r => r.Optional("namespace", /// /// -/// This API returns a list of service accounts that match the provided path parameter(s). +/// Get service accounts. +/// +/// +/// Get a list of service accounts that match the provided path parameters. /// /// public sealed partial class GetServiceAccountsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetServiceCredentialsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetServiceCredentialsRequest.g.cs index bf51be2829..a1a5d627f2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetServiceCredentialsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetServiceCredentialsRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class GetServiceCredentialsRequestParameters : RequestPara /// /// -/// Retrieves information of all service credentials for a service account. +/// Get service account credentials. /// /// public sealed partial class GetServiceCredentialsRequest : PlainRequest @@ -56,7 +56,7 @@ public GetServiceCredentialsRequest(string ns, Elastic.Clients.Elasticsearch.Nam /// /// -/// Retrieves information of all service credentials for a service account. +/// Get service account credentials. /// /// public sealed partial class GetServiceCredentialsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetTokenRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetTokenRequest.g.cs index d3ade1b87c..ee7fd7ce38 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetTokenRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetTokenRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class GetTokenRequestParameters : RequestParameters /// /// -/// Creates a bearer token for access without requiring basic authentication. +/// Get a token. +/// +/// +/// Create a bearer token for access without requiring basic authentication. /// /// public sealed partial class GetTokenRequest : PlainRequest @@ -65,7 +68,10 @@ public sealed partial class GetTokenRequest : PlainRequest /// -/// Creates a bearer token for access without requiring basic authentication. +/// Get a token. +/// +/// +/// Create a bearer token for access without requiring basic authentication. /// /// public sealed partial class GetTokenRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetUserPrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetUserPrivilegesRequest.g.cs index 903249037d..52d790b045 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetUserPrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetUserPrivilegesRequest.g.cs @@ -50,7 +50,7 @@ public sealed partial class GetUserPrivilegesRequestParameters : RequestParamete /// /// -/// Retrieves security privileges for the logged in user. +/// Get user privileges. /// /// public sealed partial class GetUserPrivilegesRequest : PlainRequest @@ -84,7 +84,7 @@ public sealed partial class GetUserPrivilegesRequest : PlainRequest /// -/// Retrieves security privileges for the logged in user. +/// Get user privileges. /// /// public sealed partial class GetUserPrivilegesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetUserProfileRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetUserProfileRequest.g.cs index aa80263756..fa92cf1108 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetUserProfileRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetUserProfileRequest.g.cs @@ -45,7 +45,10 @@ public sealed partial class GetUserProfileRequestParameters : RequestParameters /// /// -/// Retrieves a user's profile using the unique profile ID. +/// Get a user profile. +/// +/// +/// Get a user's profile using the unique profile ID. /// /// public sealed partial class GetUserProfileRequest : PlainRequest @@ -76,7 +79,10 @@ public GetUserProfileRequest(IReadOnlyCollection uid) : base(r => r.Requ /// /// -/// Retrieves a user's profile using the unique profile ID. +/// Get a user profile. +/// +/// +/// Get a user's profile using the unique profile ID. /// /// public sealed partial class GetUserProfileRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetUserRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetUserRequest.g.cs index 734533078e..9c77e91e3f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetUserRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GetUserRequest.g.cs @@ -42,7 +42,10 @@ public sealed partial class GetUserRequestParameters : RequestParameters /// /// -/// Retrieves information about users in the native realm and built-in users. +/// Get users. +/// +/// +/// Get information about users in the native realm and built-in users. /// /// public sealed partial class GetUserRequest : PlainRequest @@ -74,7 +77,10 @@ public GetUserRequest(IReadOnlyCollection /// -/// Retrieves information about users in the native realm and built-in users. +/// Get users. +/// +/// +/// Get information about users in the native realm and built-in users. /// /// public sealed partial class GetUserRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GrantApiKeyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GrantApiKeyRequest.g.cs index 5f0efc8462..c09da87bef 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GrantApiKeyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/GrantApiKeyRequest.g.cs @@ -36,8 +36,11 @@ public sealed partial class GrantApiKeyRequestParameters : RequestParameters /// /// -/// Creates an API key on behalf of another user. -/// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. +/// Grant an API key. +/// +/// +/// Create an API key on behalf of another user. +/// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -120,8 +123,11 @@ public sealed partial class GrantApiKeyRequest : PlainRequest /// -/// Creates an API key on behalf of another user. -/// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. +/// Grant an API key. +/// +/// +/// Create an API key on behalf of another user. +/// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -303,8 +309,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Creates an API key on behalf of another user. -/// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. +/// Grant an API key. +/// +/// +/// Create an API key on behalf of another user. +/// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/HasPrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/HasPrivilegesRequest.g.cs index 3ac8a626a3..623c868da8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/HasPrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/HasPrivilegesRequest.g.cs @@ -37,7 +37,9 @@ public sealed partial class HasPrivilegesRequestParameters : RequestParameters /// /// /// Check user privileges. -/// Determines whether the specified user has a specified list of privileges. +/// +/// +/// Determine whether the specified user has a specified list of privileges. /// /// public sealed partial class HasPrivilegesRequest : PlainRequest @@ -75,7 +77,9 @@ public HasPrivilegesRequest(Elastic.Clients.Elasticsearch.Name? user) : base(r = /// /// /// Check user privileges. -/// Determines whether the specified user has a specified list of privileges. +/// +/// +/// Determine whether the specified user has a specified list of privileges. /// /// public sealed partial class HasPrivilegesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/HasPrivilegesUserProfileRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/HasPrivilegesUserProfileRequest.g.cs index 15dd0268db..81f8013212 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/HasPrivilegesUserProfileRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/HasPrivilegesUserProfileRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class HasPrivilegesUserProfileRequestParameters : RequestP /// /// -/// Determines whether the users associated with the specified profile IDs have all the requested privileges. +/// Check user profile privileges. +/// +/// +/// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// public sealed partial class HasPrivilegesUserProfileRequest : PlainRequest @@ -63,7 +66,10 @@ public sealed partial class HasPrivilegesUserProfileRequest : PlainRequest /// -/// Determines whether the users associated with the specified profile IDs have all the requested privileges. +/// Check user profile privileges. +/// +/// +/// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// public sealed partial class HasPrivilegesUserProfileRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/InvalidateApiKeyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/InvalidateApiKeyRequest.g.cs index 02dbbe3889..d648b5974c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/InvalidateApiKeyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/InvalidateApiKeyRequest.g.cs @@ -37,7 +37,10 @@ public sealed partial class InvalidateApiKeyRequestParameters : RequestParameter /// /// /// Invalidate API keys. -/// Invalidates one or more API keys. +/// +/// +/// This API invalidates API keys created by the create API key or grant API key APIs. +/// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -55,7 +58,7 @@ public sealed partial class InvalidateApiKeyRequestParameters : RequestParameter /// /// /// -/// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. +/// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -122,7 +125,10 @@ public sealed partial class InvalidateApiKeyRequest : PlainRequest /// /// Invalidate API keys. -/// Invalidates one or more API keys. +/// +/// +/// This API invalidates API keys created by the create API key or grant API key APIs. +/// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -140,7 +146,7 @@ public sealed partial class InvalidateApiKeyRequest : PlainRequest /// /// -/// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. +/// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/InvalidateTokenRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/InvalidateTokenRequest.g.cs index 6c7c79d4e4..4386ef5385 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/InvalidateTokenRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/InvalidateTokenRequest.g.cs @@ -36,7 +36,16 @@ public sealed partial class InvalidateTokenRequestParameters : RequestParameters /// /// -/// Invalidates one or more access tokens or refresh tokens. +/// Invalidate a token. +/// +/// +/// The access tokens returned by the get token API have a finite period of time for which they are valid. +/// After that time period, they can no longer be used. +/// The time period is defined by the xpack.security.authc.token.timeout setting. +/// +/// +/// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. +/// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// public sealed partial class InvalidateTokenRequest : PlainRequest @@ -61,7 +70,16 @@ public sealed partial class InvalidateTokenRequest : PlainRequest /// -/// Invalidates one or more access tokens or refresh tokens. +/// Invalidate a token. +/// +/// +/// The access tokens returned by the get token API have a finite period of time for which they are valid. +/// After that time period, they can no longer be used. +/// The time period is defined by the xpack.security.authc.token.timeout setting. +/// +/// +/// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. +/// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// public sealed partial class InvalidateTokenRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutPrivilegesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutPrivilegesRequest.g.cs index 61b7a74d58..9ba02c0123 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutPrivilegesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutPrivilegesRequest.g.cs @@ -44,7 +44,7 @@ public sealed partial class PutPrivilegesRequestParameters : RequestParameters /// /// -/// Adds or updates application privileges. +/// Create or update application privileges. /// /// public sealed partial class PutPrivilegesRequest : PlainRequest, ISelfSerializable @@ -74,7 +74,7 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op /// /// -/// Adds or updates application privileges. +/// Create or update application privileges. /// /// public sealed partial class PutPrivilegesRequestDescriptor : RequestDescriptor, ISelfSerializable diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutRoleMappingRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutRoleMappingRequest.g.cs index 748f72aa99..e0713523d9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutRoleMappingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutRoleMappingRequest.g.cs @@ -42,7 +42,16 @@ public sealed partial class PutRoleMappingRequestParameters : RequestParameters /// /// -/// Creates and updates role mappings. +/// Create or update role mappings. +/// +/// +/// Role mappings define which roles are assigned to each user. +/// Each mapping has rules that identify users and a list of roles that are granted to those users. +/// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. +/// +/// +/// This API does not create roles. Rather, it maps users to existing roles. +/// Roles can be created by using the create or update roles API or roles files. /// /// public sealed partial class PutRoleMappingRequest : PlainRequest @@ -82,7 +91,16 @@ public PutRoleMappingRequest(Elastic.Clients.Elasticsearch.Name name) : base(r = /// /// -/// Creates and updates role mappings. +/// Create or update role mappings. +/// +/// +/// Role mappings define which roles are assigned to each user. +/// Each mapping has rules that identify users and a list of roles that are granted to those users. +/// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. +/// +/// +/// This API does not create roles. Rather, it maps users to existing roles. +/// Roles can be created by using the create or update roles API or roles files. /// /// public sealed partial class PutRoleMappingRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutRoleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutRoleRequest.g.cs index 6f508ca957..300912ec21 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutRoleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutRoleRequest.g.cs @@ -42,8 +42,12 @@ public sealed partial class PutRoleRequestParameters : RequestParameters /// /// -/// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. +/// Create or update roles. +/// +/// +/// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. +/// File-based role management is not available in Elastic Serverless. /// /// public sealed partial class PutRoleRequest : PlainRequest @@ -116,6 +120,14 @@ public PutRoleRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => r.Req [JsonInclude, JsonPropertyName("metadata")] public IDictionary? Metadata { get; set; } + /// + /// + /// A list of remote cluster permissions entries. + /// + /// + [JsonInclude, JsonPropertyName("remote_cluster")] + public ICollection? RemoteCluster { get; set; } + /// /// /// A list of remote indices permissions entries. @@ -143,8 +155,12 @@ public PutRoleRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => r.Req /// /// -/// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. +/// Create or update roles. +/// +/// +/// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. +/// File-based role management is not available in Elastic Serverless. /// /// public sealed partial class PutRoleRequestDescriptor : RequestDescriptor, PutRoleRequestParameters> @@ -183,6 +199,10 @@ public PutRoleRequestDescriptor Name(Elastic.Clients.Elasticsearch.Na private Action> IndicesDescriptorAction { get; set; } private Action>[] IndicesDescriptorActions { get; set; } private IDictionary? MetadataValue { get; set; } + private ICollection? RemoteClusterValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor RemoteClusterDescriptor { get; set; } + private Action RemoteClusterDescriptorAction { get; set; } + private Action[] RemoteClusterDescriptorActions { get; set; } private ICollection? RemoteIndicesValue { get; set; } private Elastic.Clients.Elasticsearch.Security.RemoteIndicesPrivilegesDescriptor RemoteIndicesDescriptor { get; set; } private Action> RemoteIndicesDescriptorAction { get; set; } @@ -316,6 +336,47 @@ public PutRoleRequestDescriptor Metadata(Func + /// + /// A list of remote cluster permissions entries. + /// + /// + public PutRoleRequestDescriptor RemoteCluster(ICollection? remoteCluster) + { + RemoteClusterDescriptor = null; + RemoteClusterDescriptorAction = null; + RemoteClusterDescriptorActions = null; + RemoteClusterValue = remoteCluster; + return Self; + } + + public PutRoleRequestDescriptor RemoteCluster(Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor descriptor) + { + RemoteClusterValue = null; + RemoteClusterDescriptorAction = null; + RemoteClusterDescriptorActions = null; + RemoteClusterDescriptor = descriptor; + return Self; + } + + public PutRoleRequestDescriptor RemoteCluster(Action configure) + { + RemoteClusterValue = null; + RemoteClusterDescriptor = null; + RemoteClusterDescriptorActions = null; + RemoteClusterDescriptorAction = configure; + return Self; + } + + public PutRoleRequestDescriptor RemoteCluster(params Action[] configure) + { + RemoteClusterValue = null; + RemoteClusterDescriptor = null; + RemoteClusterDescriptorAction = null; + RemoteClusterDescriptorActions = configure; + return Self; + } + /// /// /// A list of remote indices permissions entries. @@ -468,6 +529,37 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, MetadataValue, options); } + if (RemoteClusterDescriptor is not null) + { + writer.WritePropertyName("remote_cluster"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, RemoteClusterDescriptor, options); + writer.WriteEndArray(); + } + else if (RemoteClusterDescriptorAction is not null) + { + writer.WritePropertyName("remote_cluster"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor(RemoteClusterDescriptorAction), options); + writer.WriteEndArray(); + } + else if (RemoteClusterDescriptorActions is not null) + { + writer.WritePropertyName("remote_cluster"); + writer.WriteStartArray(); + foreach (var action in RemoteClusterDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (RemoteClusterValue is not null) + { + writer.WritePropertyName("remote_cluster"); + JsonSerializer.Serialize(writer, RemoteClusterValue, options); + } + if (RemoteIndicesDescriptor is not null) { writer.WritePropertyName("remote_indices"); @@ -517,8 +609,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. +/// Create or update roles. +/// +/// +/// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. +/// File-based role management is not available in Elastic Serverless. /// /// public sealed partial class PutRoleRequestDescriptor : RequestDescriptor @@ -557,6 +653,10 @@ public PutRoleRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name name) private Action IndicesDescriptorAction { get; set; } private Action[] IndicesDescriptorActions { get; set; } private IDictionary? MetadataValue { get; set; } + private ICollection? RemoteClusterValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor RemoteClusterDescriptor { get; set; } + private Action RemoteClusterDescriptorAction { get; set; } + private Action[] RemoteClusterDescriptorActions { get; set; } private ICollection? RemoteIndicesValue { get; set; } private Elastic.Clients.Elasticsearch.Security.RemoteIndicesPrivilegesDescriptor RemoteIndicesDescriptor { get; set; } private Action RemoteIndicesDescriptorAction { get; set; } @@ -690,6 +790,47 @@ public PutRoleRequestDescriptor Metadata(Func, return Self; } + /// + /// + /// A list of remote cluster permissions entries. + /// + /// + public PutRoleRequestDescriptor RemoteCluster(ICollection? remoteCluster) + { + RemoteClusterDescriptor = null; + RemoteClusterDescriptorAction = null; + RemoteClusterDescriptorActions = null; + RemoteClusterValue = remoteCluster; + return Self; + } + + public PutRoleRequestDescriptor RemoteCluster(Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor descriptor) + { + RemoteClusterValue = null; + RemoteClusterDescriptorAction = null; + RemoteClusterDescriptorActions = null; + RemoteClusterDescriptor = descriptor; + return Self; + } + + public PutRoleRequestDescriptor RemoteCluster(Action configure) + { + RemoteClusterValue = null; + RemoteClusterDescriptor = null; + RemoteClusterDescriptorActions = null; + RemoteClusterDescriptorAction = configure; + return Self; + } + + public PutRoleRequestDescriptor RemoteCluster(params Action[] configure) + { + RemoteClusterValue = null; + RemoteClusterDescriptor = null; + RemoteClusterDescriptorAction = null; + RemoteClusterDescriptorActions = configure; + return Self; + } + /// /// /// A list of remote indices permissions entries. @@ -842,6 +983,37 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, MetadataValue, options); } + if (RemoteClusterDescriptor is not null) + { + writer.WritePropertyName("remote_cluster"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, RemoteClusterDescriptor, options); + writer.WriteEndArray(); + } + else if (RemoteClusterDescriptorAction is not null) + { + writer.WritePropertyName("remote_cluster"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor(RemoteClusterDescriptorAction), options); + writer.WriteEndArray(); + } + else if (RemoteClusterDescriptorActions is not null) + { + writer.WritePropertyName("remote_cluster"); + writer.WriteStartArray(); + foreach (var action in RemoteClusterDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (RemoteClusterValue is not null) + { + writer.WritePropertyName("remote_cluster"); + JsonSerializer.Serialize(writer, RemoteClusterValue, options); + } + if (RemoteIndicesDescriptor is not null) { writer.WritePropertyName("remote_indices"); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutUserRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutUserRequest.g.cs index 9f9434d6e7..be4076b039 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutUserRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/PutUserRequest.g.cs @@ -42,7 +42,11 @@ public sealed partial class PutUserRequestParameters : RequestParameters /// /// -/// Adds and updates users in the native realm. These users are commonly referred to as native users. +/// Create or update users. +/// +/// +/// A password is required for adding a new user but is optional when updating an existing user. +/// To change a user’s password without updating any other fields, use the change password API. /// /// public sealed partial class PutUserRequest : PlainRequest @@ -86,7 +90,11 @@ public PutUserRequest(Elastic.Clients.Elasticsearch.Username username) : base(r /// /// -/// Adds and updates users in the native realm. These users are commonly referred to as native users. +/// Create or update users. +/// +/// +/// A password is required for adding a new user but is optional when updating an existing user. +/// To change a user’s password without updating any other fields, use the change password API. /// /// public sealed partial class PutUserRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/QueryApiKeysRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/QueryApiKeysRequest.g.cs index f58fc473b5..fdd42b6136 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/QueryApiKeysRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/QueryApiKeysRequest.g.cs @@ -153,8 +153,10 @@ public override void Write(Utf8JsonWriter writer, QueryApiKeysRequest value, Jso /// /// -/// Query API keys. -/// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. +/// Find API keys with a query. +/// +/// +/// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// [JsonConverter(typeof(QueryApiKeysRequestConverter))] @@ -263,8 +265,10 @@ public QueryApiKeysRequest() /// /// -/// Query API keys. -/// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. +/// Find API keys with a query. +/// +/// +/// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// public sealed partial class QueryApiKeysRequestDescriptor : RequestDescriptor, QueryApiKeysRequestParameters> @@ -505,8 +509,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Query API keys. -/// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. +/// Find API keys with a query. +/// +/// +/// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// public sealed partial class QueryApiKeysRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/QueryRoleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/QueryRoleRequest.g.cs index 08bee4543e..e55732256d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/QueryRoleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/QueryRoleRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class QueryRoleRequestParameters : RequestParameters /// /// -/// Retrieves roles in a paginated manner. You can optionally filter the results with a query. +/// Find roles with a query. +/// +/// +/// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// public sealed partial class QueryRoleRequest : PlainRequest @@ -103,7 +106,10 @@ public sealed partial class QueryRoleRequest : PlainRequest /// -/// Retrieves roles in a paginated manner. You can optionally filter the results with a query. +/// Find roles with a query. +/// +/// +/// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// public sealed partial class QueryRoleRequestDescriptor : RequestDescriptor, QueryRoleRequestParameters> @@ -318,7 +324,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieves roles in a paginated manner. You can optionally filter the results with a query. +/// Find roles with a query. +/// +/// +/// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// public sealed partial class QueryRoleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/QueryUserRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/QueryUserRequest.g.cs index e29f3618f4..c5d98d2245 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/QueryUserRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/QueryUserRequest.g.cs @@ -42,7 +42,11 @@ public sealed partial class QueryUserRequestParameters : RequestParameters /// /// -/// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. +/// Find users with a query. +/// +/// +/// Get information for users in a paginated manner. +/// You can optionally filter the results with a query. /// /// public sealed partial class QueryUserRequest : PlainRequest @@ -116,7 +120,11 @@ public sealed partial class QueryUserRequest : PlainRequest /// -/// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. +/// Find users with a query. +/// +/// +/// Get information for users in a paginated manner. +/// You can optionally filter the results with a query. /// /// public sealed partial class QueryUserRequestDescriptor : RequestDescriptor, QueryUserRequestParameters> @@ -332,7 +340,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. +/// Find users with a query. +/// +/// +/// Get information for users in a paginated manner. +/// You can optionally filter the results with a query. /// /// public sealed partial class QueryUserRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlAuthenticateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlAuthenticateRequest.g.cs index 5de9a26fc6..478b941c9d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlAuthenticateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlAuthenticateRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class SamlAuthenticateRequestParameters : RequestParameter /// /// -/// Submits a SAML Response message to Elasticsearch for consumption. +/// Authenticate SAML. +/// +/// +/// Submits a SAML response message to Elasticsearch for consumption. /// /// public sealed partial class SamlAuthenticateRequest : PlainRequest @@ -76,7 +79,10 @@ public sealed partial class SamlAuthenticateRequest : PlainRequest /// -/// Submits a SAML Response message to Elasticsearch for consumption. +/// Authenticate SAML. +/// +/// +/// Submits a SAML response message to Elasticsearch for consumption. /// /// public sealed partial class SamlAuthenticateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlCompleteLogoutRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlCompleteLogoutRequest.g.cs index 3fec565f90..9224bf8132 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlCompleteLogoutRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlCompleteLogoutRequest.g.cs @@ -36,6 +36,9 @@ public sealed partial class SamlCompleteLogoutRequestParameters : RequestParamet /// /// +/// Logout of SAML completely. +/// +/// /// Verifies the logout response sent from the SAML IdP. /// /// @@ -84,6 +87,9 @@ public sealed partial class SamlCompleteLogoutRequest : PlainRequest /// +/// Logout of SAML completely. +/// +/// /// Verifies the logout response sent from the SAML IdP. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlInvalidateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlInvalidateRequest.g.cs index c4f8d7f725..987ee8fde4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlInvalidateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlInvalidateRequest.g.cs @@ -36,6 +36,9 @@ public sealed partial class SamlInvalidateRequestParameters : RequestParameters /// /// +/// Invalidate SAML. +/// +/// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// @@ -80,6 +83,9 @@ public sealed partial class SamlInvalidateRequest : PlainRequest /// +/// Invalidate SAML. +/// +/// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlLogoutRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlLogoutRequest.g.cs index 319b2e2d92..ffa0b19985 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlLogoutRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlLogoutRequest.g.cs @@ -36,6 +36,9 @@ public sealed partial class SamlLogoutRequestParameters : RequestParameters /// /// +/// Logout of SAML. +/// +/// /// Submits a request to invalidate an access token and refresh token. /// /// @@ -70,6 +73,9 @@ public sealed partial class SamlLogoutRequest : PlainRequest /// +/// Logout of SAML. +/// +/// /// Submits a request to invalidate an access token and refresh token. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlPrepareAuthenticationRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlPrepareAuthenticationRequest.g.cs index c82dce9acf..9afa7d595d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlPrepareAuthenticationRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlPrepareAuthenticationRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class SamlPrepareAuthenticationRequestParameters : Request /// /// -/// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. +/// Prepare SAML authentication. +/// +/// +/// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// public sealed partial class SamlPrepareAuthenticationRequest : PlainRequest @@ -79,7 +82,10 @@ public sealed partial class SamlPrepareAuthenticationRequest : PlainRequest /// -/// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. +/// Prepare SAML authentication. +/// +/// +/// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// public sealed partial class SamlPrepareAuthenticationRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlServiceProviderMetadataRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlServiceProviderMetadataRequest.g.cs index 50a7c5682e..009395c49b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlServiceProviderMetadataRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SamlServiceProviderMetadataRequest.g.cs @@ -36,6 +36,9 @@ public sealed partial class SamlServiceProviderMetadataRequestParameters : Reque /// /// +/// Create SAML service provider metadata. +/// +/// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// @@ -56,6 +59,9 @@ public SamlServiceProviderMetadataRequest(Elastic.Clients.Elasticsearch.Name rea /// /// +/// Create SAML service provider metadata. +/// +/// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SuggestUserProfilesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SuggestUserProfilesRequest.g.cs index 7e54558792..c6596d47ec 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SuggestUserProfilesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/SuggestUserProfilesRequest.g.cs @@ -36,6 +36,9 @@ public sealed partial class SuggestUserProfilesRequestParameters : RequestParame /// /// +/// Suggest a user profile. +/// +/// /// Get suggestions for user profiles that match specified search criteria. /// /// @@ -92,6 +95,9 @@ public sealed partial class SuggestUserProfilesRequest : PlainRequest /// +/// Suggest a user profile. +/// +/// /// Get suggestions for user profiles that match specified search criteria. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateApiKeyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateApiKeyRequest.g.cs index 488cea1b6d..15a488a199 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateApiKeyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateApiKeyRequest.g.cs @@ -37,6 +37,8 @@ public sealed partial class UpdateApiKeyRequestParameters : RequestParameters /// /// /// Update an API key. +/// +/// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -94,6 +96,8 @@ public UpdateApiKeyRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Re /// /// /// Update an API key. +/// +/// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -196,6 +200,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// /// Update an API key. +/// +/// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateCrossClusterApiKeyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateCrossClusterApiKeyRequest.g.cs new file mode 100644 index 0000000000..c93f01a473 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateCrossClusterApiKeyRequest.g.cs @@ -0,0 +1,347 @@ +// 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.Requests; +using Elastic.Clients.Elasticsearch.Serialization; +using Elastic.Transport; +using Elastic.Transport.Extensions; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Security; + +public sealed partial class UpdateCrossClusterApiKeyRequestParameters : RequestParameters +{ +} + +/// +/// +/// Update a cross-cluster API key. +/// +/// +/// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. +/// +/// +public sealed partial class UpdateCrossClusterApiKeyRequest : PlainRequest +{ + public UpdateCrossClusterApiKeyRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.SecurityUpdateCrossClusterApiKey; + + protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; + + internal override bool SupportsBody => true; + + internal override string OperationName => "security.update_cross_cluster_api_key"; + + /// + /// + /// The access to be granted to this API key. + /// The access is composed of permissions for cross cluster search and cross cluster replication. + /// At least one of them must be specified. + /// When specified, the new access assignment fully replaces the previously assigned access. + /// + /// + [JsonInclude, JsonPropertyName("access")] + public Elastic.Clients.Elasticsearch.Security.Access Access { get; set; } + + /// + /// + /// Expiration time for the API key. + /// By default, API keys never expire. This property can be omitted to leave the value unchanged. + /// + /// + [JsonInclude, JsonPropertyName("expiration")] + public Elastic.Clients.Elasticsearch.Duration? Expiration { get; set; } + + /// + /// + /// Arbitrary metadata that you want to associate with the API key. + /// It supports nested data structure. + /// Within the metadata object, keys beginning with _ are reserved for system usage. + /// When specified, this information fully replaces metadata previously associated with the API key. + /// + /// + [JsonInclude, JsonPropertyName("metadata")] + public IDictionary? Metadata { get; set; } +} + +/// +/// +/// Update a cross-cluster API key. +/// +/// +/// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. +/// +/// +public sealed partial class UpdateCrossClusterApiKeyRequestDescriptor : RequestDescriptor, UpdateCrossClusterApiKeyRequestParameters> +{ + internal UpdateCrossClusterApiKeyRequestDescriptor(Action> configure) => configure.Invoke(this); + + public UpdateCrossClusterApiKeyRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.SecurityUpdateCrossClusterApiKey; + + protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; + + internal override bool SupportsBody => true; + + internal override string OperationName => "security.update_cross_cluster_api_key"; + + public UpdateCrossClusterApiKeyRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id) + { + RouteValues.Required("id", id); + return Self; + } + + private Elastic.Clients.Elasticsearch.Security.Access AccessValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.AccessDescriptor AccessDescriptor { get; set; } + private Action> AccessDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.Duration? ExpirationValue { get; set; } + private IDictionary? MetadataValue { get; set; } + + /// + /// + /// The access to be granted to this API key. + /// The access is composed of permissions for cross cluster search and cross cluster replication. + /// At least one of them must be specified. + /// When specified, the new access assignment fully replaces the previously assigned access. + /// + /// + public UpdateCrossClusterApiKeyRequestDescriptor Access(Elastic.Clients.Elasticsearch.Security.Access access) + { + AccessDescriptor = null; + AccessDescriptorAction = null; + AccessValue = access; + return Self; + } + + public UpdateCrossClusterApiKeyRequestDescriptor Access(Elastic.Clients.Elasticsearch.Security.AccessDescriptor descriptor) + { + AccessValue = null; + AccessDescriptorAction = null; + AccessDescriptor = descriptor; + return Self; + } + + public UpdateCrossClusterApiKeyRequestDescriptor Access(Action> configure) + { + AccessValue = null; + AccessDescriptor = null; + AccessDescriptorAction = configure; + return Self; + } + + /// + /// + /// Expiration time for the API key. + /// By default, API keys never expire. This property can be omitted to leave the value unchanged. + /// + /// + public UpdateCrossClusterApiKeyRequestDescriptor Expiration(Elastic.Clients.Elasticsearch.Duration? expiration) + { + ExpirationValue = expiration; + return Self; + } + + /// + /// + /// Arbitrary metadata that you want to associate with the API key. + /// It supports nested data structure. + /// Within the metadata object, keys beginning with _ are reserved for system usage. + /// When specified, this information fully replaces metadata previously associated with the API key. + /// + /// + public UpdateCrossClusterApiKeyRequestDescriptor Metadata(Func, FluentDictionary> selector) + { + MetadataValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (AccessDescriptor is not null) + { + writer.WritePropertyName("access"); + JsonSerializer.Serialize(writer, AccessDescriptor, options); + } + else if (AccessDescriptorAction is not null) + { + writer.WritePropertyName("access"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.AccessDescriptor(AccessDescriptorAction), options); + } + else + { + writer.WritePropertyName("access"); + JsonSerializer.Serialize(writer, AccessValue, options); + } + + if (ExpirationValue is not null) + { + writer.WritePropertyName("expiration"); + JsonSerializer.Serialize(writer, ExpirationValue, options); + } + + if (MetadataValue is not null) + { + writer.WritePropertyName("metadata"); + JsonSerializer.Serialize(writer, MetadataValue, options); + } + + writer.WriteEndObject(); + } +} + +/// +/// +/// Update a cross-cluster API key. +/// +/// +/// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. +/// +/// +public sealed partial class UpdateCrossClusterApiKeyRequestDescriptor : RequestDescriptor +{ + internal UpdateCrossClusterApiKeyRequestDescriptor(Action configure) => configure.Invoke(this); + + public UpdateCrossClusterApiKeyRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.SecurityUpdateCrossClusterApiKey; + + protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; + + internal override bool SupportsBody => true; + + internal override string OperationName => "security.update_cross_cluster_api_key"; + + public UpdateCrossClusterApiKeyRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id) + { + RouteValues.Required("id", id); + return Self; + } + + private Elastic.Clients.Elasticsearch.Security.Access AccessValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.AccessDescriptor AccessDescriptor { get; set; } + private Action AccessDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.Duration? ExpirationValue { get; set; } + private IDictionary? MetadataValue { get; set; } + + /// + /// + /// The access to be granted to this API key. + /// The access is composed of permissions for cross cluster search and cross cluster replication. + /// At least one of them must be specified. + /// When specified, the new access assignment fully replaces the previously assigned access. + /// + /// + public UpdateCrossClusterApiKeyRequestDescriptor Access(Elastic.Clients.Elasticsearch.Security.Access access) + { + AccessDescriptor = null; + AccessDescriptorAction = null; + AccessValue = access; + return Self; + } + + public UpdateCrossClusterApiKeyRequestDescriptor Access(Elastic.Clients.Elasticsearch.Security.AccessDescriptor descriptor) + { + AccessValue = null; + AccessDescriptorAction = null; + AccessDescriptor = descriptor; + return Self; + } + + public UpdateCrossClusterApiKeyRequestDescriptor Access(Action configure) + { + AccessValue = null; + AccessDescriptor = null; + AccessDescriptorAction = configure; + return Self; + } + + /// + /// + /// Expiration time for the API key. + /// By default, API keys never expire. This property can be omitted to leave the value unchanged. + /// + /// + public UpdateCrossClusterApiKeyRequestDescriptor Expiration(Elastic.Clients.Elasticsearch.Duration? expiration) + { + ExpirationValue = expiration; + return Self; + } + + /// + /// + /// Arbitrary metadata that you want to associate with the API key. + /// It supports nested data structure. + /// Within the metadata object, keys beginning with _ are reserved for system usage. + /// When specified, this information fully replaces metadata previously associated with the API key. + /// + /// + public UpdateCrossClusterApiKeyRequestDescriptor Metadata(Func, FluentDictionary> selector) + { + MetadataValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (AccessDescriptor is not null) + { + writer.WritePropertyName("access"); + JsonSerializer.Serialize(writer, AccessDescriptor, options); + } + else if (AccessDescriptorAction is not null) + { + writer.WritePropertyName("access"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.AccessDescriptor(AccessDescriptorAction), options); + } + else + { + writer.WritePropertyName("access"); + JsonSerializer.Serialize(writer, AccessValue, options); + } + + if (ExpirationValue is not null) + { + writer.WritePropertyName("expiration"); + JsonSerializer.Serialize(writer, ExpirationValue, options); + } + + if (MetadataValue is not null) + { + writer.WritePropertyName("metadata"); + JsonSerializer.Serialize(writer, MetadataValue, options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateCrossClusterApiKeyResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateCrossClusterApiKeyResponse.g.cs new file mode 100644 index 0000000000..d884f62166 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateCrossClusterApiKeyResponse.g.cs @@ -0,0 +1,39 @@ +// 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 Elastic.Transport.Products.Elasticsearch; +using System; +using System.Collections.Generic; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Security; + +public sealed partial class UpdateCrossClusterApiKeyResponse : ElasticsearchResponse +{ + /// + /// + /// If true, the API key was updated. + /// If false, the API key didn’t change because no change was detected. + /// + /// + [JsonInclude, JsonPropertyName("updated")] + public bool Updated { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateUserProfileDataRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateUserProfileDataRequest.g.cs index 1427c4ba1b..98048ccd89 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateUserProfileDataRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/UpdateUserProfileDataRequest.g.cs @@ -58,7 +58,10 @@ public sealed partial class UpdateUserProfileDataRequestParameters : RequestPara /// /// -/// Updates specific data for the user profile that's associated with the specified unique ID. +/// Update user profile data. +/// +/// +/// Update specific data for the user profile that is associated with a unique ID. /// /// public sealed partial class UpdateUserProfileDataRequest : PlainRequest @@ -122,7 +125,10 @@ public UpdateUserProfileDataRequest(string uid) : base(r => r.Required("uid", ui /// /// -/// Updates specific data for the user profile that's associated with the specified unique ID. +/// Update user profile data. +/// +/// +/// Update specific data for the user profile that is associated with a unique ID. /// /// public sealed partial class UpdateUserProfileDataRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RepositoryVerifyIntegrityRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RepositoryVerifyIntegrityRequest.g.cs new file mode 100644 index 0000000000..cd7e8c26dd --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RepositoryVerifyIntegrityRequest.g.cs @@ -0,0 +1,215 @@ +// 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.Requests; +using Elastic.Clients.Elasticsearch.Serialization; +using Elastic.Transport; +using Elastic.Transport.Extensions; +using System; +using System.Collections.Generic; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Snapshot; + +public sealed partial class RepositoryVerifyIntegrityRequestParameters : RequestParameters +{ + /// + /// + /// Number of threads to use for reading blob contents + /// + /// + public int? BlobThreadPoolConcurrency { get => Q("blob_thread_pool_concurrency"); set => Q("blob_thread_pool_concurrency", value); } + + /// + /// + /// Number of snapshots to verify concurrently within each index + /// + /// + public int? IndexSnapshotVerificationConcurrency { get => Q("index_snapshot_verification_concurrency"); set => Q("index_snapshot_verification_concurrency", value); } + + /// + /// + /// Number of indices to verify concurrently + /// + /// + public int? IndexVerificationConcurrency { get => Q("index_verification_concurrency"); set => Q("index_verification_concurrency", value); } + + /// + /// + /// Rate limit for individual blob verification + /// + /// + public string? MaxBytesPerSec { get => Q("max_bytes_per_sec"); set => Q("max_bytes_per_sec", value); } + + /// + /// + /// Maximum permitted number of failed shard snapshots + /// + /// + public int? MaxFailedShardSnapshots { get => Q("max_failed_shard_snapshots"); set => Q("max_failed_shard_snapshots", value); } + + /// + /// + /// Number of threads to use for reading metadata + /// + /// + public int? MetaThreadPoolConcurrency { get => Q("meta_thread_pool_concurrency"); set => Q("meta_thread_pool_concurrency", value); } + + /// + /// + /// Number of snapshots to verify concurrently + /// + /// + public int? SnapshotVerificationConcurrency { get => Q("snapshot_verification_concurrency"); set => Q("snapshot_verification_concurrency", value); } + + /// + /// + /// Whether to verify the contents of individual blobs + /// + /// + public bool? VerifyBlobContents { get => Q("verify_blob_contents"); set => Q("verify_blob_contents", value); } +} + +/// +/// +/// Verifies the integrity of the contents of a snapshot repository +/// +/// +public sealed partial class RepositoryVerifyIntegrityRequest : PlainRequest +{ + public RepositoryVerifyIntegrityRequest(Elastic.Clients.Elasticsearch.Names name) : base(r => r.Required("repository", name)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.SnapshotRepositoryVerifyIntegrity; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => false; + + internal override string OperationName => "snapshot.repository_verify_integrity"; + + /// + /// + /// Number of threads to use for reading blob contents + /// + /// + [JsonIgnore] + public int? BlobThreadPoolConcurrency { get => Q("blob_thread_pool_concurrency"); set => Q("blob_thread_pool_concurrency", value); } + + /// + /// + /// Number of snapshots to verify concurrently within each index + /// + /// + [JsonIgnore] + public int? IndexSnapshotVerificationConcurrency { get => Q("index_snapshot_verification_concurrency"); set => Q("index_snapshot_verification_concurrency", value); } + + /// + /// + /// Number of indices to verify concurrently + /// + /// + [JsonIgnore] + public int? IndexVerificationConcurrency { get => Q("index_verification_concurrency"); set => Q("index_verification_concurrency", value); } + + /// + /// + /// Rate limit for individual blob verification + /// + /// + [JsonIgnore] + public string? MaxBytesPerSec { get => Q("max_bytes_per_sec"); set => Q("max_bytes_per_sec", value); } + + /// + /// + /// Maximum permitted number of failed shard snapshots + /// + /// + [JsonIgnore] + public int? MaxFailedShardSnapshots { get => Q("max_failed_shard_snapshots"); set => Q("max_failed_shard_snapshots", value); } + + /// + /// + /// Number of threads to use for reading metadata + /// + /// + [JsonIgnore] + public int? MetaThreadPoolConcurrency { get => Q("meta_thread_pool_concurrency"); set => Q("meta_thread_pool_concurrency", value); } + + /// + /// + /// Number of snapshots to verify concurrently + /// + /// + [JsonIgnore] + public int? SnapshotVerificationConcurrency { get => Q("snapshot_verification_concurrency"); set => Q("snapshot_verification_concurrency", value); } + + /// + /// + /// Whether to verify the contents of individual blobs + /// + /// + [JsonIgnore] + public bool? VerifyBlobContents { get => Q("verify_blob_contents"); set => Q("verify_blob_contents", value); } +} + +/// +/// +/// Verifies the integrity of the contents of a snapshot repository +/// +/// +public sealed partial class RepositoryVerifyIntegrityRequestDescriptor : RequestDescriptor +{ + internal RepositoryVerifyIntegrityRequestDescriptor(Action configure) => configure.Invoke(this); + + public RepositoryVerifyIntegrityRequestDescriptor(Elastic.Clients.Elasticsearch.Names name) : base(r => r.Required("repository", name)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.SnapshotRepositoryVerifyIntegrity; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => false; + + internal override string OperationName => "snapshot.repository_verify_integrity"; + + public RepositoryVerifyIntegrityRequestDescriptor BlobThreadPoolConcurrency(int? blobThreadPoolConcurrency) => Qs("blob_thread_pool_concurrency", blobThreadPoolConcurrency); + public RepositoryVerifyIntegrityRequestDescriptor IndexSnapshotVerificationConcurrency(int? indexSnapshotVerificationConcurrency) => Qs("index_snapshot_verification_concurrency", indexSnapshotVerificationConcurrency); + public RepositoryVerifyIntegrityRequestDescriptor IndexVerificationConcurrency(int? indexVerificationConcurrency) => Qs("index_verification_concurrency", indexVerificationConcurrency); + public RepositoryVerifyIntegrityRequestDescriptor MaxBytesPerSec(string? maxBytesPerSec) => Qs("max_bytes_per_sec", maxBytesPerSec); + public RepositoryVerifyIntegrityRequestDescriptor MaxFailedShardSnapshots(int? maxFailedShardSnapshots) => Qs("max_failed_shard_snapshots", maxFailedShardSnapshots); + public RepositoryVerifyIntegrityRequestDescriptor MetaThreadPoolConcurrency(int? metaThreadPoolConcurrency) => Qs("meta_thread_pool_concurrency", metaThreadPoolConcurrency); + public RepositoryVerifyIntegrityRequestDescriptor SnapshotVerificationConcurrency(int? snapshotVerificationConcurrency) => Qs("snapshot_verification_concurrency", snapshotVerificationConcurrency); + public RepositoryVerifyIntegrityRequestDescriptor VerifyBlobContents(bool? verifyBlobContents = true) => Qs("verify_blob_contents", verifyBlobContents); + + public RepositoryVerifyIntegrityRequestDescriptor Name(Elastic.Clients.Elasticsearch.Names name) + { + RouteValues.Required("repository", name); + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RepositoryVerifyIntegrityResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RepositoryVerifyIntegrityResponse.g.cs new file mode 100644 index 0000000000..15a2250ef7 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RepositoryVerifyIntegrityResponse.g.cs @@ -0,0 +1,31 @@ +// 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 Elastic.Transport.Products.Elasticsearch; +using System; +using System.Collections.Generic; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Snapshot; + +public sealed partial class RepositoryVerifyIntegrityResponse : ElasticsearchResponse +{ +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListRequest.g.cs index 228be9745b..4f382ea97d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListRequest.g.cs @@ -65,7 +65,7 @@ public sealed partial class ListRequestParameters : RequestParameters /// Comma-separated list of node IDs or names used to limit returned information. /// /// - public ICollection? NodeId { get => Q?>("node_id"); set => Q("node_id", value); } + public Elastic.Clients.Elasticsearch.NodeIds? Nodes { get => Q("nodes"); set => Q("nodes", value); } /// /// @@ -142,7 +142,7 @@ public sealed partial class ListRequest : PlainRequest /// /// [JsonIgnore] - public ICollection? NodeId { get => Q?>("node_id"); set => Q("node_id", value); } + public Elastic.Clients.Elasticsearch.NodeIds? Nodes { get => Q("nodes"); set => Q("nodes", value); } /// /// @@ -194,7 +194,7 @@ public ListRequestDescriptor() public ListRequestDescriptor Detailed(bool? detailed = true) => Qs("detailed", detailed); public ListRequestDescriptor GroupBy(Elastic.Clients.Elasticsearch.Tasks.GroupBy? groupBy) => Qs("group_by", groupBy); public ListRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); - public ListRequestDescriptor NodeId(ICollection? nodeId) => Qs("node_id", nodeId); + public ListRequestDescriptor Nodes(Elastic.Clients.Elasticsearch.NodeIds? nodes) => Qs("nodes", nodes); public ListRequestDescriptor ParentTaskId(Elastic.Clients.Elasticsearch.Id? parentTaskId) => Qs("parent_task_id", parentTaskId); public ListRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) => Qs("timeout", timeout); public ListRequestDescriptor WaitForCompletion(bool? waitForCompletion = true) => Qs("wait_for_completion", waitForCompletion); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermVectorsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermVectorsRequest.g.cs index 74cf80a255..f9052ff330 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermVectorsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermVectorsRequest.g.cs @@ -115,7 +115,9 @@ public sealed partial class TermVectorsRequestParameters : RequestParameters /// /// /// Get term vector information. -/// Returns information and statistics about terms in the fields of a particular document. +/// +/// +/// Get information and statistics about terms in the fields of a particular document. /// /// public sealed partial class TermVectorsRequest : PlainRequest @@ -255,7 +257,9 @@ public TermVectorsRequest(Elastic.Clients.Elasticsearch.IndexName index) : base( /// /// /// Get term vector information. -/// Returns information and statistics about terms in the fields of a particular document. +/// +/// +/// Get information and statistics about terms in the fields of a particular document. /// /// public sealed partial class TermVectorsRequestDescriptor : RequestDescriptor, TermVectorsRequestParameters> diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermsEnumRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermsEnumRequest.g.cs index 75a2b05b40..60b90b7037 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermsEnumRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TermsEnumRequest.g.cs @@ -36,7 +36,18 @@ public sealed partial class TermsEnumRequestParameters : RequestParameters /// /// -/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// Get terms in an index. +/// +/// +/// Discover terms that match a partial string in an index. +/// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. +/// +/// +/// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. +/// This can occur due to a few reasons, such as a request timeout or a node error. +/// +/// +/// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// public sealed partial class TermsEnumRequest : PlainRequest @@ -106,7 +117,18 @@ public TermsEnumRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r /// /// -/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// Get terms in an index. +/// +/// +/// Discover terms that match a partial string in an index. +/// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. +/// +/// +/// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. +/// This can occur due to a few reasons, such as a request timeout or a node error. +/// +/// +/// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// public sealed partial class TermsEnumRequestDescriptor : RequestDescriptor, TermsEnumRequestParameters> @@ -314,7 +336,18 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. +/// Get terms in an index. +/// +/// +/// Discover terms that match a partial string in an index. +/// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. +/// +/// +/// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. +/// This can occur due to a few reasons, such as a request timeout or a node error. +/// +/// +/// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// public sealed partial class TermsEnumRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs index 5a793d21b2..6ee3ca87ed 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs @@ -42,7 +42,11 @@ public sealed partial class UpdateByQueryRethrottleRequestParameters : RequestPa /// /// -/// Changes the number of requests per second for a particular Update By Query operation. +/// Throttle an update by query operation. +/// +/// +/// Change the number of requests per second for a particular update by query operation. +/// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// public sealed partial class UpdateByQueryRethrottleRequest : PlainRequest @@ -70,7 +74,11 @@ public UpdateByQueryRethrottleRequest(Elastic.Clients.Elasticsearch.Id taskId) : /// /// -/// Changes the number of requests per second for a particular Update By Query operation. +/// Throttle an update by query operation. +/// +/// +/// Change the number of requests per second for a particular update by query operation. +/// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// public sealed partial class UpdateByQueryRethrottleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs index 0169e8ecc2..c84b1f2282 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs @@ -41,12 +41,14 @@ internal AsyncSearchNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteAsyncSearchResponse Delete(DeleteAsyncSearchRequest request) @@ -57,12 +59,14 @@ public virtual DeleteAsyncSearchResponse Delete(DeleteAsyncSearchRequest request /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteAsyncSearchRequest request, CancellationToken cancellationToken = default) { @@ -72,12 +76,14 @@ public virtual Task DeleteAsync(DeleteAsyncSearchRequ /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteAsyncSearchResponse Delete(DeleteAsyncSearchRequestDescriptor descriptor) @@ -88,12 +94,14 @@ public virtual DeleteAsyncSearchResponse Delete(DeleteAsyncSearchRequ /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteAsyncSearchResponse Delete(Elastic.Clients.Elasticsearch.Id id) @@ -105,12 +113,14 @@ public virtual DeleteAsyncSearchResponse Delete(Elastic.Clients.Elast /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteAsyncSearchResponse Delete(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest) @@ -123,12 +133,14 @@ public virtual DeleteAsyncSearchResponse Delete(Elastic.Clients.Elast /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteAsyncSearchResponse Delete(DeleteAsyncSearchRequestDescriptor descriptor) @@ -139,12 +151,14 @@ public virtual DeleteAsyncSearchResponse Delete(DeleteAsyncSearchRequestDescript /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteAsyncSearchResponse Delete(Elastic.Clients.Elasticsearch.Id id) @@ -156,12 +170,14 @@ public virtual DeleteAsyncSearchResponse Delete(Elastic.Clients.Elasticsearch.Id /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteAsyncSearchResponse Delete(Elastic.Clients.Elasticsearch.Id id, Action configureRequest) @@ -174,12 +190,14 @@ public virtual DeleteAsyncSearchResponse Delete(Elastic.Clients.Elasticsearch.Id /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -189,12 +207,14 @@ public virtual Task DeleteAsync(DeleteAsyn /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -205,12 +225,14 @@ public virtual Task DeleteAsync(Elastic.Cl /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -222,12 +244,14 @@ public virtual Task DeleteAsync(Elastic.Cl /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(DeleteAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -237,12 +261,14 @@ public virtual Task DeleteAsync(DeleteAsyncSearchRequ /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -253,12 +279,14 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast /// /// - /// Deletes an async search by identifier. - /// If the search is still running, the search request will be cancelled. + /// Delete an async search. + /// + /// + /// If the asynchronous search is still running, it is cancelled. /// Otherwise, the saved search results are deleted. /// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) { @@ -270,10 +298,13 @@ public virtual Task DeleteAsync(Elastic.Clients.Elast /// /// - /// Retrieves the results of a previously submitted async search request given its identifier. + /// Get async search results. + /// + /// + /// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetAsyncSearchResponse Get(GetAsyncSearchRequest request) @@ -284,10 +315,13 @@ public virtual GetAsyncSearchResponse Get(GetAsyncSearchRe /// /// - /// Retrieves the results of a previously submitted async search request given its identifier. + /// Get async search results. + /// + /// + /// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(GetAsyncSearchRequest request, CancellationToken cancellationToken = default) { @@ -297,10 +331,13 @@ public virtual Task> GetAsync(GetAs /// /// - /// Retrieves the results of a previously submitted async search request given its identifier. + /// Get async search results. + /// + /// + /// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetAsyncSearchResponse Get(GetAsyncSearchRequestDescriptor descriptor) @@ -311,10 +348,13 @@ public virtual GetAsyncSearchResponse Get(GetAsyncSearchRe /// /// - /// Retrieves the results of a previously submitted async search request given its identifier. + /// Get async search results. + /// + /// + /// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetAsyncSearchResponse Get(Elastic.Clients.Elasticsearch.Id id) @@ -326,10 +366,13 @@ public virtual GetAsyncSearchResponse Get(Elastic.Clients. /// /// - /// Retrieves the results of a previously submitted async search request given its identifier. + /// Get async search results. + /// + /// + /// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetAsyncSearchResponse Get(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest) @@ -342,10 +385,13 @@ public virtual GetAsyncSearchResponse Get(Elastic.Clients. /// /// - /// Retrieves the results of a previously submitted async search request given its identifier. + /// Get async search results. + /// + /// + /// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(GetAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -355,10 +401,13 @@ public virtual Task> GetAsync(GetAs /// /// - /// Retrieves the results of a previously submitted async search request given its identifier. + /// Get async search results. + /// + /// + /// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -369,10 +418,13 @@ public virtual Task> GetAsync(Elast /// /// - /// Retrieves the results of a previously submitted async search request given its identifier. + /// Get async search results. + /// + /// + /// Retrieve the results of a previously submitted asynchronous search request. /// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -384,11 +436,13 @@ public virtual Task> GetAsync(Elast /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AsyncSearchStatusResponse Status(AsyncSearchStatusRequest request) @@ -399,11 +453,13 @@ public virtual AsyncSearchStatusResponse Status(AsyncSearchStatusRequest request /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(AsyncSearchStatusRequest request, CancellationToken cancellationToken = default) { @@ -413,11 +469,13 @@ public virtual Task StatusAsync(AsyncSearchStatusRequ /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AsyncSearchStatusResponse Status(AsyncSearchStatusRequestDescriptor descriptor) @@ -428,11 +486,13 @@ public virtual AsyncSearchStatusResponse Status(AsyncSearchStatusRequ /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AsyncSearchStatusResponse Status(Elastic.Clients.Elasticsearch.Id id) @@ -444,11 +504,13 @@ public virtual AsyncSearchStatusResponse Status(Elastic.Clients.Elast /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AsyncSearchStatusResponse Status(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest) @@ -461,11 +523,13 @@ public virtual AsyncSearchStatusResponse Status(Elastic.Clients.Elast /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AsyncSearchStatusResponse Status(AsyncSearchStatusRequestDescriptor descriptor) @@ -476,11 +540,13 @@ public virtual AsyncSearchStatusResponse Status(AsyncSearchStatusRequestDescript /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AsyncSearchStatusResponse Status(Elastic.Clients.Elasticsearch.Id id) @@ -492,11 +558,13 @@ public virtual AsyncSearchStatusResponse Status(Elastic.Clients.Elasticsearch.Id /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AsyncSearchStatusResponse Status(Elastic.Clients.Elasticsearch.Id id, Action configureRequest) @@ -509,11 +577,13 @@ public virtual AsyncSearchStatusResponse Status(Elastic.Clients.Elasticsearch.Id /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(AsyncSearchStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -523,11 +593,13 @@ public virtual Task StatusAsync(AsyncSearc /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -538,11 +610,13 @@ public virtual Task StatusAsync(Elastic.Cl /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -554,11 +628,13 @@ public virtual Task StatusAsync(Elastic.Cl /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(AsyncSearchStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -568,11 +644,13 @@ public virtual Task StatusAsync(AsyncSearchStatusRequ /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -583,11 +661,13 @@ public virtual Task StatusAsync(Elastic.Clients.Elast /// /// - /// Get async search status - /// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + /// Get the async search status. + /// + /// + /// Get the status of a previously submitted async search request given its identifier, without retrieving search results. /// If the Elasticsearch security features are enabled, use of this API is restricted to the monitoring_user role. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatusAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) { @@ -599,13 +679,19 @@ public virtual Task StatusAsync(Elastic.Clients.Elast /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SubmitAsyncSearchResponse Submit(SubmitAsyncSearchRequest request) @@ -616,13 +702,19 @@ public virtual SubmitAsyncSearchResponse Submit(SubmitAsyn /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(SubmitAsyncSearchRequest request, CancellationToken cancellationToken = default) { @@ -632,13 +724,19 @@ public virtual Task> SubmitAsync /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SubmitAsyncSearchResponse Submit(SubmitAsyncSearchRequestDescriptor descriptor) @@ -649,13 +747,19 @@ public virtual SubmitAsyncSearchResponse Submit(SubmitAsyn /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SubmitAsyncSearchResponse Submit(Elastic.Clients.Elasticsearch.Indices? indices) @@ -667,13 +771,19 @@ public virtual SubmitAsyncSearchResponse Submit(Elastic.Cl /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SubmitAsyncSearchResponse Submit(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest) @@ -686,13 +796,19 @@ public virtual SubmitAsyncSearchResponse Submit(Elastic.Cl /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SubmitAsyncSearchResponse Submit() @@ -704,13 +820,19 @@ public virtual SubmitAsyncSearchResponse Submit() /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SubmitAsyncSearchResponse Submit(Action> configureRequest) @@ -723,13 +845,19 @@ public virtual SubmitAsyncSearchResponse Submit(Action /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(SubmitAsyncSearchRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -739,13 +867,19 @@ public virtual Task> SubmitAsync /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) { @@ -756,13 +890,19 @@ public virtual Task> SubmitAsync /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -774,13 +914,19 @@ public virtual Task> SubmitAsync /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(CancellationToken cancellationToken = default) { @@ -791,13 +937,19 @@ public virtual Task> SubmitAsync /// /// - /// Runs a search request asynchronously. - /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - /// Warning: Async search does not support scroll nor search requests that only include the suggest section. - /// By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + /// Run an async search. + /// + /// + /// When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + /// + /// + /// Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + /// + /// + /// By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. /// The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> SubmitAsync(Action> configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ccr.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ccr.g.cs index 302f2b4bcc..c0e14ca6cc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ccr.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ccr.g.cs @@ -43,7 +43,7 @@ internal CrossClusterReplicationNamespacedClient(ElasticsearchClient client) : b /// /// Deletes auto-follow patterns. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(DeleteAutoFollowPatternRequest request) @@ -56,7 +56,7 @@ public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(DeleteAut /// /// Deletes auto-follow patterns. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAutoFollowPatternAsync(DeleteAutoFollowPatternRequest request, CancellationToken cancellationToken = default) { @@ -68,7 +68,7 @@ public virtual Task DeleteAutoFollowPatternAsyn /// /// Deletes auto-follow patterns. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(DeleteAutoFollowPatternRequestDescriptor descriptor) @@ -81,7 +81,7 @@ public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(DeleteAut /// /// Deletes auto-follow patterns. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(Elastic.Clients.Elasticsearch.Name name) @@ -95,7 +95,7 @@ public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(Elastic.C /// /// Deletes auto-follow patterns. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(Elastic.Clients.Elasticsearch.Name name, Action configureRequest) @@ -110,7 +110,7 @@ public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(Elastic.C /// /// Deletes auto-follow patterns. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAutoFollowPatternAsync(DeleteAutoFollowPatternRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -122,7 +122,7 @@ public virtual Task DeleteAutoFollowPatternAsyn /// /// Deletes auto-follow patterns. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) { @@ -135,7 +135,7 @@ public virtual Task DeleteAutoFollowPatternAsyn /// /// Deletes auto-follow patterns. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -149,7 +149,7 @@ public virtual Task DeleteAutoFollowPatternAsyn /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowResponse Follow(FollowRequest request) @@ -162,7 +162,7 @@ public virtual FollowResponse Follow(FollowRequest request) /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(FollowRequest request, CancellationToken cancellationToken = default) { @@ -174,7 +174,7 @@ public virtual Task FollowAsync(FollowRequest request, Cancellat /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowResponse Follow(FollowRequestDescriptor descriptor) @@ -187,7 +187,7 @@ public virtual FollowResponse Follow(FollowRequestDescriptor /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName index) @@ -201,7 +201,7 @@ public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.In /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest) @@ -216,7 +216,7 @@ public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.In /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowResponse Follow() @@ -230,7 +230,7 @@ public virtual FollowResponse Follow() /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowResponse Follow(Action> configureRequest) @@ -245,7 +245,7 @@ public virtual FollowResponse Follow(Action /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowResponse Follow(FollowRequestDescriptor descriptor) @@ -258,7 +258,7 @@ public virtual FollowResponse Follow(FollowRequestDescriptor descriptor) /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName index) @@ -272,7 +272,7 @@ public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName ind /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest) @@ -287,7 +287,7 @@ public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName ind /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(FollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -299,7 +299,7 @@ public virtual Task FollowAsync(FollowRequestDescript /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -312,7 +312,7 @@ public virtual Task FollowAsync(Elastic.Clients.Elast /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -326,7 +326,7 @@ public virtual Task FollowAsync(Elastic.Clients.Elast /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(CancellationToken cancellationToken = default) { @@ -339,7 +339,7 @@ public virtual Task FollowAsync(CancellationToken can /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -353,7 +353,7 @@ public virtual Task FollowAsync(Action /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(FollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -365,7 +365,7 @@ public virtual Task FollowAsync(FollowRequestDescriptor descript /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -378,7 +378,7 @@ public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.In /// /// Creates a new follower index configured to follow the referenced leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) { @@ -392,7 +392,7 @@ public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.In /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowInfoResponse FollowInfo(FollowInfoRequest request) @@ -405,7 +405,7 @@ public virtual FollowInfoResponse FollowInfo(FollowInfoRequest request) /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(FollowInfoRequest request, CancellationToken cancellationToken = default) { @@ -417,7 +417,7 @@ public virtual Task FollowInfoAsync(FollowInfoRequest reques /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowInfoResponse FollowInfo(FollowInfoRequestDescriptor descriptor) @@ -430,7 +430,7 @@ public virtual FollowInfoResponse FollowInfo(FollowInfoRequestDescrip /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indices indices) @@ -444,7 +444,7 @@ public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elastics /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest) @@ -459,7 +459,7 @@ public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elastics /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowInfoResponse FollowInfo() @@ -473,7 +473,7 @@ public virtual FollowInfoResponse FollowInfo() /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowInfoResponse FollowInfo(Action> configureRequest) @@ -488,7 +488,7 @@ public virtual FollowInfoResponse FollowInfo(Action /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowInfoResponse FollowInfo(FollowInfoRequestDescriptor descriptor) @@ -501,7 +501,7 @@ public virtual FollowInfoResponse FollowInfo(FollowInfoRequestDescriptor descrip /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indices indices) @@ -515,7 +515,7 @@ public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indic /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest) @@ -530,7 +530,7 @@ public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indic /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(FollowInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -542,7 +542,7 @@ public virtual Task FollowInfoAsync(FollowInfoReq /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -555,7 +555,7 @@ public virtual Task FollowInfoAsync(Elastic.Clien /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -569,7 +569,7 @@ public virtual Task FollowInfoAsync(Elastic.Clien /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(CancellationToken cancellationToken = default) { @@ -582,7 +582,7 @@ public virtual Task FollowInfoAsync(CancellationT /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -596,7 +596,7 @@ public virtual Task FollowInfoAsync(Action /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(FollowInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -608,7 +608,7 @@ public virtual Task FollowInfoAsync(FollowInfoRequestDescrip /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -621,7 +621,7 @@ public virtual Task FollowInfoAsync(Elastic.Clients.Elastics /// /// Retrieves information about all follower indices, including parameters and status for each follower index /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowInfoAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -635,7 +635,7 @@ public virtual Task FollowInfoAsync(Elastic.Clients.Elastics /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowStatsResponse FollowStats(FollowStatsRequest request) @@ -648,7 +648,7 @@ public virtual FollowStatsResponse FollowStats(FollowStatsRequest request) /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(FollowStatsRequest request, CancellationToken cancellationToken = default) { @@ -660,7 +660,7 @@ public virtual Task FollowStatsAsync(FollowStatsRequest req /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowStatsResponse FollowStats(FollowStatsRequestDescriptor descriptor) @@ -673,7 +673,7 @@ public virtual FollowStatsResponse FollowStats(FollowStatsRequestDesc /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowStatsResponse FollowStats(Elastic.Clients.Elasticsearch.Indices indices) @@ -687,7 +687,7 @@ public virtual FollowStatsResponse FollowStats(Elastic.Clients.Elasti /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowStatsResponse FollowStats(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest) @@ -702,7 +702,7 @@ public virtual FollowStatsResponse FollowStats(Elastic.Clients.Elasti /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowStatsResponse FollowStats() @@ -716,7 +716,7 @@ public virtual FollowStatsResponse FollowStats() /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowStatsResponse FollowStats(Action> configureRequest) @@ -731,7 +731,7 @@ public virtual FollowStatsResponse FollowStats(Action /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowStatsResponse FollowStats(FollowStatsRequestDescriptor descriptor) @@ -744,7 +744,7 @@ public virtual FollowStatsResponse FollowStats(FollowStatsRequestDescriptor desc /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowStatsResponse FollowStats(Elastic.Clients.Elasticsearch.Indices indices) @@ -758,7 +758,7 @@ public virtual FollowStatsResponse FollowStats(Elastic.Clients.Elasticsearch.Ind /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FollowStatsResponse FollowStats(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest) @@ -773,7 +773,7 @@ public virtual FollowStatsResponse FollowStats(Elastic.Clients.Elasticsearch.Ind /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(FollowStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -785,7 +785,7 @@ public virtual Task FollowStatsAsync(FollowStats /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -798,7 +798,7 @@ public virtual Task FollowStatsAsync(Elastic.Cli /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -812,7 +812,7 @@ public virtual Task FollowStatsAsync(Elastic.Cli /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(CancellationToken cancellationToken = default) { @@ -825,7 +825,7 @@ public virtual Task FollowStatsAsync(Cancellatio /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -839,7 +839,7 @@ public virtual Task FollowStatsAsync(Action /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(FollowStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -851,7 +851,7 @@ public virtual Task FollowStatsAsync(FollowStatsRequestDesc /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -864,7 +864,7 @@ public virtual Task FollowStatsAsync(Elastic.Clients.Elasti /// /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FollowStatsAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -878,7 +878,7 @@ public virtual Task FollowStatsAsync(Elastic.Clients.Elasti /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ForgetFollowerResponse ForgetFollower(ForgetFollowerRequest request) @@ -891,7 +891,7 @@ public virtual ForgetFollowerResponse ForgetFollower(ForgetFollowerRequest reque /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(ForgetFollowerRequest request, CancellationToken cancellationToken = default) { @@ -903,7 +903,7 @@ public virtual Task ForgetFollowerAsync(ForgetFollowerRe /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ForgetFollowerResponse ForgetFollower(ForgetFollowerRequestDescriptor descriptor) @@ -916,7 +916,7 @@ public virtual ForgetFollowerResponse ForgetFollower(ForgetFollowerRe /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients.Elasticsearch.IndexName index) @@ -930,7 +930,7 @@ public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients. /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest) @@ -945,7 +945,7 @@ public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients. /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ForgetFollowerResponse ForgetFollower() @@ -959,7 +959,7 @@ public virtual ForgetFollowerResponse ForgetFollower() /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ForgetFollowerResponse ForgetFollower(Action> configureRequest) @@ -974,7 +974,7 @@ public virtual ForgetFollowerResponse ForgetFollower(Action /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ForgetFollowerResponse ForgetFollower(ForgetFollowerRequestDescriptor descriptor) @@ -987,7 +987,7 @@ public virtual ForgetFollowerResponse ForgetFollower(ForgetFollowerRequestDescri /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients.Elasticsearch.IndexName index) @@ -1001,7 +1001,7 @@ public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients.Elasticsear /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest) @@ -1016,7 +1016,7 @@ public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients.Elasticsear /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(ForgetFollowerRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1028,7 +1028,7 @@ public virtual Task ForgetFollowerAsync(Forge /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -1041,7 +1041,7 @@ public virtual Task ForgetFollowerAsync(Elast /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1055,7 +1055,7 @@ public virtual Task ForgetFollowerAsync(Elast /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(CancellationToken cancellationToken = default) { @@ -1068,7 +1068,7 @@ public virtual Task ForgetFollowerAsync(Cance /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1082,7 +1082,7 @@ public virtual Task ForgetFollowerAsync(Actio /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(ForgetFollowerRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1094,7 +1094,7 @@ public virtual Task ForgetFollowerAsync(ForgetFollowerRe /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -1107,7 +1107,7 @@ public virtual Task ForgetFollowerAsync(Elastic.Clients. /// /// Removes the follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1121,7 +1121,7 @@ public virtual Task ForgetFollowerAsync(Elastic.Clients. /// /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(GetAutoFollowPatternRequest request) @@ -1134,7 +1134,7 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(GetAutoFollowPa /// /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAutoFollowPatternAsync(GetAutoFollowPatternRequest request, CancellationToken cancellationToken = default) { @@ -1146,7 +1146,7 @@ public virtual Task GetAutoFollowPatternAsync(GetA /// /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(GetAutoFollowPatternRequestDescriptor descriptor) @@ -1159,7 +1159,7 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(GetAutoFollowPa /// /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(Elastic.Clients.Elasticsearch.Name? name) @@ -1173,7 +1173,7 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(Elastic.Clients /// /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(Elastic.Clients.Elasticsearch.Name? name, Action configureRequest) @@ -1188,7 +1188,7 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(Elastic.Clients /// /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetAutoFollowPatternResponse GetAutoFollowPattern() @@ -1202,7 +1202,7 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern() /// /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(Action configureRequest) @@ -1217,7 +1217,7 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(Action /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAutoFollowPatternAsync(GetAutoFollowPatternRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1229,7 +1229,7 @@ public virtual Task GetAutoFollowPatternAsync(GetA /// /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name? name, CancellationToken cancellationToken = default) { @@ -1242,7 +1242,7 @@ public virtual Task GetAutoFollowPatternAsync(Elas /// /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name? name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1256,7 +1256,7 @@ public virtual Task GetAutoFollowPatternAsync(Elas /// /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAutoFollowPatternAsync(CancellationToken cancellationToken = default) { @@ -1269,7 +1269,7 @@ public virtual Task GetAutoFollowPatternAsync(Canc /// /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAutoFollowPatternAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -1283,7 +1283,7 @@ public virtual Task GetAutoFollowPatternAsync(Acti /// /// Pauses an auto-follow pattern /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(PauseAutoFollowPatternRequest request) @@ -1296,7 +1296,7 @@ public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(PauseAutoFo /// /// Pauses an auto-follow pattern /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseAutoFollowPatternAsync(PauseAutoFollowPatternRequest request, CancellationToken cancellationToken = default) { @@ -1308,7 +1308,7 @@ public virtual Task PauseAutoFollowPatternAsync( /// /// Pauses an auto-follow pattern /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(PauseAutoFollowPatternRequestDescriptor descriptor) @@ -1321,7 +1321,7 @@ public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(PauseAutoFo /// /// Pauses an auto-follow pattern /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(Elastic.Clients.Elasticsearch.Name name) @@ -1335,7 +1335,7 @@ public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(Elastic.Cli /// /// Pauses an auto-follow pattern /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(Elastic.Clients.Elasticsearch.Name name, Action configureRequest) @@ -1350,7 +1350,7 @@ public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(Elastic.Cli /// /// Pauses an auto-follow pattern /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseAutoFollowPatternAsync(PauseAutoFollowPatternRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1362,7 +1362,7 @@ public virtual Task PauseAutoFollowPatternAsync( /// /// Pauses an auto-follow pattern /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) { @@ -1375,7 +1375,7 @@ public virtual Task PauseAutoFollowPatternAsync( /// /// Pauses an auto-follow pattern /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1389,7 +1389,7 @@ public virtual Task PauseAutoFollowPatternAsync( /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseFollowResponse PauseFollow(PauseFollowRequest request) @@ -1402,7 +1402,7 @@ public virtual PauseFollowResponse PauseFollow(PauseFollowRequest request) /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(PauseFollowRequest request, CancellationToken cancellationToken = default) { @@ -1414,7 +1414,7 @@ public virtual Task PauseFollowAsync(PauseFollowRequest req /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseFollowResponse PauseFollow(PauseFollowRequestDescriptor descriptor) @@ -1427,7 +1427,7 @@ public virtual PauseFollowResponse PauseFollow(PauseFollowRequestDesc /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasticsearch.IndexName index) @@ -1441,7 +1441,7 @@ public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasti /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest) @@ -1456,7 +1456,7 @@ public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasti /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseFollowResponse PauseFollow() @@ -1470,7 +1470,7 @@ public virtual PauseFollowResponse PauseFollow() /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseFollowResponse PauseFollow(Action> configureRequest) @@ -1485,7 +1485,7 @@ public virtual PauseFollowResponse PauseFollow(Action /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseFollowResponse PauseFollow(PauseFollowRequestDescriptor descriptor) @@ -1498,7 +1498,7 @@ public virtual PauseFollowResponse PauseFollow(PauseFollowRequestDescriptor desc /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasticsearch.IndexName index) @@ -1512,7 +1512,7 @@ public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasticsearch.Ind /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest) @@ -1527,7 +1527,7 @@ public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasticsearch.Ind /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(PauseFollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1539,7 +1539,7 @@ public virtual Task PauseFollowAsync(PauseFollow /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -1552,7 +1552,7 @@ public virtual Task PauseFollowAsync(Elastic.Cli /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1566,7 +1566,7 @@ public virtual Task PauseFollowAsync(Elastic.Cli /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(CancellationToken cancellationToken = default) { @@ -1579,7 +1579,7 @@ public virtual Task PauseFollowAsync(Cancellatio /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1593,7 +1593,7 @@ public virtual Task PauseFollowAsync(Action /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(PauseFollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1605,7 +1605,7 @@ public virtual Task PauseFollowAsync(PauseFollowRequestDesc /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -1618,7 +1618,7 @@ public virtual Task PauseFollowAsync(Elastic.Clients.Elasti /// /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1632,7 +1632,7 @@ public virtual Task PauseFollowAsync(Elastic.Clients.Elasti /// /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutAutoFollowPatternResponse PutAutoFollowPattern(PutAutoFollowPatternRequest request) @@ -1645,7 +1645,7 @@ public virtual PutAutoFollowPatternResponse PutAutoFollowPattern(PutAutoFollowPa /// /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAutoFollowPatternAsync(PutAutoFollowPatternRequest request, CancellationToken cancellationToken = default) { @@ -1657,7 +1657,7 @@ public virtual Task PutAutoFollowPatternAsync(PutA /// /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutAutoFollowPatternResponse PutAutoFollowPattern(PutAutoFollowPatternRequestDescriptor descriptor) @@ -1670,7 +1670,7 @@ public virtual PutAutoFollowPatternResponse PutAutoFollowPattern(PutAutoFollowPa /// /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutAutoFollowPatternResponse PutAutoFollowPattern(Elastic.Clients.Elasticsearch.Name name) @@ -1684,7 +1684,7 @@ public virtual PutAutoFollowPatternResponse PutAutoFollowPattern(Elastic.Clients /// /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutAutoFollowPatternResponse PutAutoFollowPattern(Elastic.Clients.Elasticsearch.Name name, Action configureRequest) @@ -1699,7 +1699,7 @@ public virtual PutAutoFollowPatternResponse PutAutoFollowPattern(Elastic.Clients /// /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAutoFollowPatternAsync(PutAutoFollowPatternRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1711,7 +1711,7 @@ public virtual Task PutAutoFollowPatternAsync(PutA /// /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) { @@ -1724,7 +1724,7 @@ public virtual Task PutAutoFollowPatternAsync(Elas /// /// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1738,7 +1738,7 @@ public virtual Task PutAutoFollowPatternAsync(Elas /// /// Resumes an auto-follow pattern that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(ResumeAutoFollowPatternRequest request) @@ -1751,7 +1751,7 @@ public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(ResumeAut /// /// Resumes an auto-follow pattern that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeAutoFollowPatternAsync(ResumeAutoFollowPatternRequest request, CancellationToken cancellationToken = default) { @@ -1763,7 +1763,7 @@ public virtual Task ResumeAutoFollowPatternAsyn /// /// Resumes an auto-follow pattern that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(ResumeAutoFollowPatternRequestDescriptor descriptor) @@ -1776,7 +1776,7 @@ public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(ResumeAut /// /// Resumes an auto-follow pattern that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(Elastic.Clients.Elasticsearch.Name name) @@ -1790,7 +1790,7 @@ public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(Elastic.C /// /// Resumes an auto-follow pattern that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(Elastic.Clients.Elasticsearch.Name name, Action configureRequest) @@ -1805,7 +1805,7 @@ public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(Elastic.C /// /// Resumes an auto-follow pattern that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeAutoFollowPatternAsync(ResumeAutoFollowPatternRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1817,7 +1817,7 @@ public virtual Task ResumeAutoFollowPatternAsyn /// /// Resumes an auto-follow pattern that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) { @@ -1830,7 +1830,7 @@ public virtual Task ResumeAutoFollowPatternAsyn /// /// Resumes an auto-follow pattern that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1844,7 +1844,7 @@ public virtual Task ResumeAutoFollowPatternAsyn /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeFollowResponse ResumeFollow(ResumeFollowRequest request) @@ -1857,7 +1857,7 @@ public virtual ResumeFollowResponse ResumeFollow(ResumeFollowRequest request) /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(ResumeFollowRequest request, CancellationToken cancellationToken = default) { @@ -1869,7 +1869,7 @@ public virtual Task ResumeFollowAsync(ResumeFollowRequest /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeFollowResponse ResumeFollow(ResumeFollowRequestDescriptor descriptor) @@ -1882,7 +1882,7 @@ public virtual ResumeFollowResponse ResumeFollow(ResumeFollowRequestD /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.IndexName index) @@ -1896,7 +1896,7 @@ public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elas /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest) @@ -1911,7 +1911,7 @@ public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elas /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeFollowResponse ResumeFollow() @@ -1925,7 +1925,7 @@ public virtual ResumeFollowResponse ResumeFollow() /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeFollowResponse ResumeFollow(Action> configureRequest) @@ -1940,7 +1940,7 @@ public virtual ResumeFollowResponse ResumeFollow(Action /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeFollowResponse ResumeFollow(ResumeFollowRequestDescriptor descriptor) @@ -1953,7 +1953,7 @@ public virtual ResumeFollowResponse ResumeFollow(ResumeFollowRequestDescriptor d /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.IndexName index) @@ -1967,7 +1967,7 @@ public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.I /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest) @@ -1982,7 +1982,7 @@ public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.I /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(ResumeFollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1994,7 +1994,7 @@ public virtual Task ResumeFollowAsync(ResumeFol /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -2007,7 +2007,7 @@ public virtual Task ResumeFollowAsync(Elastic.C /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -2021,7 +2021,7 @@ public virtual Task ResumeFollowAsync(Elastic.C /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(CancellationToken cancellationToken = default) { @@ -2034,7 +2034,7 @@ public virtual Task ResumeFollowAsync(Cancellat /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -2048,7 +2048,7 @@ public virtual Task ResumeFollowAsync(Action /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(ResumeFollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -2060,7 +2060,7 @@ public virtual Task ResumeFollowAsync(ResumeFollowRequestD /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -2073,7 +2073,7 @@ public virtual Task ResumeFollowAsync(Elastic.Clients.Elas /// /// Resumes a follower index that has been paused /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResumeFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) { @@ -2087,7 +2087,7 @@ public virtual Task ResumeFollowAsync(Elastic.Clients.Elas /// /// Gets all stats related to cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CcrStatsResponse Stats(CcrStatsRequest request) @@ -2100,7 +2100,7 @@ public virtual CcrStatsResponse Stats(CcrStatsRequest request) /// /// Gets all stats related to cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CcrStatsRequest request, CancellationToken cancellationToken = default) { @@ -2112,7 +2112,7 @@ public virtual Task StatsAsync(CcrStatsRequest request, Cancel /// /// Gets all stats related to cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CcrStatsResponse Stats(CcrStatsRequestDescriptor descriptor) @@ -2125,7 +2125,7 @@ public virtual CcrStatsResponse Stats(CcrStatsRequestDescriptor descriptor) /// /// Gets all stats related to cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CcrStatsResponse Stats() @@ -2139,7 +2139,7 @@ public virtual CcrStatsResponse Stats() /// /// Gets all stats related to cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CcrStatsResponse Stats(Action configureRequest) @@ -2154,7 +2154,7 @@ public virtual CcrStatsResponse Stats(Action configur /// /// Gets all stats related to cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CcrStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -2166,7 +2166,7 @@ public virtual Task StatsAsync(CcrStatsRequestDescriptor descr /// /// Gets all stats related to cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) { @@ -2179,7 +2179,7 @@ public virtual Task StatsAsync(CancellationToken cancellationT /// /// Gets all stats related to cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -2193,7 +2193,7 @@ public virtual Task StatsAsync(Action /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual UnfollowResponse Unfollow(UnfollowRequest request) @@ -2206,7 +2206,7 @@ public virtual UnfollowResponse Unfollow(UnfollowRequest request) /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(UnfollowRequest request, CancellationToken cancellationToken = default) { @@ -2218,7 +2218,7 @@ public virtual Task UnfollowAsync(UnfollowRequest request, Can /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual UnfollowResponse Unfollow(UnfollowRequestDescriptor descriptor) @@ -2231,7 +2231,7 @@ public virtual UnfollowResponse Unfollow(UnfollowRequestDescriptor /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual UnfollowResponse Unfollow(Elastic.Clients.Elasticsearch.IndexName index) @@ -2245,7 +2245,7 @@ public virtual UnfollowResponse Unfollow(Elastic.Clients.Elasticsearc /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual UnfollowResponse Unfollow(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest) @@ -2260,7 +2260,7 @@ public virtual UnfollowResponse Unfollow(Elastic.Clients.Elasticsearc /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual UnfollowResponse Unfollow() @@ -2274,7 +2274,7 @@ public virtual UnfollowResponse Unfollow() /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual UnfollowResponse Unfollow(Action> configureRequest) @@ -2289,7 +2289,7 @@ public virtual UnfollowResponse Unfollow(Action /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual UnfollowResponse Unfollow(UnfollowRequestDescriptor descriptor) @@ -2302,7 +2302,7 @@ public virtual UnfollowResponse Unfollow(UnfollowRequestDescriptor descriptor) /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual UnfollowResponse Unfollow(Elastic.Clients.Elasticsearch.IndexName index) @@ -2316,7 +2316,7 @@ public virtual UnfollowResponse Unfollow(Elastic.Clients.Elasticsearch.IndexName /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual UnfollowResponse Unfollow(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest) @@ -2331,7 +2331,7 @@ public virtual UnfollowResponse Unfollow(Elastic.Clients.Elasticsearch.IndexName /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(UnfollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -2343,7 +2343,7 @@ public virtual Task UnfollowAsync(UnfollowRequestDe /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -2356,7 +2356,7 @@ public virtual Task UnfollowAsync(Elastic.Clients.E /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -2370,7 +2370,7 @@ public virtual Task UnfollowAsync(Elastic.Clients.E /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(CancellationToken cancellationToken = default) { @@ -2383,7 +2383,7 @@ public virtual Task UnfollowAsync(CancellationToken /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -2397,7 +2397,7 @@ public virtual Task UnfollowAsync(Action /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(UnfollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -2409,7 +2409,7 @@ public virtual Task UnfollowAsync(UnfollowRequestDescriptor de /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -2422,7 +2422,7 @@ public virtual Task UnfollowAsync(Elastic.Clients.Elasticsearc /// /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Cluster.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Cluster.g.cs index b7c03eaef6..2bf54cd7d8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Cluster.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Cluster.g.cs @@ -43,7 +43,7 @@ internal ClusterNamespacedClient(ElasticsearchClient client) : base(client) /// /// Provides explanations for shard allocations in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AllocationExplainResponse AllocationExplain(AllocationExplainRequest request) @@ -56,7 +56,7 @@ public virtual AllocationExplainResponse AllocationExplain(AllocationExplainRequ /// /// Provides explanations for shard allocations in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(AllocationExplainRequest request, CancellationToken cancellationToken = default) { @@ -68,7 +68,7 @@ public virtual Task AllocationExplainAsync(Allocation /// /// Provides explanations for shard allocations in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AllocationExplainResponse AllocationExplain(AllocationExplainRequestDescriptor descriptor) @@ -81,7 +81,7 @@ public virtual AllocationExplainResponse AllocationExplain(AllocationExplainRequ /// /// Provides explanations for shard allocations in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AllocationExplainResponse AllocationExplain() @@ -95,7 +95,7 @@ public virtual AllocationExplainResponse AllocationExplain() /// /// Provides explanations for shard allocations in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AllocationExplainResponse AllocationExplain(Action configureRequest) @@ -110,7 +110,7 @@ public virtual AllocationExplainResponse AllocationExplain(Action /// Provides explanations for shard allocations in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(AllocationExplainRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -122,7 +122,7 @@ public virtual Task AllocationExplainAsync(Allocation /// /// Provides explanations for shard allocations in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(CancellationToken cancellationToken = default) { @@ -135,7 +135,7 @@ public virtual Task AllocationExplainAsync(Cancellati /// /// Provides explanations for shard allocations in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AllocationExplainAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -151,7 +151,7 @@ public virtual Task AllocationExplainAsync(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteComponentTemplateResponse DeleteComponentTemplate(DeleteComponentTemplateRequest request) @@ -166,7 +166,7 @@ public virtual DeleteComponentTemplateResponse DeleteComponentTemplate(DeleteCom /// Deletes component templates. /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(DeleteComponentTemplateRequest request, CancellationToken cancellationToken = default) { @@ -180,7 +180,7 @@ public virtual Task DeleteComponentTemplateAsyn /// Deletes component templates. /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteComponentTemplateResponse DeleteComponentTemplate(DeleteComponentTemplateRequestDescriptor descriptor) @@ -195,7 +195,7 @@ public virtual DeleteComponentTemplateResponse DeleteComponentTemplate(DeleteCom /// Deletes component templates. /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteComponentTemplateResponse DeleteComponentTemplate(Elastic.Clients.Elasticsearch.Names name) @@ -211,7 +211,7 @@ public virtual DeleteComponentTemplateResponse DeleteComponentTemplate(Elastic.C /// Deletes component templates. /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteComponentTemplateResponse DeleteComponentTemplate(Elastic.Clients.Elasticsearch.Names name, Action configureRequest) @@ -228,7 +228,7 @@ public virtual DeleteComponentTemplateResponse DeleteComponentTemplate(Elastic.C /// Deletes component templates. /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(DeleteComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -242,7 +242,7 @@ public virtual Task DeleteComponentTemplateAsyn /// Deletes component templates. /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) { @@ -257,7 +257,7 @@ public virtual Task DeleteComponentTemplateAsyn /// Deletes component templates. /// Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteComponentTemplateAsync(Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -271,7 +271,7 @@ public virtual Task DeleteComponentTemplateAsyn /// /// Clears cluster voting config exclusions. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request) @@ -284,7 +284,7 @@ public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions /// /// Clears cluster voting config exclusions. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteVotingConfigExclusionsAsync(DeleteVotingConfigExclusionsRequest request, CancellationToken cancellationToken = default) { @@ -296,7 +296,7 @@ public virtual Task DeleteVotingConfigExcl /// /// Clears cluster voting config exclusions. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequestDescriptor descriptor) @@ -309,7 +309,7 @@ public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions /// /// Clears cluster voting config exclusions. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions() @@ -323,7 +323,7 @@ public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions /// /// Clears cluster voting config exclusions. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions(Action configureRequest) @@ -338,7 +338,7 @@ public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions /// /// Clears cluster voting config exclusions. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteVotingConfigExclusionsAsync(DeleteVotingConfigExclusionsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -350,7 +350,7 @@ public virtual Task DeleteVotingConfigExcl /// /// Clears cluster voting config exclusions. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteVotingConfigExclusionsAsync(CancellationToken cancellationToken = default) { @@ -363,7 +363,7 @@ public virtual Task DeleteVotingConfigExcl /// /// Clears cluster voting config exclusions. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteVotingConfigExclusionsAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -378,7 +378,7 @@ public virtual Task DeleteVotingConfigExcl /// Check component templates. /// Returns information about whether a particular component template exists. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExistsComponentTemplateResponse ExistsComponentTemplate(ExistsComponentTemplateRequest request) @@ -392,7 +392,7 @@ public virtual ExistsComponentTemplateResponse ExistsComponentTemplate(ExistsCom /// Check component templates. /// Returns information about whether a particular component template exists. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(ExistsComponentTemplateRequest request, CancellationToken cancellationToken = default) { @@ -405,7 +405,7 @@ public virtual Task ExistsComponentTemplateAsyn /// Check component templates. /// Returns information about whether a particular component template exists. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExistsComponentTemplateResponse ExistsComponentTemplate(ExistsComponentTemplateRequestDescriptor descriptor) @@ -419,7 +419,7 @@ public virtual ExistsComponentTemplateResponse ExistsComponentTemplate(ExistsCom /// Check component templates. /// Returns information about whether a particular component template exists. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExistsComponentTemplateResponse ExistsComponentTemplate(Elastic.Clients.Elasticsearch.Names name) @@ -434,7 +434,7 @@ public virtual ExistsComponentTemplateResponse ExistsComponentTemplate(Elastic.C /// Check component templates. /// Returns information about whether a particular component template exists. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExistsComponentTemplateResponse ExistsComponentTemplate(Elastic.Clients.Elasticsearch.Names name, Action configureRequest) @@ -450,7 +450,7 @@ public virtual ExistsComponentTemplateResponse ExistsComponentTemplate(Elastic.C /// Check component templates. /// Returns information about whether a particular component template exists. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(ExistsComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -463,7 +463,7 @@ public virtual Task ExistsComponentTemplateAsyn /// Check component templates. /// Returns information about whether a particular component template exists. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) { @@ -477,7 +477,7 @@ public virtual Task ExistsComponentTemplateAsyn /// Check component templates. /// Returns information about whether a particular component template exists. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExistsComponentTemplateAsync(Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -492,7 +492,7 @@ public virtual Task ExistsComponentTemplateAsyn /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetComponentTemplateResponse GetComponentTemplate(GetComponentTemplateRequest request) @@ -506,7 +506,7 @@ public virtual GetComponentTemplateResponse GetComponentTemplate(GetComponentTem /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(GetComponentTemplateRequest request, CancellationToken cancellationToken = default) { @@ -519,7 +519,7 @@ public virtual Task GetComponentTemplateAsync(GetC /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetComponentTemplateResponse GetComponentTemplate(GetComponentTemplateRequestDescriptor descriptor) @@ -533,7 +533,7 @@ public virtual GetComponentTemplateResponse GetComponentTemplate(GetComponentTem /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetComponentTemplateResponse GetComponentTemplate(Elastic.Clients.Elasticsearch.Name? name) @@ -548,7 +548,7 @@ public virtual GetComponentTemplateResponse GetComponentTemplate(Elastic.Clients /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetComponentTemplateResponse GetComponentTemplate(Elastic.Clients.Elasticsearch.Name? name, Action configureRequest) @@ -564,7 +564,7 @@ public virtual GetComponentTemplateResponse GetComponentTemplate(Elastic.Clients /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetComponentTemplateResponse GetComponentTemplate() @@ -579,7 +579,7 @@ public virtual GetComponentTemplateResponse GetComponentTemplate() /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetComponentTemplateResponse GetComponentTemplate(Action configureRequest) @@ -595,7 +595,7 @@ public virtual GetComponentTemplateResponse GetComponentTemplate(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(GetComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -608,7 +608,7 @@ public virtual Task GetComponentTemplateAsync(GetC /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(Elastic.Clients.Elasticsearch.Name? name, CancellationToken cancellationToken = default) { @@ -622,7 +622,7 @@ public virtual Task GetComponentTemplateAsync(Elas /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(Elastic.Clients.Elasticsearch.Name? name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -637,7 +637,7 @@ public virtual Task GetComponentTemplateAsync(Elas /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(CancellationToken cancellationToken = default) { @@ -651,7 +651,7 @@ public virtual Task GetComponentTemplateAsync(Canc /// Get component templates. /// Retrieves information about component templates. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetComponentTemplateAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -666,7 +666,7 @@ public virtual Task GetComponentTemplateAsync(Acti /// Returns cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetClusterSettingsResponse GetSettings(GetClusterSettingsRequest request) @@ -680,7 +680,7 @@ public virtual GetClusterSettingsResponse GetSettings(GetClusterSettingsRequest /// Returns cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetClusterSettingsRequest request, CancellationToken cancellationToken = default) { @@ -693,7 +693,7 @@ public virtual Task GetSettingsAsync(GetClusterSetti /// Returns cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetClusterSettingsResponse GetSettings(GetClusterSettingsRequestDescriptor descriptor) @@ -707,7 +707,7 @@ public virtual GetClusterSettingsResponse GetSettings(GetClusterSettingsRequestD /// Returns cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetClusterSettingsResponse GetSettings() @@ -722,7 +722,7 @@ public virtual GetClusterSettingsResponse GetSettings() /// Returns cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetClusterSettingsResponse GetSettings(Action configureRequest) @@ -738,7 +738,7 @@ public virtual GetClusterSettingsResponse GetSettings(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(GetClusterSettingsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -751,7 +751,7 @@ public virtual Task GetSettingsAsync(GetClusterSetti /// Returns cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(CancellationToken cancellationToken = default) { @@ -765,7 +765,7 @@ public virtual Task GetSettingsAsync(CancellationTok /// Returns cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetSettingsAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -780,7 +780,7 @@ public virtual Task GetSettingsAsync(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(HealthRequest request) @@ -794,7 +794,7 @@ public virtual HealthResponse Health(HealthRequest request) /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequest request, CancellationToken cancellationToken = default) { @@ -807,7 +807,7 @@ public virtual Task HealthAsync(HealthRequest request, Cancellat /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(HealthRequestDescriptor descriptor) @@ -821,7 +821,7 @@ public virtual HealthResponse Health(HealthRequestDescriptor - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.Indices? indices) @@ -836,7 +836,7 @@ public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.In /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest) @@ -852,7 +852,7 @@ public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.In /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health() @@ -867,7 +867,7 @@ public virtual HealthResponse Health() /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(Action> configureRequest) @@ -883,7 +883,7 @@ public virtual HealthResponse Health(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(HealthRequestDescriptor descriptor) @@ -897,7 +897,7 @@ public virtual HealthResponse Health(HealthRequestDescriptor descriptor) /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.Indices? indices) @@ -912,7 +912,7 @@ public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.Indices? indi /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest) @@ -928,7 +928,7 @@ public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.Indices? indi /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health() @@ -943,7 +943,7 @@ public virtual HealthResponse Health() /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(Action configureRequest) @@ -959,7 +959,7 @@ public virtual HealthResponse Health(Action configureRe /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -972,7 +972,7 @@ public virtual Task HealthAsync(HealthRequestDescript /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) { @@ -986,7 +986,7 @@ public virtual Task HealthAsync(Elastic.Clients.Elast /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1001,7 +1001,7 @@ public virtual Task HealthAsync(Elastic.Clients.Elast /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(CancellationToken cancellationToken = default) { @@ -1015,7 +1015,7 @@ public virtual Task HealthAsync(CancellationToken can /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1030,7 +1030,7 @@ public virtual Task HealthAsync(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1043,7 +1043,7 @@ public virtual Task HealthAsync(HealthRequestDescriptor descript /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) { @@ -1057,7 +1057,7 @@ public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.In /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1072,7 +1072,7 @@ public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.In /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(CancellationToken cancellationToken = default) { @@ -1086,7 +1086,7 @@ public virtual Task HealthAsync(CancellationToken cancellationTo /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -1101,7 +1101,7 @@ public virtual Task HealthAsync(Action /// Get cluster info. /// Returns basic information about the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClusterInfoResponse Info(ClusterInfoRequest request) @@ -1115,7 +1115,7 @@ public virtual ClusterInfoResponse Info(ClusterInfoRequest request) /// Get cluster info. /// Returns basic information about the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(ClusterInfoRequest request, CancellationToken cancellationToken = default) { @@ -1128,7 +1128,7 @@ public virtual Task InfoAsync(ClusterInfoRequest request, C /// Get cluster info. /// Returns basic information about the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClusterInfoResponse Info(ClusterInfoRequestDescriptor descriptor) @@ -1142,7 +1142,7 @@ public virtual ClusterInfoResponse Info(ClusterInfoRequestDescriptor descriptor) /// Get cluster info. /// Returns basic information about the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClusterInfoResponse Info(IReadOnlyCollection target) @@ -1157,7 +1157,7 @@ public virtual ClusterInfoResponse Info(IReadOnlyCollection - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClusterInfoResponse Info(IReadOnlyCollection target, Action configureRequest) @@ -1173,7 +1173,7 @@ public virtual ClusterInfoResponse Info(IReadOnlyCollection - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(ClusterInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1186,7 +1186,7 @@ public virtual Task InfoAsync(ClusterInfoRequestDescriptor /// Get cluster info. /// Returns basic information about the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(IReadOnlyCollection target, CancellationToken cancellationToken = default) { @@ -1200,7 +1200,7 @@ public virtual Task InfoAsync(IReadOnlyCollection - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(IReadOnlyCollection target, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1217,7 +1217,7 @@ public virtual Task InfoAsync(IReadOnlyCollection - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PendingTasksResponse PendingTasks(PendingTasksRequest request) @@ -1233,7 +1233,7 @@ public virtual PendingTasksResponse PendingTasks(PendingTasksRequest request) /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(PendingTasksRequest request, CancellationToken cancellationToken = default) { @@ -1248,7 +1248,7 @@ public virtual Task PendingTasksAsync(PendingTasksRequest /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PendingTasksResponse PendingTasks(PendingTasksRequestDescriptor descriptor) @@ -1264,7 +1264,7 @@ public virtual PendingTasksResponse PendingTasks(PendingTasksRequestDescriptor d /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PendingTasksResponse PendingTasks() @@ -1281,7 +1281,7 @@ public virtual PendingTasksResponse PendingTasks() /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PendingTasksResponse PendingTasks(Action configureRequest) @@ -1299,7 +1299,7 @@ public virtual PendingTasksResponse PendingTasks(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(PendingTasksRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1314,7 +1314,7 @@ public virtual Task PendingTasksAsync(PendingTasksRequestD /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(CancellationToken cancellationToken = default) { @@ -1330,7 +1330,7 @@ public virtual Task PendingTasksAsync(CancellationToken ca /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. /// However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PendingTasksAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -1344,7 +1344,7 @@ public virtual Task PendingTasksAsync(Action /// Updates the cluster voting config exclusions by node ids or node names. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions(PostVotingConfigExclusionsRequest request) @@ -1357,7 +1357,7 @@ public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions(Pos /// /// Updates the cluster voting config exclusions by node ids or node names. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostVotingConfigExclusionsAsync(PostVotingConfigExclusionsRequest request, CancellationToken cancellationToken = default) { @@ -1369,7 +1369,7 @@ public virtual Task PostVotingConfigExclusio /// /// Updates the cluster voting config exclusions by node ids or node names. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions(PostVotingConfigExclusionsRequestDescriptor descriptor) @@ -1382,7 +1382,7 @@ public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions(Pos /// /// Updates the cluster voting config exclusions by node ids or node names. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions() @@ -1396,7 +1396,7 @@ public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions() /// /// Updates the cluster voting config exclusions by node ids or node names. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions(Action configureRequest) @@ -1411,7 +1411,7 @@ public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions(Act /// /// Updates the cluster voting config exclusions by node ids or node names. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostVotingConfigExclusionsAsync(PostVotingConfigExclusionsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1423,7 +1423,7 @@ public virtual Task PostVotingConfigExclusio /// /// Updates the cluster voting config exclusions by node ids or node names. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostVotingConfigExclusionsAsync(CancellationToken cancellationToken = default) { @@ -1436,7 +1436,7 @@ public virtual Task PostVotingConfigExclusio /// /// Updates the cluster voting config exclusions by node ids or node names. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostVotingConfigExclusionsAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -1469,7 +1469,7 @@ public virtual Task PostVotingConfigExclusio /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutComponentTemplateResponse PutComponentTemplate(PutComponentTemplateRequest request) @@ -1501,7 +1501,7 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(PutComponentTem /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(PutComponentTemplateRequest request, CancellationToken cancellationToken = default) { @@ -1532,7 +1532,7 @@ public virtual Task PutComponentTemplateAsync(PutC /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutComponentTemplateResponse PutComponentTemplate(PutComponentTemplateRequestDescriptor descriptor) @@ -1564,7 +1564,7 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(PutC /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutComponentTemplateResponse PutComponentTemplate(Elastic.Clients.Elasticsearch.Name name) @@ -1597,7 +1597,7 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(Elas /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutComponentTemplateResponse PutComponentTemplate(Elastic.Clients.Elasticsearch.Name name, Action> configureRequest) @@ -1631,7 +1631,7 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(Elas /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutComponentTemplateResponse PutComponentTemplate(PutComponentTemplateRequestDescriptor descriptor) @@ -1663,7 +1663,7 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(PutComponentTem /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutComponentTemplateResponse PutComponentTemplate(Elastic.Clients.Elasticsearch.Name name) @@ -1696,7 +1696,7 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(Elastic.Clients /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutComponentTemplateResponse PutComponentTemplate(Elastic.Clients.Elasticsearch.Name name, Action configureRequest) @@ -1730,7 +1730,7 @@ public virtual PutComponentTemplateResponse PutComponentTemplate(Elastic.Clients /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(PutComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1761,7 +1761,7 @@ public virtual Task PutComponentTemplateAsync/* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) { @@ -1793,7 +1793,7 @@ public virtual Task PutComponentTemplateAsync/* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Name name, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1826,7 +1826,7 @@ public virtual Task PutComponentTemplateAsync/* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(PutComponentTemplateRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1857,7 +1857,7 @@ public virtual Task PutComponentTemplateAsync(PutC /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) { @@ -1889,7 +1889,7 @@ public virtual Task PutComponentTemplateAsync(Elas /// You can use C-style /* *\/ block comments in component templates. /// You can include comments anywhere in the request body except before the opening curly bracket. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutComponentTemplateAsync(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1904,7 +1904,7 @@ public virtual Task PutComponentTemplateAsync(Elas /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClusterStatsResponse Stats(ClusterStatsRequest request) @@ -1918,7 +1918,7 @@ public virtual ClusterStatsResponse Stats(ClusterStatsRequest request) /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(ClusterStatsRequest request, CancellationToken cancellationToken = default) { @@ -1931,7 +1931,7 @@ public virtual Task StatsAsync(ClusterStatsRequest request /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClusterStatsResponse Stats(ClusterStatsRequestDescriptor descriptor) @@ -1945,7 +1945,7 @@ public virtual ClusterStatsResponse Stats(ClusterStatsRequestDescriptor descript /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClusterStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? nodeId) @@ -1960,7 +1960,7 @@ public virtual ClusterStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClusterStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Action configureRequest) @@ -1976,7 +1976,7 @@ public virtual ClusterStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClusterStatsResponse Stats() @@ -1991,7 +1991,7 @@ public virtual ClusterStatsResponse Stats() /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClusterStatsResponse Stats(Action configureRequest) @@ -2007,7 +2007,7 @@ public virtual ClusterStatsResponse Stats(Action /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(ClusterStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -2020,7 +2020,7 @@ public virtual Task StatsAsync(ClusterStatsRequestDescript /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, CancellationToken cancellationToken = default) { @@ -2034,7 +2034,7 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -2049,7 +2049,7 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) { @@ -2063,7 +2063,7 @@ public virtual Task StatsAsync(CancellationToken cancellat /// Returns cluster statistics. /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.DanglingIndices.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.DanglingIndices.g.cs index f4bed19081..544af02adf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.DanglingIndices.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.DanglingIndices.g.cs @@ -41,7 +41,14 @@ internal DanglingIndicesNamespacedClient(ElasticsearchClient client) : base(clie /// /// - /// Returns all dangling indices. + /// Get the dangling indices. + /// + /// + /// If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + /// For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline. + /// + /// + /// Use this API to list dangling indices, which you can then import or delete. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +61,14 @@ public virtual ListDanglingIndicesResponse ListDanglingIndices(ListDanglingIndic /// /// - /// Returns all dangling indices. + /// Get the dangling indices. + /// + /// + /// If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + /// For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline. + /// + /// + /// Use this API to list dangling indices, which you can then import or delete. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +80,14 @@ public virtual Task ListDanglingIndicesAsync(ListDa /// /// - /// Returns all dangling indices. + /// Get the dangling indices. + /// + /// + /// If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + /// For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline. + /// + /// + /// Use this API to list dangling indices, which you can then import or delete. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +100,14 @@ public virtual ListDanglingIndicesResponse ListDanglingIndices(ListDanglingIndic /// /// - /// Returns all dangling indices. + /// Get the dangling indices. + /// + /// + /// If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + /// For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline. + /// + /// + /// Use this API to list dangling indices, which you can then import or delete. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +121,14 @@ public virtual ListDanglingIndicesResponse ListDanglingIndices() /// /// - /// Returns all dangling indices. + /// Get the dangling indices. + /// + /// + /// If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + /// For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline. + /// + /// + /// Use this API to list dangling indices, which you can then import or delete. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +143,14 @@ public virtual ListDanglingIndicesResponse ListDanglingIndices(Action /// - /// Returns all dangling indices. + /// Get the dangling indices. + /// + /// + /// If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + /// For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline. + /// + /// + /// Use this API to list dangling indices, which you can then import or delete. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -120,7 +162,14 @@ public virtual Task ListDanglingIndicesAsync(ListDa /// /// - /// Returns all dangling indices. + /// Get the dangling indices. + /// + /// + /// If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + /// For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline. + /// + /// + /// Use this API to list dangling indices, which you can then import or delete. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -133,7 +182,14 @@ public virtual Task ListDanglingIndicesAsync(Cancel /// /// - /// Returns all dangling indices. + /// Get the dangling indices. + /// + /// + /// If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + /// For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline. + /// + /// + /// Use this API to list dangling indices, which you can then import or delete. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 cbb8fa9e43..def12a2fed 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Enrich.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Enrich.g.cs @@ -157,7 +157,7 @@ public virtual Task DeletePolicyAsync(Elastic.Clients.Elas /// /// 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExecutePolicyResponse ExecutePolicy(ExecutePolicyRequest request) @@ -170,7 +170,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) { @@ -182,7 +182,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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExecutePolicyResponse ExecutePolicy(ExecutePolicyRequestDescriptor descriptor) @@ -195,7 +195,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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExecutePolicyResponse ExecutePolicy(Elastic.Clients.Elasticsearch.Name name) @@ -209,7 +209,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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExecutePolicyResponse ExecutePolicy(Elastic.Clients.Elasticsearch.Name name, Action configureRequest) @@ -224,7 +224,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(ExecutePolicyRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -236,7 +236,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, CancellationToken cancellationToken = default) { @@ -249,7 +249,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(Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) { @@ -438,7 +438,7 @@ public virtual Task GetPolicyAsync(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPolicyResponse PutPolicy(PutPolicyRequest request) @@ -452,7 +452,7 @@ public virtual PutPolicyResponse PutPolicy(PutPolicyRequest request) /// Create an enrich policy. /// Creates an 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) { @@ -465,7 +465,7 @@ public virtual Task PutPolicyAsync(PutPolicyRequest request, /// Create an enrich policy. /// Creates an enrich policy. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPolicyResponse PutPolicy(PutPolicyRequestDescriptor descriptor) @@ -479,7 +479,7 @@ public virtual PutPolicyResponse PutPolicy(PutPolicyRequestDescriptor /// Create an enrich policy. /// Creates an enrich policy. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsearch.Name name) @@ -494,7 +494,7 @@ public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsea /// Create an enrich policy. /// Creates an enrich policy. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsearch.Name name, Action> configureRequest) @@ -510,7 +510,7 @@ public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsea /// Create an enrich policy. /// Creates an enrich policy. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPolicyResponse PutPolicy(PutPolicyRequestDescriptor descriptor) @@ -524,7 +524,7 @@ public virtual PutPolicyResponse PutPolicy(PutPolicyRequestDescriptor descriptor /// Create an enrich policy. /// Creates an enrich policy. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsearch.Name name) @@ -539,7 +539,7 @@ public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsearch.Name na /// Create an enrich policy. /// Creates an enrich policy. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsearch.Name name, Action configureRequest) @@ -555,7 +555,7 @@ public virtual PutPolicyResponse PutPolicy(Elastic.Clients.Elasticsearch.Name na /// Create an enrich policy. /// Creates an 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) { @@ -568,7 +568,7 @@ public virtual Task PutPolicyAsync(PutPolicyReques /// Create an enrich policy. /// Creates an 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, CancellationToken cancellationToken = default) { @@ -582,7 +582,7 @@ public virtual Task PutPolicyAsync(Elastic.Clients /// Create an enrich policy. /// Creates an 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) { @@ -597,7 +597,7 @@ public virtual Task PutPolicyAsync(Elastic.Clients /// Create an enrich policy. /// Creates an 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) { @@ -610,7 +610,7 @@ public virtual Task PutPolicyAsync(PutPolicyRequestDescriptor /// Create an enrich policy. /// Creates an 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, CancellationToken cancellationToken = default) { @@ -624,7 +624,7 @@ public virtual Task PutPolicyAsync(Elastic.Clients.Elasticsea /// Create an enrich policy. /// Creates an 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 288fe04ee8..2867e62ebd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Eql.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Eql.g.cs @@ -244,7 +244,7 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch /// /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual EqlGetResponse Get(EqlGetRequest request) @@ -257,7 +257,7 @@ public virtual EqlGetResponse Get(EqlGetRequest request) /// /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(EqlGetRequest request, CancellationToken cancellationToken = default) { @@ -269,7 +269,7 @@ public virtual Task> GetAsync(EqlGetRequest reque /// /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual EqlGetResponse Get(EqlGetRequestDescriptor descriptor) @@ -282,7 +282,7 @@ public virtual EqlGetResponse Get(EqlGetRequestDescriptor /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual EqlGetResponse Get(Elastic.Clients.Elasticsearch.Id id) @@ -296,7 +296,7 @@ public virtual EqlGetResponse Get(Elastic.Clients.Elasticsearch. /// /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual EqlGetResponse Get(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest) @@ -311,7 +311,7 @@ public virtual EqlGetResponse Get(Elastic.Clients.Elasticsearch. /// /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// - /// 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) { @@ -323,7 +323,7 @@ public virtual Task> GetAsync(EqlGetRequestDescri /// /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task> GetAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -336,7 +336,7 @@ public virtual Task> GetAsync(Elastic.Clients.Ela /// /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. /// - /// 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) { @@ -350,7 +350,7 @@ public virtual Task> GetAsync(Elastic.Clients.Ela /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequest request) @@ -363,7 +363,7 @@ public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequest request) /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequest request, CancellationToken cancellationToken = default) { @@ -375,7 +375,7 @@ public virtual Task GetStatusAsync(GetEqlStatusRequest req /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequestDescriptor descriptor) @@ -388,7 +388,7 @@ public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequestDesc /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id id) @@ -402,7 +402,7 @@ public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elastic /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest) @@ -417,7 +417,7 @@ public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elastic /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequestDescriptor descriptor) @@ -430,7 +430,7 @@ public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequestDescriptor desc /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id id) @@ -444,7 +444,7 @@ public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id i /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id id, Action configureRequest) @@ -459,7 +459,7 @@ public virtual GetEqlStatusResponse GetStatus(Elastic.Clients.Elasticsearch.Id i /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// 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) { @@ -471,7 +471,7 @@ public virtual Task GetStatusAsync(GetEqlStatus /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -484,7 +484,7 @@ public virtual Task GetStatusAsync(Elastic.Clie /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -498,7 +498,7 @@ public virtual Task GetStatusAsync(Elastic.Clie /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(GetEqlStatusRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -510,7 +510,7 @@ public virtual Task GetStatusAsync(GetEqlStatusRequestDesc /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetStatusAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -523,7 +523,7 @@ public virtual Task GetStatusAsync(Elastic.Clients.Elastic /// /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. /// - /// 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.Esql.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Esql.g.cs index c095736279..731a3cdae0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Esql.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Esql.g.cs @@ -43,7 +43,7 @@ internal EsqlNamespacedClient(ElasticsearchClient client) : base(client) /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual EsqlQueryResponse Query(EsqlQueryRequest request) @@ -56,7 +56,7 @@ public virtual EsqlQueryResponse Query(EsqlQueryRequest request) /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(EsqlQueryRequest request, CancellationToken cancellationToken = default) { @@ -68,7 +68,7 @@ public virtual Task QueryAsync(EsqlQueryRequest request, Canc /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual EsqlQueryResponse Query(EsqlQueryRequestDescriptor descriptor) @@ -81,7 +81,7 @@ public virtual EsqlQueryResponse Query(EsqlQueryRequestDescriptor /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual EsqlQueryResponse Query() @@ -95,7 +95,7 @@ public virtual EsqlQueryResponse Query() /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual EsqlQueryResponse Query(Action> configureRequest) @@ -110,7 +110,7 @@ public virtual EsqlQueryResponse Query(Action /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual EsqlQueryResponse Query(EsqlQueryRequestDescriptor descriptor) @@ -123,7 +123,7 @@ public virtual EsqlQueryResponse Query(EsqlQueryRequestDescriptor descriptor) /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual EsqlQueryResponse Query() @@ -137,7 +137,7 @@ public virtual EsqlQueryResponse Query() /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual EsqlQueryResponse Query(Action configureRequest) @@ -152,7 +152,7 @@ public virtual EsqlQueryResponse Query(Action config /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(EsqlQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -164,7 +164,7 @@ public virtual Task QueryAsync(EsqlQueryRequestDes /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(CancellationToken cancellationToken = default) { @@ -177,7 +177,7 @@ public virtual Task QueryAsync(CancellationToken c /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -191,7 +191,7 @@ public virtual Task QueryAsync(Action /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(EsqlQueryRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -203,7 +203,7 @@ public virtual Task QueryAsync(EsqlQueryRequestDescriptor des /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(CancellationToken cancellationToken = default) { @@ -216,7 +216,7 @@ public virtual Task QueryAsync(CancellationToken cancellation /// /// Executes an ES|QL request /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task QueryAsync(Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs index 81edb557a3..1dd9a1e7d6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs @@ -43,7 +43,7 @@ internal GraphNamespacedClient(ElasticsearchClient client) : base(client) /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExploreResponse Explore(ExploreRequest request) @@ -56,7 +56,7 @@ public virtual ExploreResponse Explore(ExploreRequest request) /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequest request, CancellationToken cancellationToken = default) { @@ -68,7 +68,7 @@ public virtual Task ExploreAsync(ExploreRequest request, Cancel /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExploreResponse Explore(ExploreRequestDescriptor descriptor) @@ -81,7 +81,7 @@ public virtual ExploreResponse Explore(ExploreRequestDescriptor /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices indices) @@ -95,7 +95,7 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch. /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest) @@ -110,7 +110,7 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch. /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExploreResponse Explore() @@ -124,7 +124,7 @@ public virtual ExploreResponse Explore() /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExploreResponse Explore(Action> configureRequest) @@ -139,7 +139,7 @@ public virtual ExploreResponse Explore(Action /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExploreResponse Explore(ExploreRequestDescriptor descriptor) @@ -152,7 +152,7 @@ public virtual ExploreResponse Explore(ExploreRequestDescriptor descriptor) /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices indices) @@ -166,7 +166,7 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices ind /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest) @@ -181,7 +181,7 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch.Indices ind /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// 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) { @@ -193,7 +193,7 @@ public virtual Task ExploreAsync(ExploreRequestDescr /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -206,7 +206,7 @@ public virtual Task ExploreAsync(Elastic.Clients.Ela /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -220,7 +220,7 @@ public virtual Task ExploreAsync(Elastic.Clients.Ela /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(CancellationToken cancellationToken = default) { @@ -233,7 +233,7 @@ public virtual Task ExploreAsync(CancellationToken c /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -247,7 +247,7 @@ public virtual Task ExploreAsync(Action /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(ExploreRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -259,7 +259,7 @@ public virtual Task ExploreAsync(ExploreRequestDescriptor descr /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -272,7 +272,7 @@ public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch. /// /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// 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 db556857dd..51145ed44b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Indices.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Indices.g.cs @@ -41,9 +41,10 @@ internal IndicesNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AnalyzeIndexResponse Analyze(AnalyzeIndexRequest request) @@ -54,9 +55,10 @@ public virtual AnalyzeIndexResponse Analyze(AnalyzeIndexRequest request) /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(AnalyzeIndexRequest request, CancellationToken cancellationToken = default) { @@ -66,9 +68,10 @@ public virtual Task AnalyzeAsync(AnalyzeIndexRequest reque /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AnalyzeIndexResponse Analyze(AnalyzeIndexRequestDescriptor descriptor) @@ -79,9 +82,10 @@ public virtual AnalyzeIndexResponse Analyze(AnalyzeIndexRequestDescri /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AnalyzeIndexResponse Analyze(Elastic.Clients.Elasticsearch.IndexName? index) @@ -93,9 +97,10 @@ public virtual AnalyzeIndexResponse Analyze(Elastic.Clients.Elasticse /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AnalyzeIndexResponse Analyze(Elastic.Clients.Elasticsearch.IndexName? index, Action> configureRequest) @@ -108,9 +113,10 @@ public virtual AnalyzeIndexResponse Analyze(Elastic.Clients.Elasticse /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AnalyzeIndexResponse Analyze() @@ -122,9 +128,10 @@ public virtual AnalyzeIndexResponse Analyze() /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AnalyzeIndexResponse Analyze(Action> configureRequest) @@ -137,9 +144,10 @@ public virtual AnalyzeIndexResponse Analyze(Action /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AnalyzeIndexResponse Analyze(AnalyzeIndexRequestDescriptor descriptor) @@ -150,9 +158,10 @@ public virtual AnalyzeIndexResponse Analyze(AnalyzeIndexRequestDescriptor descri /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AnalyzeIndexResponse Analyze(Elastic.Clients.Elasticsearch.IndexName? index) @@ -164,9 +173,10 @@ public virtual AnalyzeIndexResponse Analyze(Elastic.Clients.Elasticsearch.IndexN /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AnalyzeIndexResponse Analyze(Elastic.Clients.Elasticsearch.IndexName? index, Action configureRequest) @@ -179,9 +189,10 @@ public virtual AnalyzeIndexResponse Analyze(Elastic.Clients.Elasticsearch.IndexN /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AnalyzeIndexResponse Analyze() @@ -193,9 +204,10 @@ public virtual AnalyzeIndexResponse Analyze() /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual AnalyzeIndexResponse Analyze(Action configureRequest) @@ -208,9 +220,10 @@ public virtual AnalyzeIndexResponse Analyze(Action /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(AnalyzeIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -220,9 +233,10 @@ public virtual Task AnalyzeAsync(AnalyzeIndexRe /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.IndexName? index, CancellationToken cancellationToken = default) { @@ -233,9 +247,10 @@ public virtual Task AnalyzeAsync(Elastic.Client /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.IndexName? index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -247,9 +262,10 @@ public virtual Task AnalyzeAsync(Elastic.Client /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(CancellationToken cancellationToken = default) { @@ -260,9 +276,10 @@ public virtual Task AnalyzeAsync(CancellationTo /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -274,9 +291,10 @@ public virtual Task AnalyzeAsync(Action /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(AnalyzeIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -286,9 +304,10 @@ public virtual Task AnalyzeAsync(AnalyzeIndexRequestDescri /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.IndexName? index, CancellationToken cancellationToken = default) { @@ -299,9 +318,10 @@ public virtual Task AnalyzeAsync(Elastic.Clients.Elasticse /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Elastic.Clients.Elasticsearch.IndexName? index, Action configureRequest, CancellationToken cancellationToken = default) { @@ -313,9 +333,10 @@ public virtual Task AnalyzeAsync(Elastic.Clients.Elasticse /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(CancellationToken cancellationToken = default) { @@ -326,9 +347,10 @@ public virtual Task AnalyzeAsync(CancellationToken cancell /// /// - /// Performs analysis on a text string and returns the resulting tokens. + /// Get tokens from text analysis. + /// The analyze API performs analysis on a text string and returns the resulting tokens. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task AnalyzeAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -906,7 +928,7 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsearch /// /// Closes an index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseIndexResponse Close(CloseIndexRequest request) @@ -919,7 +941,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) { @@ -931,7 +953,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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseIndexResponse Close(CloseIndexRequestDescriptor descriptor) @@ -944,7 +966,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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices indices) @@ -958,7 +980,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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest) @@ -973,7 +995,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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseIndexResponse Close() @@ -987,7 +1009,7 @@ public virtual CloseIndexResponse Close() /// /// Closes an index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseIndexResponse Close(Action> configureRequest) @@ -1002,7 +1024,7 @@ public virtual CloseIndexResponse Close(Action /// Closes an index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseIndexResponse Close(CloseIndexRequestDescriptor descriptor) @@ -1015,7 +1037,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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices indices) @@ -1029,7 +1051,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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest) @@ -1044,7 +1066,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 Task CloseAsync(CloseIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1056,7 +1078,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, CancellationToken cancellationToken = default) { @@ -1069,7 +1091,7 @@ public virtual Task CloseAsync(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 Task CloseAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1083,7 +1105,7 @@ public virtual Task CloseAsync(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 Task CloseAsync(CancellationToken cancellationToken = default) { @@ -1096,7 +1118,7 @@ public virtual Task CloseAsync(CancellationToken /// /// 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(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1110,7 +1132,7 @@ public virtual Task CloseAsync(Action /// 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) { @@ -1122,7 +1144,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, CancellationToken cancellationToken = default) { @@ -1135,7 +1157,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(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1150,7 +1172,7 @@ public virtual Task CloseAsync(Elastic.Clients.Elasticsearch /// Create an index. /// Creates a new index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CreateIndexResponse Create(CreateIndexRequest request) @@ -1164,7 +1186,7 @@ public virtual CreateIndexResponse Create(CreateIndexRequest request) /// Create an index. /// Creates a new index. /// - /// 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) { @@ -1177,7 +1199,7 @@ public virtual Task CreateAsync(CreateIndexRequest request, /// Create an index. /// Creates a new index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CreateIndexResponse Create(CreateIndexRequestDescriptor descriptor) @@ -1191,7 +1213,7 @@ public virtual CreateIndexResponse Create(CreateIndexRequestDescripto /// Create an index. /// Creates a new index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexName index) @@ -1206,7 +1228,7 @@ public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsear /// Create an index. /// Creates a new index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest) @@ -1222,7 +1244,7 @@ public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsear /// Create an index. /// Creates a new index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CreateIndexResponse Create() @@ -1237,7 +1259,7 @@ public virtual CreateIndexResponse Create() /// Create an index. /// Creates a new index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CreateIndexResponse Create(Action> configureRequest) @@ -1253,7 +1275,7 @@ public virtual CreateIndexResponse Create(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CreateIndexResponse Create(CreateIndexRequestDescriptor descriptor) @@ -1267,7 +1289,7 @@ public virtual CreateIndexResponse Create(CreateIndexRequestDescriptor descripto /// Create an index. /// Creates a new index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexName index) @@ -1282,7 +1304,7 @@ public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexNam /// Create an index. /// Creates a new index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest) @@ -1298,7 +1320,7 @@ public virtual CreateIndexResponse Create(Elastic.Clients.Elasticsearch.IndexNam /// Create an index. /// Creates a new index. /// - /// 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) { @@ -1311,7 +1333,7 @@ public virtual Task CreateAsync(CreateIndexReque /// Create an index. /// Creates a new index. /// - /// 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) { @@ -1325,7 +1347,7 @@ public virtual Task CreateAsync(Elastic.Clients. /// Create an index. /// Creates a new index. /// - /// 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) { @@ -1340,7 +1362,7 @@ public virtual Task CreateAsync(Elastic.Clients. /// Create an index. /// Creates a new index. /// - /// 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) { @@ -1354,7 +1376,7 @@ public virtual Task CreateAsync(CancellationToke /// Create an index. /// Creates a new index. /// - /// 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) { @@ -1369,7 +1391,7 @@ public virtual Task CreateAsync(Action - /// 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) { @@ -1382,7 +1404,7 @@ public virtual Task CreateAsync(CreateIndexRequestDescripto /// Create an index. /// Creates a new index. /// - /// 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) { @@ -1396,7 +1418,7 @@ public virtual Task CreateAsync(Elastic.Clients.Elasticsear /// Create an index. /// Creates a new index. /// - /// 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) { @@ -2692,7 +2714,7 @@ public virtual Task DeleteTemplateAsync(Elastic.Clients. /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DiskUsageResponse DiskUsage(DiskUsageRequest request) @@ -2705,7 +2727,7 @@ public virtual DiskUsageResponse DiskUsage(DiskUsageRequest request) /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(DiskUsageRequest request, CancellationToken cancellationToken = default) { @@ -2717,7 +2739,7 @@ public virtual Task DiskUsageAsync(DiskUsageRequest request, /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DiskUsageResponse DiskUsage(DiskUsageRequestDescriptor descriptor) @@ -2730,7 +2752,7 @@ public virtual DiskUsageResponse DiskUsage(DiskUsageRequestDescriptor /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices indices) @@ -2744,7 +2766,7 @@ public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsea /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest) @@ -2759,7 +2781,7 @@ public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsea /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DiskUsageResponse DiskUsage() @@ -2773,7 +2795,7 @@ public virtual DiskUsageResponse DiskUsage() /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DiskUsageResponse DiskUsage(Action> configureRequest) @@ -2788,7 +2810,7 @@ public virtual DiskUsageResponse DiskUsage(Action /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DiskUsageResponse DiskUsage(DiskUsageRequestDescriptor descriptor) @@ -2801,7 +2823,7 @@ public virtual DiskUsageResponse DiskUsage(DiskUsageRequestDescriptor descriptor /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices indices) @@ -2815,7 +2837,7 @@ public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest) @@ -2830,7 +2852,7 @@ public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(DiskUsageRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -2842,7 +2864,7 @@ public virtual Task DiskUsageAsync(DiskUsageReques /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -2855,7 +2877,7 @@ public virtual Task DiskUsageAsync(Elastic.Clients /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -2869,7 +2891,7 @@ public virtual Task DiskUsageAsync(Elastic.Clients /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(CancellationToken cancellationToken = default) { @@ -2882,7 +2904,7 @@ public virtual Task DiskUsageAsync(CancellationTok /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -2896,7 +2918,7 @@ public virtual Task DiskUsageAsync(Action /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(DiskUsageRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -2908,7 +2930,7 @@ public virtual Task DiskUsageAsync(DiskUsageRequestDescriptor /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -2921,7 +2943,7 @@ public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsea /// /// Analyzes the disk usage of each field of an index or data stream. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -2935,7 +2957,7 @@ public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsea /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DownsampleResponse Downsample(DownsampleRequest request) @@ -2948,7 +2970,7 @@ public virtual DownsampleResponse Downsample(DownsampleRequest request) /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(DownsampleRequest request, CancellationToken cancellationToken = default) { @@ -2960,7 +2982,7 @@ public virtual Task DownsampleAsync(DownsampleRequest reques /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DownsampleResponse Downsample(DownsampleRequestDescriptor descriptor) @@ -2973,7 +2995,7 @@ public virtual DownsampleResponse Downsample(DownsampleRequestDescrip /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DownsampleResponse Downsample(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName targetIndex) @@ -2987,7 +3009,7 @@ public virtual DownsampleResponse Downsample(Elastic.Clients.Elastics /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DownsampleResponse Downsample(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName targetIndex, Action> configureRequest) @@ -3002,7 +3024,7 @@ public virtual DownsampleResponse Downsample(Elastic.Clients.Elastics /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DownsampleResponse Downsample(DownsampleRequestDescriptor descriptor) @@ -3015,7 +3037,7 @@ public virtual DownsampleResponse Downsample(DownsampleRequestDescriptor descrip /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DownsampleResponse Downsample(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName targetIndex) @@ -3029,7 +3051,7 @@ public virtual DownsampleResponse Downsample(Elastic.Clients.Elasticsearch.Index /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DownsampleResponse Downsample(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName targetIndex, Action configureRequest) @@ -3044,7 +3066,7 @@ public virtual DownsampleResponse Downsample(Elastic.Clients.Elasticsearch.Index /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(DownsampleRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -3056,7 +3078,7 @@ public virtual Task DownsampleAsync(DownsampleReq /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName targetIndex, CancellationToken cancellationToken = default) { @@ -3069,7 +3091,7 @@ public virtual Task DownsampleAsync(Elastic.Clien /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName targetIndex, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -3083,7 +3105,7 @@ public virtual Task DownsampleAsync(Elastic.Clien /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(DownsampleRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -3095,7 +3117,7 @@ public virtual Task DownsampleAsync(DownsampleRequestDescrip /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName targetIndex, CancellationToken cancellationToken = default) { @@ -3108,7 +3130,7 @@ public virtual Task DownsampleAsync(Elastic.Clients.Elastics /// /// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(Elastic.Clients.Elasticsearch.IndexManagement.DownsampleConfig config, Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName targetIndex, Action configureRequest, CancellationToken cancellationToken = default) { @@ -4428,7 +4450,7 @@ public virtual Task FieldUsageStatsAsync(Elastic.Client /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FlushResponse Flush(FlushRequest request) @@ -4441,7 +4463,7 @@ public virtual FlushResponse Flush(FlushRequest request) /// /// Flushes one or more data streams or 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) { @@ -4453,7 +4475,7 @@ public virtual Task FlushAsync(FlushRequest request, Cancellation /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FlushResponse Flush(FlushRequestDescriptor descriptor) @@ -4466,7 +4488,7 @@ public virtual FlushResponse Flush(FlushRequestDescriptor /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indices? indices) @@ -4480,7 +4502,7 @@ public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indi /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest) @@ -4495,7 +4517,7 @@ public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indi /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FlushResponse Flush() @@ -4509,7 +4531,7 @@ public virtual FlushResponse Flush() /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FlushResponse Flush(Action> configureRequest) @@ -4524,7 +4546,7 @@ public virtual FlushResponse Flush(Action /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FlushResponse Flush(FlushRequestDescriptor descriptor) @@ -4537,7 +4559,7 @@ public virtual FlushResponse Flush(FlushRequestDescriptor descriptor) /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indices? indices) @@ -4551,7 +4573,7 @@ public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indices? indice /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest) @@ -4566,7 +4588,7 @@ public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indices? indice /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FlushResponse Flush() @@ -4580,7 +4602,7 @@ public virtual FlushResponse Flush() /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual FlushResponse Flush(Action configureRequest) @@ -4595,7 +4617,7 @@ public virtual FlushResponse Flush(Action configureReque /// /// Flushes one or more data streams or 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) { @@ -4607,7 +4629,7 @@ public virtual Task FlushAsync(FlushRequestDescriptor< /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) { @@ -4620,7 +4642,7 @@ public virtual Task FlushAsync(Elastic.Clients.Elastic /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -4634,7 +4656,7 @@ public virtual Task FlushAsync(Elastic.Clients.Elastic /// /// Flushes one or more data streams or 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) { @@ -4647,7 +4669,7 @@ public virtual Task FlushAsync(CancellationToken cance /// /// Flushes one or more data streams or 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) { @@ -4661,7 +4683,7 @@ public virtual Task FlushAsync(Action /// Flushes one or more data streams or 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) { @@ -4673,7 +4695,7 @@ public virtual Task FlushAsync(FlushRequestDescriptor descriptor, /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) { @@ -4686,7 +4708,7 @@ public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indi /// /// Flushes one or more data streams or indices. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -4700,7 +4722,7 @@ public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indi /// /// Flushes one or more data streams or 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) { @@ -4713,7 +4735,7 @@ public virtual Task FlushAsync(CancellationToken cancellationToke /// /// Flushes one or more data streams or 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) { @@ -8264,9 +8286,9 @@ public virtual PutDataLifecycleResponse PutDataLifecycle(PutDataLifecycleRequest /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] - public virtual PutDataLifecycleResponse PutDataLifecycle(Elastic.Clients.Elasticsearch.DataStreamNames name) + public virtual PutDataLifecycleResponse PutDataLifecycle(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle lifecycle, Elastic.Clients.Elasticsearch.DataStreamNames name) { - var descriptor = new PutDataLifecycleRequestDescriptor(name); + var descriptor = new PutDataLifecycleRequestDescriptor(lifecycle, name); descriptor.BeforeRequest(); return DoRequest(descriptor); } @@ -8279,9 +8301,9 @@ public virtual PutDataLifecycleResponse PutDataLifecycle(Elastic.Clients.Elastic /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] - public virtual PutDataLifecycleResponse PutDataLifecycle(Elastic.Clients.Elasticsearch.DataStreamNames name, Action configureRequest) + public virtual PutDataLifecycleResponse PutDataLifecycle(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle lifecycle, Elastic.Clients.Elasticsearch.DataStreamNames name, Action configureRequest) { - var descriptor = new PutDataLifecycleRequestDescriptor(name); + var descriptor = new PutDataLifecycleRequestDescriptor(lifecycle, name); configureRequest?.Invoke(descriptor); descriptor.BeforeRequest(); return DoRequest(descriptor); @@ -8307,9 +8329,9 @@ public virtual Task PutDataLifecycleAsync(PutDataLifec /// /// Learn more about this API in the Elasticsearch documentation. /// - public virtual Task PutDataLifecycleAsync(Elastic.Clients.Elasticsearch.DataStreamNames name, CancellationToken cancellationToken = default) + public virtual Task PutDataLifecycleAsync(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle lifecycle, Elastic.Clients.Elasticsearch.DataStreamNames name, CancellationToken cancellationToken = default) { - var descriptor = new PutDataLifecycleRequestDescriptor(name); + var descriptor = new PutDataLifecycleRequestDescriptor(lifecycle, name); descriptor.BeforeRequest(); return DoRequestAsync(descriptor, cancellationToken); } @@ -8321,9 +8343,9 @@ public virtual Task PutDataLifecycleAsync(Elastic.Clie /// /// Learn more about this API in the Elasticsearch documentation. /// - public virtual Task PutDataLifecycleAsync(Elastic.Clients.Elasticsearch.DataStreamNames name, Action configureRequest, CancellationToken cancellationToken = default) + public virtual Task PutDataLifecycleAsync(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle lifecycle, Elastic.Clients.Elasticsearch.DataStreamNames name, Action configureRequest, CancellationToken cancellationToken = default) { - var descriptor = new PutDataLifecycleRequestDescriptor(name); + var descriptor = new PutDataLifecycleRequestDescriptor(lifecycle, name); configureRequest?.Invoke(descriptor); descriptor.BeforeRequest(); return DoRequestAsync(descriptor, cancellationToken); @@ -10519,7 +10541,7 @@ public virtual Task ResolveIndexAsync(Elastic.Clients.Elas /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual RolloverResponse Rollover(RolloverRequest request) @@ -10533,7 +10555,7 @@ public virtual RolloverResponse Rollover(RolloverRequest request) /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequest request, CancellationToken cancellationToken = default) { @@ -10546,7 +10568,7 @@ public virtual Task RolloverAsync(RolloverRequest request, Can /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual RolloverResponse Rollover(RolloverRequestDescriptor descriptor) @@ -10560,7 +10582,7 @@ public virtual RolloverResponse Rollover(RolloverRequestDescriptor - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.Clients.Elasticsearch.IndexName? newIndex) @@ -10575,7 +10597,7 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearc /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.Clients.Elasticsearch.IndexName? newIndex, Action> configureRequest) @@ -10591,7 +10613,7 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearc /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlias alias) @@ -10606,7 +10628,7 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearc /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlias alias, Action> configureRequest) @@ -10622,7 +10644,7 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearc /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual RolloverResponse Rollover(RolloverRequestDescriptor descriptor) @@ -10636,7 +10658,7 @@ public virtual RolloverResponse Rollover(RolloverRequestDescriptor descriptor) /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.Clients.Elasticsearch.IndexName? newIndex) @@ -10651,7 +10673,7 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlia /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.Clients.Elasticsearch.IndexName? newIndex, Action configureRequest) @@ -10667,7 +10689,7 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlia /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlias alias) @@ -10682,7 +10704,7 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlia /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlias alias, Action configureRequest) @@ -10698,7 +10720,7 @@ public virtual RolloverResponse Rollover(Elastic.Clients.Elasticsearch.IndexAlia /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// 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) { @@ -10711,7 +10733,7 @@ public virtual Task RolloverAsync(RolloverRequestDe /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.Clients.Elasticsearch.IndexName? newIndex, CancellationToken cancellationToken = default) { @@ -10725,7 +10747,7 @@ public virtual Task RolloverAsync(Elastic.Clients.E /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.Clients.Elasticsearch.IndexName? newIndex, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -10740,7 +10762,7 @@ public virtual Task RolloverAsync(Elastic.Clients.E /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, CancellationToken cancellationToken = default) { @@ -10754,7 +10776,7 @@ public virtual Task RolloverAsync(Elastic.Clients.E /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -10769,7 +10791,7 @@ public virtual Task RolloverAsync(Elastic.Clients.E /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(RolloverRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -10782,7 +10804,7 @@ public virtual Task RolloverAsync(RolloverRequestDescriptor de /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.Clients.Elasticsearch.IndexName? newIndex, CancellationToken cancellationToken = default) { @@ -10796,7 +10818,7 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Elastic.Clients.Elasticsearch.IndexName? newIndex, Action configureRequest, CancellationToken cancellationToken = default) { @@ -10811,7 +10833,7 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, CancellationToken cancellationToken = default) { @@ -10825,7 +10847,7 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc /// Roll over to a new index. /// Creates a new index for a data stream or index alias. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task RolloverAsync(Elastic.Clients.Elasticsearch.IndexAlias alias, Action configureRequest, CancellationToken cancellationToken = default) { @@ -11481,7 +11503,7 @@ public virtual Task ShardStoresAsync(Action /// Shrinks 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequest request) @@ -11494,7 +11516,7 @@ public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequest request) /// /// Shrinks 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) { @@ -11506,7 +11528,7 @@ public virtual Task ShrinkAsync(ShrinkIndexRequest request, /// /// Shrinks 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequestDescriptor descriptor) @@ -11519,7 +11541,7 @@ public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequestDescripto /// /// Shrinks 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target) @@ -11533,7 +11555,7 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsear /// /// Shrinks 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action> configureRequest) @@ -11548,7 +11570,7 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsear /// /// Shrinks 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequestDescriptor descriptor) @@ -11561,7 +11583,7 @@ public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequestDescriptor descripto /// /// Shrinks 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target) @@ -11575,7 +11597,7 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexNam /// /// Shrinks 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action configureRequest) @@ -11590,7 +11612,7 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexNam /// /// Shrinks 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) { @@ -11602,7 +11624,7 @@ public virtual Task ShrinkAsync(ShrinkIndexReque /// /// Shrinks 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) { @@ -11615,7 +11637,7 @@ public virtual Task ShrinkAsync(Elastic.Clients. /// /// Shrinks 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) { @@ -11629,7 +11651,7 @@ public virtual Task ShrinkAsync(Elastic.Clients. /// /// Shrinks 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) { @@ -11641,7 +11663,7 @@ public virtual Task ShrinkAsync(ShrinkIndexRequestDescripto /// /// Shrinks 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) { @@ -11654,7 +11676,7 @@ public virtual Task ShrinkAsync(Elastic.Clients.Elasticsear /// /// Shrinks 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) { @@ -12103,7 +12125,7 @@ public virtual Task SimulateTemplateAsync(Action /// Splits 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SplitIndexResponse Split(SplitIndexRequest request) @@ -12116,7 +12138,7 @@ public virtual SplitIndexResponse Split(SplitIndexRequest request) /// /// Splits 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) { @@ -12128,7 +12150,7 @@ public virtual Task SplitAsync(SplitIndexRequest request, Ca /// /// Splits 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SplitIndexResponse Split(SplitIndexRequestDescriptor descriptor) @@ -12141,7 +12163,7 @@ public virtual SplitIndexResponse Split(SplitIndexRequestDescriptor /// Splits 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target) @@ -12155,7 +12177,7 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch /// /// Splits 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action> configureRequest) @@ -12170,7 +12192,7 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch /// /// Splits 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SplitIndexResponse Split(SplitIndexRequestDescriptor descriptor) @@ -12183,7 +12205,7 @@ public virtual SplitIndexResponse Split(SplitIndexRequestDescriptor descriptor) /// /// Splits 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target) @@ -12197,7 +12219,7 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName /// /// Splits 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. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.IndexName target, Action configureRequest) @@ -12212,7 +12234,7 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName /// /// Splits 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) { @@ -12224,7 +12246,7 @@ public virtual Task SplitAsync(SplitIndexRequestD /// /// Splits 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) { @@ -12237,7 +12259,7 @@ public virtual Task SplitAsync(Elastic.Clients.El /// /// Splits 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) { @@ -12251,7 +12273,7 @@ public virtual Task SplitAsync(Elastic.Clients.El /// /// Splits 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) { @@ -12263,7 +12285,7 @@ public virtual Task SplitAsync(SplitIndexRequestDescriptor d /// /// Splits 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) { @@ -12276,7 +12298,7 @@ public virtual Task SplitAsync(Elastic.Clients.Elasticsearch /// /// Splits 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 c9102687c7..3780833c65 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ingest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ingest.g.cs @@ -417,7 +417,7 @@ public virtual Task DeletePipelineAsync(Elastic.Clients. /// /// Gets download statistics for GeoIP2 databases used with the geoip processor. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GeoIpStatsResponse GeoIpStats(GeoIpStatsRequest request) @@ -430,7 +430,7 @@ public virtual GeoIpStatsResponse GeoIpStats(GeoIpStatsRequest request) /// /// Gets download statistics for GeoIP2 databases used with the geoip processor. /// - /// 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) { @@ -442,7 +442,7 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequest reques /// /// Gets download statistics for GeoIP2 databases used with the geoip processor. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GeoIpStatsResponse GeoIpStats(GeoIpStatsRequestDescriptor descriptor) @@ -455,7 +455,7 @@ public virtual GeoIpStatsResponse GeoIpStats(GeoIpStatsRequestDescriptor descrip /// /// Gets download statistics for GeoIP2 databases used with the geoip processor. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GeoIpStatsResponse GeoIpStats() @@ -469,7 +469,7 @@ public virtual GeoIpStatsResponse GeoIpStats() /// /// Gets download statistics for GeoIP2 databases used with the geoip processor. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GeoIpStatsResponse GeoIpStats(Action configureRequest) @@ -484,7 +484,7 @@ public virtual GeoIpStatsResponse GeoIpStats(Action /// /// Gets download statistics for GeoIP2 databases used with the geoip processor. /// - /// 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) { @@ -496,7 +496,7 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequestDescrip /// /// Gets download statistics for GeoIP2 databases used with the geoip processor. /// - /// 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) { @@ -509,7 +509,7 @@ public virtual Task GeoIpStatsAsync(CancellationToken cancel /// /// Gets download statistics for GeoIP2 databases used with the geoip processor. /// - /// 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) { @@ -1145,7 +1145,7 @@ public virtual Task GetPipelineAsync(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ProcessorGrokResponse ProcessorGrok(ProcessorGrokRequest request) @@ -1160,7 +1160,7 @@ public virtual ProcessorGrokResponse ProcessorGrok(ProcessorGrokRequest request) /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(ProcessorGrokRequest request, CancellationToken cancellationToken = default) { @@ -1174,7 +1174,7 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ProcessorGrokResponse ProcessorGrok(ProcessorGrokRequestDescriptor descriptor) @@ -1189,7 +1189,7 @@ public virtual ProcessorGrokResponse ProcessorGrok(ProcessorGrokRequestDescripto /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ProcessorGrokResponse ProcessorGrok() @@ -1205,7 +1205,7 @@ public virtual ProcessorGrokResponse ProcessorGrok() /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ProcessorGrokResponse ProcessorGrok(Action configureRequest) @@ -1222,7 +1222,7 @@ public virtual ProcessorGrokResponse ProcessorGrok(Action - /// 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) { @@ -1236,7 +1236,7 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(CancellationToken cancellationToken = default) { @@ -1251,7 +1251,7 @@ public virtual Task ProcessorGrokAsync(CancellationToken /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. /// A grok pattern is like a regular expression that supports aliased expressions that can be reused. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ProcessorGrokAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -1453,7 +1453,7 @@ public virtual Task PutGeoipDatabaseAsync(Elastic.Clie /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPipelineResponse PutPipeline(PutPipelineRequest request) @@ -1467,7 +1467,7 @@ public virtual PutPipelineResponse PutPipeline(PutPipelineRequest request) /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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) { @@ -1480,7 +1480,7 @@ public virtual Task PutPipelineAsync(PutPipelineRequest req /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPipelineResponse PutPipeline(PutPipelineRequestDescriptor descriptor) @@ -1494,7 +1494,7 @@ public virtual PutPipelineResponse PutPipeline(PutPipelineRequestDesc /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id id) @@ -1509,7 +1509,7 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasti /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest) @@ -1525,7 +1525,7 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasti /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPipelineResponse PutPipeline(PutPipelineRequestDescriptor descriptor) @@ -1539,7 +1539,7 @@ public virtual PutPipelineResponse PutPipeline(PutPipelineRequestDescriptor desc /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id id) @@ -1554,7 +1554,7 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id id, Action configureRequest) @@ -1570,7 +1570,7 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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) { @@ -1583,7 +1583,7 @@ public virtual Task PutPipelineAsync(PutPipeline /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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, CancellationToken cancellationToken = default) { @@ -1597,7 +1597,7 @@ public virtual Task PutPipelineAsync(Elastic.Cli /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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) { @@ -1612,7 +1612,7 @@ public virtual Task PutPipelineAsync(Elastic.Cli /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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) { @@ -1625,7 +1625,7 @@ public virtual Task PutPipelineAsync(PutPipelineRequestDesc /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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, CancellationToken cancellationToken = default) { @@ -1639,7 +1639,7 @@ public virtual Task PutPipelineAsync(Elastic.Clients.Elasti /// Creates or updates an ingest pipeline. /// Changes made using this API take effect immediately. /// - /// 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/Client/ElasticsearchClient.Ml.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ml.g.cs index 3ac1051ceb..89c08ca653 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ml.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ml.g.cs @@ -185,7 +185,7 @@ public virtual Task ClearTrainedModelD /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. /// When a datafeed that has a specified end date stops, it automatically closes its associated job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseJobResponse CloseJob(CloseJobRequest request) @@ -202,7 +202,7 @@ public virtual CloseJobResponse CloseJob(CloseJobRequest request) /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. /// When a datafeed that has a specified end date stops, it automatically closes its associated job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(CloseJobRequest request, CancellationToken cancellationToken = default) { @@ -218,7 +218,7 @@ public virtual Task CloseJobAsync(CloseJobRequest request, Can /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. /// When a datafeed that has a specified end date stops, it automatically closes its associated job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseJobResponse CloseJob(CloseJobRequestDescriptor descriptor) @@ -235,7 +235,7 @@ public virtual CloseJobResponse CloseJob(CloseJobRequestDescriptor descriptor) /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. /// When a datafeed that has a specified end date stops, it automatically closes its associated job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseJobResponse CloseJob(Elastic.Clients.Elasticsearch.Id jobId) @@ -253,7 +253,7 @@ public virtual CloseJobResponse CloseJob(Elastic.Clients.Elasticsearch.Id jobId) /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. /// When a datafeed that has a specified end date stops, it automatically closes its associated job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CloseJobResponse CloseJob(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest) @@ -272,7 +272,7 @@ public virtual CloseJobResponse CloseJob(Elastic.Clients.Elasticsearch.Id jobId, /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. /// When a datafeed that has a specified end date stops, it automatically closes its associated job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(CloseJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -288,7 +288,7 @@ public virtual Task CloseJobAsync(CloseJobRequestDescriptor de /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. /// When a datafeed that has a specified end date stops, it automatically closes its associated job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) { @@ -305,7 +305,7 @@ public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearc /// If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. /// When a datafeed that has a specified end date stops, it automatically closes its associated job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -320,7 +320,7 @@ public virtual Task CloseJobAsync(Elastic.Clients.Elasticsearc /// Delete a calendar. /// Removes all scheduled events from a calendar, then deletes it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteCalendarResponse DeleteCalendar(DeleteCalendarRequest request) @@ -334,7 +334,7 @@ public virtual DeleteCalendarResponse DeleteCalendar(DeleteCalendarRequest reque /// Delete a calendar. /// Removes all scheduled events from a calendar, then deletes it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(DeleteCalendarRequest request, CancellationToken cancellationToken = default) { @@ -347,7 +347,7 @@ public virtual Task DeleteCalendarAsync(DeleteCalendarRe /// Delete a calendar. /// Removes all scheduled events from a calendar, then deletes it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteCalendarResponse DeleteCalendar(DeleteCalendarRequestDescriptor descriptor) @@ -361,7 +361,7 @@ public virtual DeleteCalendarResponse DeleteCalendar(DeleteCalendarRequestDescri /// Delete a calendar. /// Removes all scheduled events from a calendar, then deletes it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteCalendarResponse DeleteCalendar(Elastic.Clients.Elasticsearch.Id calendarId) @@ -376,7 +376,7 @@ public virtual DeleteCalendarResponse DeleteCalendar(Elastic.Clients.Elasticsear /// Delete a calendar. /// Removes all scheduled events from a calendar, then deletes it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteCalendarResponse DeleteCalendar(Elastic.Clients.Elasticsearch.Id calendarId, Action configureRequest) @@ -392,7 +392,7 @@ public virtual DeleteCalendarResponse DeleteCalendar(Elastic.Clients.Elasticsear /// Delete a calendar. /// Removes all scheduled events from a calendar, then deletes it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(DeleteCalendarRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -405,7 +405,7 @@ public virtual Task DeleteCalendarAsync(DeleteCalendarRe /// Delete a calendar. /// Removes all scheduled events from a calendar, then deletes it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(Elastic.Clients.Elasticsearch.Id calendarId, CancellationToken cancellationToken = default) { @@ -419,7 +419,7 @@ public virtual Task DeleteCalendarAsync(Elastic.Clients. /// Delete a calendar. /// Removes all scheduled events from a calendar, then deletes it. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarAsync(Elastic.Clients.Elasticsearch.Id calendarId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -433,7 +433,7 @@ public virtual Task DeleteCalendarAsync(Elastic.Clients. /// /// Delete events from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteCalendarEventResponse DeleteCalendarEvent(DeleteCalendarEventRequest request) @@ -446,7 +446,7 @@ public virtual DeleteCalendarEventResponse DeleteCalendarEvent(DeleteCalendarEve /// /// Delete events from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(DeleteCalendarEventRequest request, CancellationToken cancellationToken = default) { @@ -458,7 +458,7 @@ public virtual Task DeleteCalendarEventAsync(Delete /// /// Delete events from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteCalendarEventResponse DeleteCalendarEvent(DeleteCalendarEventRequestDescriptor descriptor) @@ -471,7 +471,7 @@ public virtual DeleteCalendarEventResponse DeleteCalendarEvent(DeleteCalendarEve /// /// Delete events from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteCalendarEventResponse DeleteCalendarEvent(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Id eventId) @@ -485,7 +485,7 @@ public virtual DeleteCalendarEventResponse DeleteCalendarEvent(Elastic.Clients.E /// /// Delete events from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteCalendarEventResponse DeleteCalendarEvent(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Id eventId, Action configureRequest) @@ -500,7 +500,7 @@ public virtual DeleteCalendarEventResponse DeleteCalendarEvent(Elastic.Clients.E /// /// Delete events from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(DeleteCalendarEventRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -512,7 +512,7 @@ public virtual Task DeleteCalendarEventAsync(Delete /// /// Delete events from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Id eventId, CancellationToken cancellationToken = default) { @@ -525,7 +525,7 @@ public virtual Task DeleteCalendarEventAsync(Elasti /// /// Delete events from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarEventAsync(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Id eventId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -539,7 +539,7 @@ public virtual Task DeleteCalendarEventAsync(Elasti /// /// Delete anomaly jobs from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteCalendarJobResponse DeleteCalendarJob(DeleteCalendarJobRequest request) @@ -552,7 +552,7 @@ public virtual DeleteCalendarJobResponse DeleteCalendarJob(DeleteCalendarJobRequ /// /// Delete anomaly jobs from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(DeleteCalendarJobRequest request, CancellationToken cancellationToken = default) { @@ -564,7 +564,7 @@ public virtual Task DeleteCalendarJobAsync(DeleteCale /// /// Delete anomaly jobs from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteCalendarJobResponse DeleteCalendarJob(DeleteCalendarJobRequestDescriptor descriptor) @@ -577,7 +577,7 @@ public virtual DeleteCalendarJobResponse DeleteCalendarJob(DeleteCalendarJobRequ /// /// Delete anomaly jobs from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteCalendarJobResponse DeleteCalendarJob(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Ids jobId) @@ -591,7 +591,7 @@ public virtual DeleteCalendarJobResponse DeleteCalendarJob(Elastic.Clients.Elast /// /// Delete anomaly jobs from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteCalendarJobResponse DeleteCalendarJob(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Ids jobId, Action configureRequest) @@ -606,7 +606,7 @@ public virtual DeleteCalendarJobResponse DeleteCalendarJob(Elastic.Clients.Elast /// /// Delete anomaly jobs from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(DeleteCalendarJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -618,7 +618,7 @@ public virtual Task DeleteCalendarJobAsync(DeleteCale /// /// Delete anomaly jobs from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Ids jobId, CancellationToken cancellationToken = default) { @@ -631,7 +631,7 @@ public virtual Task DeleteCalendarJobAsync(Elastic.Cl /// /// Delete anomaly jobs from a calendar. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteCalendarJobAsync(Elastic.Clients.Elasticsearch.Id calendarId, Elastic.Clients.Elasticsearch.Ids jobId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -645,7 +645,7 @@ public virtual Task DeleteCalendarJobAsync(Elastic.Cl /// /// Delete a datafeed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteDatafeedResponse DeleteDatafeed(DeleteDatafeedRequest request) @@ -658,7 +658,7 @@ public virtual DeleteDatafeedResponse DeleteDatafeed(DeleteDatafeedRequest reque /// /// Delete a datafeed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(DeleteDatafeedRequest request, CancellationToken cancellationToken = default) { @@ -670,7 +670,7 @@ public virtual Task DeleteDatafeedAsync(DeleteDatafeedRe /// /// Delete a datafeed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteDatafeedResponse DeleteDatafeed(DeleteDatafeedRequestDescriptor descriptor) @@ -683,7 +683,7 @@ public virtual DeleteDatafeedResponse DeleteDatafeed(DeleteDatafeedRequestDescri /// /// Delete a datafeed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteDatafeedResponse DeleteDatafeed(Elastic.Clients.Elasticsearch.Id datafeedId) @@ -697,7 +697,7 @@ public virtual DeleteDatafeedResponse DeleteDatafeed(Elastic.Clients.Elasticsear /// /// Delete a datafeed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteDatafeedResponse DeleteDatafeed(Elastic.Clients.Elasticsearch.Id datafeedId, Action configureRequest) @@ -712,7 +712,7 @@ public virtual DeleteDatafeedResponse DeleteDatafeed(Elastic.Clients.Elasticsear /// /// Delete a datafeed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(DeleteDatafeedRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -724,7 +724,7 @@ public virtual Task DeleteDatafeedAsync(DeleteDatafeedRe /// /// Delete a datafeed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, CancellationToken cancellationToken = default) { @@ -737,7 +737,7 @@ public virtual Task DeleteDatafeedAsync(Elastic.Clients. /// /// Delete a datafeed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDatafeedAsync(Elastic.Clients.Elasticsearch.Id datafeedId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -751,7 +751,7 @@ public virtual Task DeleteDatafeedAsync(Elastic.Clients. /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(DeleteDataFrameAnalyticsRequest request) @@ -764,7 +764,7 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(DeleteD /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) { @@ -776,7 +776,7 @@ public virtual Task DeleteDataFrameAnalyticsAs /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(DeleteDataFrameAnalyticsRequestDescriptor descriptor) @@ -789,7 +789,7 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(Elastic.Clients.Elasticsearch.Id id) @@ -803,7 +803,7 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest) @@ -818,7 +818,7 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(DeleteDataFrameAnalyticsRequestDescriptor descriptor) @@ -831,7 +831,7 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(DeleteD /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(Elastic.Clients.Elasticsearch.Id id) @@ -845,7 +845,7 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(Elastic /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(Elastic.Clients.Elasticsearch.Id id, Action configureRequest) @@ -860,7 +860,7 @@ public virtual DeleteDataFrameAnalyticsResponse DeleteDataFrameAnalytics(Elastic /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -872,7 +872,7 @@ public virtual Task DeleteDataFrameAnalyticsAs /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -885,7 +885,7 @@ public virtual Task DeleteDataFrameAnalyticsAs /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -899,7 +899,7 @@ public virtual Task DeleteDataFrameAnalyticsAs /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(DeleteDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -911,7 +911,7 @@ public virtual Task DeleteDataFrameAnalyticsAs /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -924,7 +924,7 @@ public virtual Task DeleteDataFrameAnalyticsAs /// /// Delete a data frame analytics job. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) { @@ -8825,7 +8825,12 @@ public virtual Task PutCalendarJobAsync(Elastic.Clients. /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8842,7 +8847,12 @@ public virtual PutDatafeedResponse PutDatafeed(PutDatafeedRequest request) /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8858,7 +8868,12 @@ public virtual Task PutDatafeedAsync(PutDatafeedRequest req /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8875,7 +8890,12 @@ public virtual PutDatafeedResponse PutDatafeed(PutDatafeedRequestDesc /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8893,7 +8913,12 @@ public virtual PutDatafeedResponse PutDatafeed(Elastic.Clients.Elasti /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8912,7 +8937,12 @@ public virtual PutDatafeedResponse PutDatafeed(Elastic.Clients.Elasti /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8929,7 +8959,12 @@ public virtual PutDatafeedResponse PutDatafeed(PutDatafeedRequestDescriptor desc /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8947,7 +8982,12 @@ public virtual PutDatafeedResponse PutDatafeed(Elastic.Clients.Elasticsearch.Id /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8966,7 +9006,12 @@ public virtual PutDatafeedResponse PutDatafeed(Elastic.Clients.Elasticsearch.Id /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8982,7 +9027,12 @@ public virtual Task PutDatafeedAsync(PutDatafeed /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8999,7 +9049,12 @@ public virtual Task PutDatafeedAsync(Elastic.Cli /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9017,7 +9072,12 @@ public virtual Task PutDatafeedAsync(Elastic.Cli /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9033,7 +9093,12 @@ public virtual Task PutDatafeedAsync(PutDatafeedRequestDesc /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9050,7 +9115,12 @@ public virtual Task PutDatafeedAsync(Elastic.Clients.Elasti /// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. /// You can associate only one datafeed with each anomaly detection job. /// The datafeed contains a query that runs at a defined interval (frequency). - /// If you are concerned about delayed data, you can add a delay (query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the .ml-configindex. Do not give userswriteprivileges on the.ml-config` index. + /// If you are concerned about delayed data, you can add a delay (query_delay) at each interval. + /// When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + /// at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + /// those credentials are used instead. + /// You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + /// directly to the .ml-config index. Do not give users write privileges on the .ml-config index. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9068,7 +9138,7 @@ public virtual Task PutDatafeedAsync(Elastic.Clients.Elasti /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(PutDataFrameAnalyticsRequest request) @@ -9083,7 +9153,7 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(PutDataFrameA /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequest request, CancellationToken cancellationToken = default) { @@ -9097,7 +9167,7 @@ public virtual Task PutDataFrameAnalyticsAsync(Pu /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(PutDataFrameAnalyticsRequestDescriptor descriptor) @@ -9112,7 +9182,7 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(Pu /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(Elastic.Clients.Elasticsearch.Id id) @@ -9128,7 +9198,7 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(El /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest) @@ -9145,7 +9215,7 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(El /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(PutDataFrameAnalyticsRequestDescriptor descriptor) @@ -9160,7 +9230,7 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(PutDataFrameA /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(Elastic.Clients.Elasticsearch.Id id) @@ -9176,7 +9246,7 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(Elastic.Clien /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(Elastic.Clients.Elasticsearch.Id id, Action configureRequest) @@ -9193,7 +9263,7 @@ public virtual PutDataFrameAnalyticsResponse PutDataFrameAnalytics(Elastic.Clien /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -9207,7 +9277,7 @@ public virtual Task PutDataFrameAnalyticsAsync - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -9222,7 +9292,7 @@ public virtual Task PutDataFrameAnalyticsAsync - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -9238,7 +9308,7 @@ public virtual Task PutDataFrameAnalyticsAsync - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(PutDataFrameAnalyticsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -9252,7 +9322,7 @@ public virtual Task PutDataFrameAnalyticsAsync(Pu /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) { @@ -9267,7 +9337,7 @@ public virtual Task PutDataFrameAnalyticsAsync(El /// This API creates a data frame analytics job that performs an analysis on the /// source indices and stores the outcome in a destination index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutDataFrameAnalyticsAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Nodes.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Nodes.g.cs index 7588571dea..039187be17 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Nodes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Nodes.g.cs @@ -280,7 +280,7 @@ public virtual Task GetRepositoriesMetering /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HotThreadsResponse HotThreads(HotThreadsRequest request) @@ -294,7 +294,7 @@ public virtual HotThreadsResponse HotThreads(HotThreadsRequest request) /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(HotThreadsRequest request, CancellationToken cancellationToken = default) { @@ -307,7 +307,7 @@ public virtual Task HotThreadsAsync(HotThreadsRequest reques /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HotThreadsResponse HotThreads(HotThreadsRequestDescriptor descriptor) @@ -321,7 +321,7 @@ public virtual HotThreadsResponse HotThreads(HotThreadsRequestDescriptor descrip /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HotThreadsResponse HotThreads(Elastic.Clients.Elasticsearch.NodeIds? nodeId) @@ -336,7 +336,7 @@ public virtual HotThreadsResponse HotThreads(Elastic.Clients.Elasticsearch.NodeI /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HotThreadsResponse HotThreads(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Action configureRequest) @@ -352,7 +352,7 @@ public virtual HotThreadsResponse HotThreads(Elastic.Clients.Elasticsearch.NodeI /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HotThreadsResponse HotThreads() @@ -367,7 +367,7 @@ public virtual HotThreadsResponse HotThreads() /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HotThreadsResponse HotThreads(Action configureRequest) @@ -383,7 +383,7 @@ public virtual HotThreadsResponse HotThreads(Action /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(HotThreadsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -396,7 +396,7 @@ public virtual Task HotThreadsAsync(HotThreadsRequestDescrip /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, CancellationToken cancellationToken = default) { @@ -410,7 +410,7 @@ public virtual Task HotThreadsAsync(Elastic.Clients.Elastics /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -425,7 +425,7 @@ public virtual Task HotThreadsAsync(Elastic.Clients.Elastics /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(CancellationToken cancellationToken = default) { @@ -439,7 +439,7 @@ public virtual Task HotThreadsAsync(CancellationToken cancel /// This API yields a breakdown of the hot threads on each selected node in the cluster. /// The output is plain text with a breakdown of each node’s top hot threads. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HotThreadsAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -453,7 +453,7 @@ public virtual Task HotThreadsAsync(Action /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesInfoResponse Info(NodesInfoRequest request) @@ -466,7 +466,7 @@ public virtual NodesInfoResponse Info(NodesInfoRequest request) /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(NodesInfoRequest request, CancellationToken cancellationToken = default) { @@ -478,7 +478,7 @@ public virtual Task InfoAsync(NodesInfoRequest request, Cance /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesInfoResponse Info(NodesInfoRequestDescriptor descriptor) @@ -491,7 +491,7 @@ public virtual NodesInfoResponse Info(NodesInfoRequestDescriptor descriptor) /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesInfoResponse Info(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric) @@ -505,7 +505,7 @@ public virtual NodesInfoResponse Info(Elastic.Clients.Elasticsearch.NodeIds? nod /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesInfoResponse Info(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Action configureRequest) @@ -520,7 +520,7 @@ public virtual NodesInfoResponse Info(Elastic.Clients.Elasticsearch.NodeIds? nod /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesInfoResponse Info() @@ -534,7 +534,7 @@ public virtual NodesInfoResponse Info() /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesInfoResponse Info(Action configureRequest) @@ -549,7 +549,7 @@ public virtual NodesInfoResponse Info(Action configu /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(NodesInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -561,7 +561,7 @@ public virtual Task InfoAsync(NodesInfoRequestDescriptor desc /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, CancellationToken cancellationToken = default) { @@ -574,7 +574,7 @@ public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.N /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Action configureRequest, CancellationToken cancellationToken = default) { @@ -588,7 +588,7 @@ public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.N /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(CancellationToken cancellationToken = default) { @@ -601,7 +601,7 @@ public virtual Task InfoAsync(CancellationToken cancellationT /// /// Returns cluster nodes information. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -777,7 +777,7 @@ public virtual Task ReloadSecureSettingsAsync(Acti /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesStatsResponse Stats(NodesStatsRequest request) @@ -790,7 +790,7 @@ public virtual NodesStatsResponse Stats(NodesStatsRequest request) /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(NodesStatsRequest request, CancellationToken cancellationToken = default) { @@ -802,7 +802,7 @@ public virtual Task StatsAsync(NodesStatsRequest request, Ca /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesStatsResponse Stats(NodesStatsRequestDescriptor descriptor) @@ -815,7 +815,7 @@ public virtual NodesStatsResponse Stats(NodesStatsRequestDescriptor /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Elastic.Clients.Elasticsearch.Metrics? indexMetric) @@ -829,7 +829,7 @@ public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Elastic.Clients.Elasticsearch.Metrics? indexMetric, Action> configureRequest) @@ -844,7 +844,7 @@ public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesStatsResponse Stats() @@ -858,7 +858,7 @@ public virtual NodesStatsResponse Stats() /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesStatsResponse Stats(Action> configureRequest) @@ -873,7 +873,7 @@ public virtual NodesStatsResponse Stats(Action /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesStatsResponse Stats(NodesStatsRequestDescriptor descriptor) @@ -886,7 +886,7 @@ public virtual NodesStatsResponse Stats(NodesStatsRequestDescriptor descriptor) /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Elastic.Clients.Elasticsearch.Metrics? indexMetric) @@ -900,7 +900,7 @@ public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? n /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Elastic.Clients.Elasticsearch.Metrics? indexMetric, Action configureRequest) @@ -915,7 +915,7 @@ public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? n /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesStatsResponse Stats() @@ -929,7 +929,7 @@ public virtual NodesStatsResponse Stats() /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesStatsResponse Stats(Action configureRequest) @@ -944,7 +944,7 @@ public virtual NodesStatsResponse Stats(Action conf /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(NodesStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -956,7 +956,7 @@ public virtual Task StatsAsync(NodesStatsRequestD /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Elastic.Clients.Elasticsearch.Metrics? indexMetric, CancellationToken cancellationToken = default) { @@ -969,7 +969,7 @@ public virtual Task StatsAsync(Elastic.Clients.El /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Elastic.Clients.Elasticsearch.Metrics? indexMetric, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -983,7 +983,7 @@ public virtual Task StatsAsync(Elastic.Clients.El /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) { @@ -996,7 +996,7 @@ public virtual Task StatsAsync(CancellationToken /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1010,7 +1010,7 @@ public virtual Task StatsAsync(Action /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(NodesStatsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1022,7 +1022,7 @@ public virtual Task StatsAsync(NodesStatsRequestDescriptor d /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Elastic.Clients.Elasticsearch.Metrics? indexMetric, CancellationToken cancellationToken = default) { @@ -1035,7 +1035,7 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsearch /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Elastic.Clients.Elasticsearch.Metrics? indexMetric, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1049,7 +1049,7 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsearch /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(CancellationToken cancellationToken = default) { @@ -1062,7 +1062,7 @@ public virtual Task StatsAsync(CancellationToken cancellatio /// /// Returns cluster nodes statistics. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task StatsAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -1076,7 +1076,7 @@ public virtual Task StatsAsync(Action /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesUsageResponse Usage(NodesUsageRequest request) @@ -1089,7 +1089,7 @@ public virtual NodesUsageResponse Usage(NodesUsageRequest request) /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(NodesUsageRequest request, CancellationToken cancellationToken = default) { @@ -1101,7 +1101,7 @@ public virtual Task UsageAsync(NodesUsageRequest request, Ca /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesUsageResponse Usage(NodesUsageRequestDescriptor descriptor) @@ -1114,7 +1114,7 @@ public virtual NodesUsageResponse Usage(NodesUsageRequestDescriptor descriptor) /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesUsageResponse Usage(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric) @@ -1128,7 +1128,7 @@ public virtual NodesUsageResponse Usage(Elastic.Clients.Elasticsearch.NodeIds? n /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesUsageResponse Usage(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Action configureRequest) @@ -1143,7 +1143,7 @@ public virtual NodesUsageResponse Usage(Elastic.Clients.Elasticsearch.NodeIds? n /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesUsageResponse Usage() @@ -1157,7 +1157,7 @@ public virtual NodesUsageResponse Usage() /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual NodesUsageResponse Usage(Action configureRequest) @@ -1172,7 +1172,7 @@ public virtual NodesUsageResponse Usage(Action conf /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(NodesUsageRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1184,7 +1184,7 @@ public virtual Task UsageAsync(NodesUsageRequestDescriptor d /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, CancellationToken cancellationToken = default) { @@ -1197,7 +1197,7 @@ public virtual Task UsageAsync(Elastic.Clients.Elasticsearch /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1211,7 +1211,7 @@ public virtual Task UsageAsync(Elastic.Clients.Elasticsearch /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(CancellationToken cancellationToken = default) { @@ -1224,7 +1224,7 @@ public virtual Task UsageAsync(CancellationToken cancellatio /// /// Returns information on the usage of features. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UsageAsync(Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.QueryRules.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.QueryRules.g.cs index f09318cfb7..bcd2320107 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.QueryRules.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.QueryRules.g.cs @@ -780,4 +780,110 @@ public virtual Task PutRulesetAsync(Elastic.Clients.Elastics descriptor.BeforeRequest(); return DoRequestAsync(descriptor, cancellationToken); } + + /// + /// + /// Creates or updates a query ruleset. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual TestResponse Test(TestRequest request) + { + request.BeforeRequest(); + return DoRequest(request); + } + + /// + /// + /// Creates or updates a query ruleset. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task TestAsync(TestRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Creates or updates a query ruleset. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual TestResponse Test(TestRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Creates or updates a query ruleset. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual TestResponse Test(Elastic.Clients.Elasticsearch.Id rulesetId) + { + var descriptor = new TestRequestDescriptor(rulesetId); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Creates or updates a query ruleset. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual TestResponse Test(Elastic.Clients.Elasticsearch.Id rulesetId, Action configureRequest) + { + var descriptor = new TestRequestDescriptor(rulesetId); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Creates or updates a query ruleset. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task TestAsync(TestRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Creates or updates a query ruleset. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task TestAsync(Elastic.Clients.Elasticsearch.Id rulesetId, CancellationToken cancellationToken = default) + { + var descriptor = new TestRequestDescriptor(rulesetId); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Creates or updates a query ruleset. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task TestAsync(Elastic.Clients.Elasticsearch.Id rulesetId, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new TestRequestDescriptor(rulesetId); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchApplication.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchApplication.g.cs index fc2498eacc..856c7d7656 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchApplication.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchApplication.g.cs @@ -686,7 +686,7 @@ public virtual PutSearchApplicationResponse Put(PutSearchApplicationRequestDescr /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] - public virtual PutSearchApplicationResponse Put(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplication searchApplication, Elastic.Clients.Elasticsearch.Name name) + public virtual PutSearchApplicationResponse Put(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationParameters searchApplication, Elastic.Clients.Elasticsearch.Name name) { var descriptor = new PutSearchApplicationRequestDescriptor(searchApplication, name); descriptor.BeforeRequest(); @@ -700,7 +700,7 @@ public virtual PutSearchApplicationResponse Put(Elastic.Clients.Elasticsearch.Se /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] - public virtual PutSearchApplicationResponse Put(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplication searchApplication, Elastic.Clients.Elasticsearch.Name name, Action configureRequest) + public virtual PutSearchApplicationResponse Put(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationParameters searchApplication, Elastic.Clients.Elasticsearch.Name name, Action configureRequest) { var descriptor = new PutSearchApplicationRequestDescriptor(searchApplication, name); configureRequest?.Invoke(descriptor); @@ -726,7 +726,7 @@ public virtual Task PutAsync(PutSearchApplicationR /// /// Learn more about this API in the Elasticsearch documentation. /// - public virtual Task PutAsync(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplication searchApplication, Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) + public virtual Task PutAsync(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationParameters searchApplication, Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) { var descriptor = new PutSearchApplicationRequestDescriptor(searchApplication, name); descriptor.BeforeRequest(); @@ -739,7 +739,7 @@ public virtual Task PutAsync(Elastic.Clients.Elast /// /// Learn more about this API in the Elasticsearch documentation. /// - public virtual Task PutAsync(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplication searchApplication, Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) + public virtual Task PutAsync(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationParameters searchApplication, Elastic.Clients.Elasticsearch.Name name, Action configureRequest, CancellationToken cancellationToken = default) { var descriptor = new PutSearchApplicationRequestDescriptor(searchApplication, name); configureRequest?.Invoke(descriptor); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Security.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Security.g.cs index d35c282ebc..65290355da 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Security.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Security.g.cs @@ -41,7 +41,10 @@ internal SecurityNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Creates or updates a user profile on behalf of another user. + /// Activate a user profile. + /// + /// + /// Create or update a user profile on behalf of another user. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +57,10 @@ public virtual ActivateUserProfileResponse ActivateUserProfile(ActivateUserProfi /// /// - /// Creates or updates a user profile on behalf of another user. + /// Activate a user profile. + /// + /// + /// Create or update a user profile on behalf of another user. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +72,10 @@ public virtual Task ActivateUserProfileAsync(Activa /// /// - /// Creates or updates a user profile on behalf of another user. + /// Activate a user profile. + /// + /// + /// Create or update a user profile on behalf of another user. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +88,10 @@ public virtual ActivateUserProfileResponse ActivateUserProfile(ActivateUserProfi /// /// - /// Creates or updates a user profile on behalf of another user. + /// Activate a user profile. + /// + /// + /// Create or update a user profile on behalf of another user. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +105,10 @@ public virtual ActivateUserProfileResponse ActivateUserProfile() /// /// - /// Creates or updates a user profile on behalf of another user. + /// Activate a user profile. + /// + /// + /// Create or update a user profile on behalf of another user. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +123,10 @@ public virtual ActivateUserProfileResponse ActivateUserProfile(Action /// - /// Creates or updates a user profile on behalf of another user. + /// Activate a user profile. + /// + /// + /// Create or update a user profile on behalf of another user. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -120,7 +138,10 @@ public virtual Task ActivateUserProfileAsync(Activa /// /// - /// Creates or updates a user profile on behalf of another user. + /// Activate a user profile. + /// + /// + /// Create or update a user profile on behalf of another user. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -133,7 +154,10 @@ public virtual Task ActivateUserProfileAsync(Cancel /// /// - /// Creates or updates a user profile on behalf of another user. + /// Activate a user profile. + /// + /// + /// Create or update a user profile on behalf of another user. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -148,6 +172,8 @@ public virtual Task ActivateUserProfileAsync(Action /// /// /// Authenticate a user. + /// + /// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -165,6 +191,8 @@ public virtual AuthenticateResponse Authenticate(AuthenticateRequest request) /// /// /// Authenticate a user. + /// + /// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -181,6 +209,8 @@ public virtual Task AuthenticateAsync(AuthenticateRequest /// /// /// Authenticate a user. + /// + /// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -198,6 +228,8 @@ public virtual AuthenticateResponse Authenticate(AuthenticateRequestDescriptor d /// /// /// Authenticate a user. + /// + /// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -216,6 +248,8 @@ public virtual AuthenticateResponse Authenticate() /// /// /// Authenticate a user. + /// + /// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -235,6 +269,8 @@ public virtual AuthenticateResponse Authenticate(Action /// /// Authenticate a user. + /// + /// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -251,6 +287,8 @@ public virtual Task AuthenticateAsync(AuthenticateRequestD /// /// /// Authenticate a user. + /// + /// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -268,6 +306,8 @@ public virtual Task AuthenticateAsync(CancellationToken ca /// /// /// Authenticate a user. + /// + /// /// Authenticates a user and returns information about the authenticated user. /// Include the user information in a basic auth header. /// A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. @@ -285,6 +325,9 @@ public virtual Task AuthenticateAsync(Action /// + /// Bulk delete roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -299,6 +342,9 @@ public virtual BulkDeleteRoleResponse BulkDeleteRole(BulkDeleteRoleRequest reque /// /// + /// Bulk delete roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -312,6 +358,9 @@ public virtual Task BulkDeleteRoleAsync(BulkDeleteRoleRe /// /// + /// Bulk delete roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -326,6 +375,9 @@ public virtual BulkDeleteRoleResponse BulkDeleteRole(BulkDeleteRoleRequestDescri /// /// + /// Bulk delete roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -341,6 +393,9 @@ public virtual BulkDeleteRoleResponse BulkDeleteRole() /// /// + /// Bulk delete roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -357,6 +412,9 @@ public virtual BulkDeleteRoleResponse BulkDeleteRole(Action /// + /// Bulk delete roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -370,6 +428,9 @@ public virtual Task BulkDeleteRoleAsync(BulkDeleteRoleRe /// /// + /// Bulk delete roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -384,6 +445,9 @@ public virtual Task BulkDeleteRoleAsync(CancellationToke /// /// + /// Bulk delete roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk delete roles API cannot delete roles that are defined in roles files. /// @@ -399,6 +463,9 @@ public virtual Task BulkDeleteRoleAsync(Action /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -413,6 +480,9 @@ public virtual BulkPutRoleResponse BulkPutRole(BulkPutRoleRequest request) /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -426,6 +496,9 @@ public virtual Task BulkPutRoleAsync(BulkPutRoleRequest req /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -440,6 +513,9 @@ public virtual BulkPutRoleResponse BulkPutRole(BulkPutRoleRequestDesc /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -455,6 +531,9 @@ public virtual BulkPutRoleResponse BulkPutRole() /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -471,6 +550,9 @@ public virtual BulkPutRoleResponse BulkPutRole(Action /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -485,6 +567,9 @@ public virtual BulkPutRoleResponse BulkPutRole(BulkPutRoleRequestDescriptor desc /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -500,6 +585,9 @@ public virtual BulkPutRoleResponse BulkPutRole() /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -516,6 +604,9 @@ public virtual BulkPutRoleResponse BulkPutRole(Action /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -529,6 +620,9 @@ public virtual Task BulkPutRoleAsync(BulkPutRole /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -543,6 +637,9 @@ public virtual Task BulkPutRoleAsync(Cancellatio /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -558,6 +655,9 @@ public virtual Task BulkPutRoleAsync(Action /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -571,6 +671,9 @@ public virtual Task BulkPutRoleAsync(BulkPutRoleRequestDesc /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -585,6 +688,9 @@ public virtual Task BulkPutRoleAsync(CancellationToken canc /// /// + /// Bulk create or update roles. + /// + /// /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. /// The bulk create or update roles API cannot update roles that are defined in roles files. /// @@ -600,7 +706,10 @@ public virtual Task BulkPutRoleAsync(Action /// - /// Changes the passwords of users in the native realm and built-in users. + /// Change passwords. + /// + /// + /// Change the passwords of users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -613,7 +722,10 @@ public virtual ChangePasswordResponse ChangePassword(ChangePasswordRequest reque /// /// - /// Changes the passwords of users in the native realm and built-in users. + /// Change passwords. + /// + /// + /// Change the passwords of users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -625,7 +737,10 @@ public virtual Task ChangePasswordAsync(ChangePasswordRe /// /// - /// Changes the passwords of users in the native realm and built-in users. + /// Change passwords. + /// + /// + /// Change the passwords of users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -638,7 +753,10 @@ public virtual ChangePasswordResponse ChangePassword(ChangePasswordRequestDescri /// /// - /// Changes the passwords of users in the native realm and built-in users. + /// Change passwords. + /// + /// + /// Change the passwords of users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -652,7 +770,10 @@ public virtual ChangePasswordResponse ChangePassword(Elastic.Clients.Elasticsear /// /// - /// Changes the passwords of users in the native realm and built-in users. + /// Change passwords. + /// + /// + /// Change the passwords of users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -667,7 +788,10 @@ public virtual ChangePasswordResponse ChangePassword(Elastic.Clients.Elasticsear /// /// - /// Changes the passwords of users in the native realm and built-in users. + /// Change passwords. + /// + /// + /// Change the passwords of users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -681,7 +805,10 @@ public virtual ChangePasswordResponse ChangePassword() /// /// - /// Changes the passwords of users in the native realm and built-in users. + /// Change passwords. + /// + /// + /// Change the passwords of users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -696,7 +823,10 @@ public virtual ChangePasswordResponse ChangePassword(Action /// - /// Changes the passwords of users in the native realm and built-in users. + /// Change passwords. + /// + /// + /// Change the passwords of users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -708,7 +838,10 @@ public virtual Task ChangePasswordAsync(ChangePasswordRe /// /// - /// Changes the passwords of users in the native realm and built-in users. + /// Change passwords. + /// + /// + /// Change the passwords of users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -721,7 +854,10 @@ public virtual Task ChangePasswordAsync(Elastic.Clients. /// /// - /// Changes the passwords of users in the native realm and built-in users. + /// Change passwords. + /// + /// + /// Change the passwords of users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -735,7 +871,10 @@ public virtual Task ChangePasswordAsync(Elastic.Clients. /// /// - /// Changes the passwords of users in the native realm and built-in users. + /// Change passwords. + /// + /// + /// Change the passwords of users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -748,7 +887,10 @@ public virtual Task ChangePasswordAsync(CancellationToke /// /// - /// Changes the passwords of users in the native realm and built-in users. + /// Change passwords. + /// + /// + /// Change the passwords of users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -762,7 +904,10 @@ public virtual Task ChangePasswordAsync(Action /// - /// Evicts a subset of all entries from the API key cache. + /// Clear the API key cache. + /// + /// + /// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// Learn more about this API in the Elasticsearch documentation. @@ -776,7 +921,10 @@ public virtual ClearApiKeyCacheResponse ClearApiKeyCache(ClearApiKeyCacheRequest /// /// - /// Evicts a subset of all entries from the API key cache. + /// Clear the API key cache. + /// + /// + /// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// Learn more about this API in the Elasticsearch documentation. @@ -789,7 +937,10 @@ public virtual Task ClearApiKeyCacheAsync(ClearApiKeyC /// /// - /// Evicts a subset of all entries from the API key cache. + /// Clear the API key cache. + /// + /// + /// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// Learn more about this API in the Elasticsearch documentation. @@ -803,7 +954,10 @@ public virtual ClearApiKeyCacheResponse ClearApiKeyCache(ClearApiKeyCacheRequest /// /// - /// Evicts a subset of all entries from the API key cache. + /// Clear the API key cache. + /// + /// + /// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// Learn more about this API in the Elasticsearch documentation. @@ -818,7 +972,10 @@ public virtual ClearApiKeyCacheResponse ClearApiKeyCache(Elastic.Clients.Elastic /// /// - /// Evicts a subset of all entries from the API key cache. + /// Clear the API key cache. + /// + /// + /// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// Learn more about this API in the Elasticsearch documentation. @@ -834,7 +991,10 @@ public virtual ClearApiKeyCacheResponse ClearApiKeyCache(Elastic.Clients.Elastic /// /// - /// Evicts a subset of all entries from the API key cache. + /// Clear the API key cache. + /// + /// + /// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// Learn more about this API in the Elasticsearch documentation. @@ -847,7 +1007,10 @@ public virtual Task ClearApiKeyCacheAsync(ClearApiKeyC /// /// - /// Evicts a subset of all entries from the API key cache. + /// Clear the API key cache. + /// + /// + /// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// Learn more about this API in the Elasticsearch documentation. @@ -861,7 +1024,10 @@ public virtual Task ClearApiKeyCacheAsync(Elastic.Clie /// /// - /// Evicts a subset of all entries from the API key cache. + /// Clear the API key cache. + /// + /// + /// Evict a subset of all entries from the API key cache. /// The cache is also automatically cleared on state changes of the security index. /// /// Learn more about this API in the Elasticsearch documentation. @@ -876,7 +1042,11 @@ public virtual Task ClearApiKeyCacheAsync(Elastic.Clie /// /// - /// Evicts application privileges from the native application privileges cache. + /// Clear the privileges cache. + /// + /// + /// Evict privileges from the native application privilege cache. + /// The cache is also automatically cleared for applications that have their privileges updated. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -889,7 +1059,11 @@ public virtual ClearCachedPrivilegesResponse ClearCachedPrivileges(ClearCachedPr /// /// - /// Evicts application privileges from the native application privileges cache. + /// Clear the privileges cache. + /// + /// + /// Evict privileges from the native application privilege cache. + /// The cache is also automatically cleared for applications that have their privileges updated. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -901,7 +1075,11 @@ public virtual Task ClearCachedPrivilegesAsync(Cl /// /// - /// Evicts application privileges from the native application privileges cache. + /// Clear the privileges cache. + /// + /// + /// Evict privileges from the native application privilege cache. + /// The cache is also automatically cleared for applications that have their privileges updated. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -914,7 +1092,11 @@ public virtual ClearCachedPrivilegesResponse ClearCachedPrivileges(ClearCachedPr /// /// - /// Evicts application privileges from the native application privileges cache. + /// Clear the privileges cache. + /// + /// + /// Evict privileges from the native application privilege cache. + /// The cache is also automatically cleared for applications that have their privileges updated. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -928,7 +1110,11 @@ public virtual ClearCachedPrivilegesResponse ClearCachedPrivileges(Elastic.Clien /// /// - /// Evicts application privileges from the native application privileges cache. + /// Clear the privileges cache. + /// + /// + /// Evict privileges from the native application privilege cache. + /// The cache is also automatically cleared for applications that have their privileges updated. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -943,7 +1129,11 @@ public virtual ClearCachedPrivilegesResponse ClearCachedPrivileges(Elastic.Clien /// /// - /// Evicts application privileges from the native application privileges cache. + /// Clear the privileges cache. + /// + /// + /// Evict privileges from the native application privilege cache. + /// The cache is also automatically cleared for applications that have their privileges updated. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -955,7 +1145,11 @@ public virtual Task ClearCachedPrivilegesAsync(Cl /// /// - /// Evicts application privileges from the native application privileges cache. + /// Clear the privileges cache. + /// + /// + /// Evict privileges from the native application privilege cache. + /// The cache is also automatically cleared for applications that have their privileges updated. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -968,7 +1162,11 @@ public virtual Task ClearCachedPrivilegesAsync(El /// /// - /// Evicts application privileges from the native application privileges cache. + /// Clear the privileges cache. + /// + /// + /// Evict privileges from the native application privilege cache. + /// The cache is also automatically cleared for applications that have their privileges updated. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -982,7 +1180,10 @@ public virtual Task ClearCachedPrivilegesAsync(El /// /// - /// Evicts users from the user cache. Can completely clear the cache or evict specific users. + /// Clear the user cache. + /// + /// + /// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -995,7 +1196,10 @@ public virtual ClearCachedRealmsResponse ClearCachedRealms(ClearCachedRealmsRequ /// /// - /// Evicts users from the user cache. Can completely clear the cache or evict specific users. + /// Clear the user cache. + /// + /// + /// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1007,7 +1211,10 @@ public virtual Task ClearCachedRealmsAsync(ClearCache /// /// - /// Evicts users from the user cache. Can completely clear the cache or evict specific users. + /// Clear the user cache. + /// + /// + /// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1020,7 +1227,10 @@ public virtual ClearCachedRealmsResponse ClearCachedRealms(ClearCachedRealmsRequ /// /// - /// Evicts users from the user cache. Can completely clear the cache or evict specific users. + /// Clear the user cache. + /// + /// + /// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1034,7 +1244,10 @@ public virtual ClearCachedRealmsResponse ClearCachedRealms(Elastic.Clients.Elast /// /// - /// Evicts users from the user cache. Can completely clear the cache or evict specific users. + /// Clear the user cache. + /// + /// + /// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1049,7 +1262,10 @@ public virtual ClearCachedRealmsResponse ClearCachedRealms(Elastic.Clients.Elast /// /// - /// Evicts users from the user cache. Can completely clear the cache or evict specific users. + /// Clear the user cache. + /// + /// + /// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1061,7 +1277,10 @@ public virtual Task ClearCachedRealmsAsync(ClearCache /// /// - /// Evicts users from the user cache. Can completely clear the cache or evict specific users. + /// Clear the user cache. + /// + /// + /// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1074,7 +1293,10 @@ public virtual Task ClearCachedRealmsAsync(Elastic.Cl /// /// - /// Evicts users from the user cache. Can completely clear the cache or evict specific users. + /// Clear the user cache. + /// + /// + /// Evict users from the user cache. You can completely clear the cache or evict specific users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1088,7 +1310,10 @@ public virtual Task ClearCachedRealmsAsync(Elastic.Cl /// /// - /// Evicts roles from the native role cache. + /// Clear the roles cache. + /// + /// + /// Evict roles from the native role cache. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1101,7 +1326,10 @@ public virtual ClearCachedRolesResponse ClearCachedRoles(ClearCachedRolesRequest /// /// - /// Evicts roles from the native role cache. + /// Clear the roles cache. + /// + /// + /// Evict roles from the native role cache. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1113,7 +1341,10 @@ public virtual Task ClearCachedRolesAsync(ClearCachedR /// /// - /// Evicts roles from the native role cache. + /// Clear the roles cache. + /// + /// + /// Evict roles from the native role cache. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1126,7 +1357,10 @@ public virtual ClearCachedRolesResponse ClearCachedRoles(ClearCachedRolesRequest /// /// - /// Evicts roles from the native role cache. + /// Clear the roles cache. + /// + /// + /// Evict roles from the native role cache. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1140,7 +1374,10 @@ public virtual ClearCachedRolesResponse ClearCachedRoles(Elastic.Clients.Elastic /// /// - /// Evicts roles from the native role cache. + /// Clear the roles cache. + /// + /// + /// Evict roles from the native role cache. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1155,7 +1392,10 @@ public virtual ClearCachedRolesResponse ClearCachedRoles(Elastic.Clients.Elastic /// /// - /// Evicts roles from the native role cache. + /// Clear the roles cache. + /// + /// + /// Evict roles from the native role cache. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1167,7 +1407,10 @@ public virtual Task ClearCachedRolesAsync(ClearCachedR /// /// - /// Evicts roles from the native role cache. + /// Clear the roles cache. + /// + /// + /// Evict roles from the native role cache. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1180,7 +1423,10 @@ public virtual Task ClearCachedRolesAsync(Elastic.Clie /// /// - /// Evicts roles from the native role cache. + /// Clear the roles cache. + /// + /// + /// Evict roles from the native role cache. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1194,7 +1440,10 @@ public virtual Task ClearCachedRolesAsync(Elastic.Clie /// /// - /// Evicts tokens from the service account token caches. + /// Clear service account token caches. + /// + /// + /// Evict a subset of all entries from the service account token caches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1207,7 +1456,10 @@ public virtual ClearCachedServiceTokensResponse ClearCachedServiceTokens(ClearCa /// /// - /// Evicts tokens from the service account token caches. + /// Clear service account token caches. + /// + /// + /// Evict a subset of all entries from the service account token caches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1219,7 +1471,10 @@ public virtual Task ClearCachedServiceTokensAs /// /// - /// Evicts tokens from the service account token caches. + /// Clear service account token caches. + /// + /// + /// Evict a subset of all entries from the service account token caches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1232,7 +1487,10 @@ public virtual ClearCachedServiceTokensResponse ClearCachedServiceTokens(ClearCa /// /// - /// Evicts tokens from the service account token caches. + /// Clear service account token caches. + /// + /// + /// Evict a subset of all entries from the service account token caches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1246,7 +1504,10 @@ public virtual ClearCachedServiceTokensResponse ClearCachedServiceTokens(string /// /// - /// Evicts tokens from the service account token caches. + /// Clear service account token caches. + /// + /// + /// Evict a subset of all entries from the service account token caches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1261,7 +1522,10 @@ public virtual ClearCachedServiceTokensResponse ClearCachedServiceTokens(string /// /// - /// Evicts tokens from the service account token caches. + /// Clear service account token caches. + /// + /// + /// Evict a subset of all entries from the service account token caches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1273,7 +1537,10 @@ public virtual Task ClearCachedServiceTokensAs /// /// - /// Evicts tokens from the service account token caches. + /// Clear service account token caches. + /// + /// + /// Evict a subset of all entries from the service account token caches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1286,7 +1553,10 @@ public virtual Task ClearCachedServiceTokensAs /// /// - /// Evicts tokens from the service account token caches. + /// Clear service account token caches. + /// + /// + /// Evict a subset of all entries from the service account token caches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1301,7 +1571,9 @@ public virtual Task ClearCachedServiceTokensAs /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1318,7 +1590,9 @@ public virtual CreateApiKeyResponse CreateApiKey(CreateApiKeyRequest request) /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1334,7 +1608,9 @@ public virtual Task CreateApiKeyAsync(CreateApiKeyRequest /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1351,7 +1627,9 @@ public virtual CreateApiKeyResponse CreateApiKey(CreateApiKeyRequestD /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1369,7 +1647,9 @@ public virtual CreateApiKeyResponse CreateApiKey() /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1388,7 +1668,9 @@ public virtual CreateApiKeyResponse CreateApiKey(Action /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1405,7 +1687,9 @@ public virtual CreateApiKeyResponse CreateApiKey(CreateApiKeyRequestDescriptor d /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1423,7 +1707,9 @@ public virtual CreateApiKeyResponse CreateApiKey() /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1442,7 +1728,9 @@ public virtual CreateApiKeyResponse CreateApiKey(Action /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1458,7 +1746,9 @@ public virtual Task CreateApiKeyAsync(CreateApi /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1475,7 +1765,9 @@ public virtual Task CreateApiKeyAsync(Cancellat /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1493,7 +1785,9 @@ public virtual Task CreateApiKeyAsync(Action /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1509,7 +1803,9 @@ public virtual Task CreateApiKeyAsync(CreateApiKeyRequestD /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1526,7 +1822,9 @@ public virtual Task CreateApiKeyAsync(CancellationToken ca /// /// /// Create an API key. - /// Creates an API key for access without requiring basic authentication. + /// + /// + /// Create an API key for access without requiring basic authentication. /// A successful request returns a JSON structure that contains the API key, its unique id, and its name. /// If applicable, it also returns expiration information for the API key in milliseconds. /// NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. @@ -1543,48 +1841,569 @@ public virtual Task CreateApiKeyAsync(Action /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a cross-cluster API key. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] - public virtual CreateServiceTokenResponse CreateServiceToken(CreateServiceTokenRequest request) + public virtual CreateCrossClusterApiKeyResponse CreateCrossClusterApiKey(CreateCrossClusterApiKeyRequest request) { request.BeforeRequest(); - return DoRequest(request); + return DoRequest(request); } /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a cross-cluster API key. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. /// - public virtual Task CreateServiceTokenAsync(CreateServiceTokenRequest request, CancellationToken cancellationToken = default) + public virtual Task CreateCrossClusterApiKeyAsync(CreateCrossClusterApiKeyRequest request, CancellationToken cancellationToken = default) { request.BeforeRequest(); - return DoRequestAsync(request, cancellationToken); + return DoRequestAsync(request, cancellationToken); } /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a cross-cluster API key. /// - /// Learn more about this API in the Elasticsearch documentation. - /// - [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] - public virtual CreateServiceTokenResponse CreateServiceToken(CreateServiceTokenRequestDescriptor descriptor) - { - descriptor.BeforeRequest(); - return DoRequest(descriptor); - } - - /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. /// - /// Learn more about this API in the Elasticsearch documentation. - /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual CreateCrossClusterApiKeyResponse CreateCrossClusterApiKey(CreateCrossClusterApiKeyRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest, CreateCrossClusterApiKeyResponse, CreateCrossClusterApiKeyRequestParameters>(descriptor); + } + + /// + /// + /// Create a cross-cluster API key. + /// + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual CreateCrossClusterApiKeyResponse CreateCrossClusterApiKey() + { + var descriptor = new CreateCrossClusterApiKeyRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequest, CreateCrossClusterApiKeyResponse, CreateCrossClusterApiKeyRequestParameters>(descriptor); + } + + /// + /// + /// Create a cross-cluster API key. + /// + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual CreateCrossClusterApiKeyResponse CreateCrossClusterApiKey(Action> configureRequest) + { + var descriptor = new CreateCrossClusterApiKeyRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest, CreateCrossClusterApiKeyResponse, CreateCrossClusterApiKeyRequestParameters>(descriptor); + } + + /// + /// + /// Create a cross-cluster API key. + /// + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual CreateCrossClusterApiKeyResponse CreateCrossClusterApiKey(CreateCrossClusterApiKeyRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Create a cross-cluster API key. + /// + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual CreateCrossClusterApiKeyResponse CreateCrossClusterApiKey() + { + var descriptor = new CreateCrossClusterApiKeyRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Create a cross-cluster API key. + /// + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual CreateCrossClusterApiKeyResponse CreateCrossClusterApiKey(Action configureRequest) + { + var descriptor = new CreateCrossClusterApiKeyRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Create a cross-cluster API key. + /// + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task CreateCrossClusterApiKeyAsync(CreateCrossClusterApiKeyRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync, CreateCrossClusterApiKeyResponse, CreateCrossClusterApiKeyRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Create a cross-cluster API key. + /// + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task CreateCrossClusterApiKeyAsync(CancellationToken cancellationToken = default) + { + var descriptor = new CreateCrossClusterApiKeyRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequestAsync, CreateCrossClusterApiKeyResponse, CreateCrossClusterApiKeyRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Create a cross-cluster API key. + /// + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task CreateCrossClusterApiKeyAsync(Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new CreateCrossClusterApiKeyRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, CreateCrossClusterApiKeyResponse, CreateCrossClusterApiKeyRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Create a cross-cluster API key. + /// + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task CreateCrossClusterApiKeyAsync(CreateCrossClusterApiKeyRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create a cross-cluster API key. + /// + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task CreateCrossClusterApiKeyAsync(CancellationToken cancellationToken = default) + { + var descriptor = new CreateCrossClusterApiKeyRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create a cross-cluster API key. + /// + /// + /// Create an API key of the cross_cluster type for the API key based remote cluster access. + /// A cross_cluster API key cannot be used to authenticate through the REST interface. + /// + /// + /// IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + /// + /// + /// Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + /// + /// + /// NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the access property. + /// + /// + /// A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + /// + /// + /// By default, API keys never expire. You can specify expiration information when you create the API keys. + /// + /// + /// Cross-cluster API keys can only be updated with the update cross-cluster API key API. + /// Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task CreateCrossClusterApiKeyAsync(Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new CreateCrossClusterApiKeyRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual CreateServiceTokenResponse CreateServiceToken(CreateServiceTokenRequest request) + { + request.BeforeRequest(); + return DoRequest(request); + } + + /// + /// + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task CreateServiceTokenAsync(CreateServiceTokenRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual CreateServiceTokenResponse CreateServiceToken(CreateServiceTokenRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CreateServiceTokenResponse CreateServiceToken(string ns, string service, Elastic.Clients.Elasticsearch.Name? name) { @@ -1595,7 +2414,10 @@ public virtual CreateServiceTokenResponse CreateServiceToken(string ns, string s /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1610,7 +2432,10 @@ public virtual CreateServiceTokenResponse CreateServiceToken(string ns, string s /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1624,7 +2449,10 @@ public virtual CreateServiceTokenResponse CreateServiceToken(string ns, string s /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1639,7 +2467,10 @@ public virtual CreateServiceTokenResponse CreateServiceToken(string ns, string s /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1651,7 +2482,10 @@ public virtual Task CreateServiceTokenAsync(CreateSe /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1664,7 +2498,10 @@ public virtual Task CreateServiceTokenAsync(string n /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1678,7 +2515,10 @@ public virtual Task CreateServiceTokenAsync(string n /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1691,7 +2531,10 @@ public virtual Task CreateServiceTokenAsync(string n /// /// - /// Creates a service accounts token for access without requiring basic authentication. + /// Create a service account token. + /// + /// + /// Create a service accounts token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1705,7 +2548,7 @@ public virtual Task CreateServiceTokenAsync(string n /// /// - /// Removes application privileges. + /// Delete application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1718,7 +2561,7 @@ public virtual DeletePrivilegesResponse DeletePrivileges(DeletePrivilegesRequest /// /// - /// Removes application privileges. + /// Delete application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1730,7 +2573,7 @@ public virtual Task DeletePrivilegesAsync(DeletePrivil /// /// - /// Removes application privileges. + /// Delete application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1743,7 +2586,7 @@ public virtual DeletePrivilegesResponse DeletePrivileges(DeletePrivilegesRequest /// /// - /// Removes application privileges. + /// Delete application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1757,7 +2600,7 @@ public virtual DeletePrivilegesResponse DeletePrivileges(Elastic.Clients.Elastic /// /// - /// Removes application privileges. + /// Delete application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1772,7 +2615,7 @@ public virtual DeletePrivilegesResponse DeletePrivileges(Elastic.Clients.Elastic /// /// - /// Removes application privileges. + /// Delete application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1784,7 +2627,7 @@ public virtual Task DeletePrivilegesAsync(DeletePrivil /// /// - /// Removes application privileges. + /// Delete application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1797,7 +2640,7 @@ public virtual Task DeletePrivilegesAsync(Elastic.Clie /// /// - /// Removes application privileges. + /// Delete application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1811,7 +2654,10 @@ public virtual Task DeletePrivilegesAsync(Elastic.Clie /// /// - /// Removes roles in the native realm. + /// Delete roles. + /// + /// + /// Delete roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1824,7 +2670,10 @@ public virtual DeleteRoleResponse DeleteRole(DeleteRoleRequest request) /// /// - /// Removes roles in the native realm. + /// Delete roles. + /// + /// + /// Delete roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1836,7 +2685,10 @@ public virtual Task DeleteRoleAsync(DeleteRoleRequest reques /// /// - /// Removes roles in the native realm. + /// Delete roles. + /// + /// + /// Delete roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1849,7 +2701,10 @@ public virtual DeleteRoleResponse DeleteRole(DeleteRoleRequestDescriptor descrip /// /// - /// Removes roles in the native realm. + /// Delete roles. + /// + /// + /// Delete roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1863,7 +2718,10 @@ public virtual DeleteRoleResponse DeleteRole(Elastic.Clients.Elasticsearch.Name /// /// - /// Removes roles in the native realm. + /// Delete roles. + /// + /// + /// Delete roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1878,7 +2736,10 @@ public virtual DeleteRoleResponse DeleteRole(Elastic.Clients.Elasticsearch.Name /// /// - /// Removes roles in the native realm. + /// Delete roles. + /// + /// + /// Delete roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1890,7 +2751,10 @@ public virtual Task DeleteRoleAsync(DeleteRoleRequestDescrip /// /// - /// Removes roles in the native realm. + /// Delete roles. + /// + /// + /// Delete roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1903,7 +2767,10 @@ public virtual Task DeleteRoleAsync(Elastic.Clients.Elastics /// /// - /// Removes roles in the native realm. + /// Delete roles. + /// + /// + /// Delete roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1917,7 +2784,7 @@ public virtual Task DeleteRoleAsync(Elastic.Clients.Elastics /// /// - /// Removes role mappings. + /// Delete role mappings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1930,7 +2797,7 @@ public virtual DeleteRoleMappingResponse DeleteRoleMapping(DeleteRoleMappingRequ /// /// - /// Removes role mappings. + /// Delete role mappings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1942,7 +2809,7 @@ public virtual Task DeleteRoleMappingAsync(DeleteRole /// /// - /// Removes role mappings. + /// Delete role mappings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1955,7 +2822,7 @@ public virtual DeleteRoleMappingResponse DeleteRoleMapping(DeleteRoleMappingRequ /// /// - /// Removes role mappings. + /// Delete role mappings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1969,7 +2836,7 @@ public virtual DeleteRoleMappingResponse DeleteRoleMapping(Elastic.Clients.Elast /// /// - /// Removes role mappings. + /// Delete role mappings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1984,7 +2851,7 @@ public virtual DeleteRoleMappingResponse DeleteRoleMapping(Elastic.Clients.Elast /// /// - /// Removes role mappings. + /// Delete role mappings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1996,7 +2863,7 @@ public virtual Task DeleteRoleMappingAsync(DeleteRole /// /// - /// Removes role mappings. + /// Delete role mappings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2009,7 +2876,7 @@ public virtual Task DeleteRoleMappingAsync(Elastic.Cl /// /// - /// Removes role mappings. + /// Delete role mappings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2023,7 +2890,10 @@ public virtual Task DeleteRoleMappingAsync(Elastic.Cl /// /// - /// Deletes a service account token. + /// Delete service account tokens. + /// + /// + /// Delete service account tokens for a service in a specified namespace. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2036,7 +2906,10 @@ public virtual DeleteServiceTokenResponse DeleteServiceToken(DeleteServiceTokenR /// /// - /// Deletes a service account token. + /// Delete service account tokens. + /// + /// + /// Delete service account tokens for a service in a specified namespace. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2048,7 +2921,10 @@ public virtual Task DeleteServiceTokenAsync(DeleteSe /// /// - /// Deletes a service account token. + /// Delete service account tokens. + /// + /// + /// Delete service account tokens for a service in a specified namespace. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2061,7 +2937,10 @@ public virtual DeleteServiceTokenResponse DeleteServiceToken(DeleteServiceTokenR /// /// - /// Deletes a service account token. + /// Delete service account tokens. + /// + /// + /// Delete service account tokens for a service in a specified namespace. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2075,7 +2954,10 @@ public virtual DeleteServiceTokenResponse DeleteServiceToken(string ns, string s /// /// - /// Deletes a service account token. + /// Delete service account tokens. + /// + /// + /// Delete service account tokens for a service in a specified namespace. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2090,7 +2972,10 @@ public virtual DeleteServiceTokenResponse DeleteServiceToken(string ns, string s /// /// - /// Deletes a service account token. + /// Delete service account tokens. + /// + /// + /// Delete service account tokens for a service in a specified namespace. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2102,7 +2987,10 @@ public virtual Task DeleteServiceTokenAsync(DeleteSe /// /// - /// Deletes a service account token. + /// Delete service account tokens. + /// + /// + /// Delete service account tokens for a service in a specified namespace. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2115,7 +3003,10 @@ public virtual Task DeleteServiceTokenAsync(string n /// /// - /// Deletes a service account token. + /// Delete service account tokens. + /// + /// + /// Delete service account tokens for a service in a specified namespace. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2129,7 +3020,10 @@ public virtual Task DeleteServiceTokenAsync(string n /// /// - /// Deletes users from the native realm. + /// Delete users. + /// + /// + /// Delete users from the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2142,7 +3036,10 @@ public virtual DeleteUserResponse DeleteUser(DeleteUserRequest request) /// /// - /// Deletes users from the native realm. + /// Delete users. + /// + /// + /// Delete users from the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2154,7 +3051,10 @@ public virtual Task DeleteUserAsync(DeleteUserRequest reques /// /// - /// Deletes users from the native realm. + /// Delete users. + /// + /// + /// Delete users from the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2167,7 +3067,10 @@ public virtual DeleteUserResponse DeleteUser(DeleteUserRequestDescriptor descrip /// /// - /// Deletes users from the native realm. + /// Delete users. + /// + /// + /// Delete users from the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2181,7 +3084,10 @@ public virtual DeleteUserResponse DeleteUser(Elastic.Clients.Elasticsearch.Usern /// /// - /// Deletes users from the native realm. + /// Delete users. + /// + /// + /// Delete users from the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2196,7 +3102,10 @@ public virtual DeleteUserResponse DeleteUser(Elastic.Clients.Elasticsearch.Usern /// /// - /// Deletes users from the native realm. + /// Delete users. + /// + /// + /// Delete users from the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2208,7 +3117,10 @@ public virtual Task DeleteUserAsync(DeleteUserRequestDescrip /// /// - /// Deletes users from the native realm. + /// Delete users. + /// + /// + /// Delete users from the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2221,7 +3133,10 @@ public virtual Task DeleteUserAsync(Elastic.Clients.Elastics /// /// - /// Deletes users from the native realm. + /// Delete users. + /// + /// + /// Delete users from the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2235,7 +3150,10 @@ public virtual Task DeleteUserAsync(Elastic.Clients.Elastics /// /// - /// Disables users in the native realm. + /// Disable users. + /// + /// + /// Disable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2248,7 +3166,10 @@ public virtual DisableUserResponse DisableUser(DisableUserRequest request) /// /// - /// Disables users in the native realm. + /// Disable users. + /// + /// + /// Disable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2260,7 +3181,10 @@ public virtual Task DisableUserAsync(DisableUserRequest req /// /// - /// Disables users in the native realm. + /// Disable users. + /// + /// + /// Disable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2273,7 +3197,10 @@ public virtual DisableUserResponse DisableUser(DisableUserRequestDescriptor desc /// /// - /// Disables users in the native realm. + /// Disable users. + /// + /// + /// Disable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2287,7 +3214,10 @@ public virtual DisableUserResponse DisableUser(Elastic.Clients.Elasticsearch.Use /// /// - /// Disables users in the native realm. + /// Disable users. + /// + /// + /// Disable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2302,7 +3232,10 @@ public virtual DisableUserResponse DisableUser(Elastic.Clients.Elasticsearch.Use /// /// - /// Disables users in the native realm. + /// Disable users. + /// + /// + /// Disable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2314,7 +3247,10 @@ public virtual Task DisableUserAsync(DisableUserRequestDesc /// /// - /// Disables users in the native realm. + /// Disable users. + /// + /// + /// Disable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2327,7 +3263,10 @@ public virtual Task DisableUserAsync(Elastic.Clients.Elasti /// /// - /// Disables users in the native realm. + /// Disable users. + /// + /// + /// Disable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2341,7 +3280,10 @@ public virtual Task DisableUserAsync(Elastic.Clients.Elasti /// /// - /// Disables a user profile so it's not visible in user profile searches. + /// Disable a user profile. + /// + /// + /// Disable user profiles so that they are not visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2354,7 +3296,10 @@ public virtual DisableUserProfileResponse DisableUserProfile(DisableUserProfileR /// /// - /// Disables a user profile so it's not visible in user profile searches. + /// Disable a user profile. + /// + /// + /// Disable user profiles so that they are not visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2366,7 +3311,10 @@ public virtual Task DisableUserProfileAsync(DisableU /// /// - /// Disables a user profile so it's not visible in user profile searches. + /// Disable a user profile. + /// + /// + /// Disable user profiles so that they are not visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2379,7 +3327,10 @@ public virtual DisableUserProfileResponse DisableUserProfile(DisableUserProfileR /// /// - /// Disables a user profile so it's not visible in user profile searches. + /// Disable a user profile. + /// + /// + /// Disable user profiles so that they are not visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2393,7 +3344,10 @@ public virtual DisableUserProfileResponse DisableUserProfile(string uid) /// /// - /// Disables a user profile so it's not visible in user profile searches. + /// Disable a user profile. + /// + /// + /// Disable user profiles so that they are not visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2408,7 +3362,10 @@ public virtual DisableUserProfileResponse DisableUserProfile(string uid, Action< /// /// - /// Disables a user profile so it's not visible in user profile searches. + /// Disable a user profile. + /// + /// + /// Disable user profiles so that they are not visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2420,7 +3377,10 @@ public virtual Task DisableUserProfileAsync(DisableU /// /// - /// Disables a user profile so it's not visible in user profile searches. + /// Disable a user profile. + /// + /// + /// Disable user profiles so that they are not visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2433,7 +3393,10 @@ public virtual Task DisableUserProfileAsync(string u /// /// - /// Disables a user profile so it's not visible in user profile searches. + /// Disable a user profile. + /// + /// + /// Disable user profiles so that they are not visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2447,7 +3410,10 @@ public virtual Task DisableUserProfileAsync(string u /// /// - /// Enables users in the native realm. + /// Enable users. + /// + /// + /// Enable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2460,7 +3426,10 @@ public virtual EnableUserResponse EnableUser(EnableUserRequest request) /// /// - /// Enables users in the native realm. + /// Enable users. + /// + /// + /// Enable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2472,7 +3441,10 @@ public virtual Task EnableUserAsync(EnableUserRequest reques /// /// - /// Enables users in the native realm. + /// Enable users. + /// + /// + /// Enable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2485,7 +3457,10 @@ public virtual EnableUserResponse EnableUser(EnableUserRequestDescriptor descrip /// /// - /// Enables users in the native realm. + /// Enable users. + /// + /// + /// Enable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2499,7 +3474,10 @@ public virtual EnableUserResponse EnableUser(Elastic.Clients.Elasticsearch.Usern /// /// - /// Enables users in the native realm. + /// Enable users. + /// + /// + /// Enable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2514,7 +3492,10 @@ public virtual EnableUserResponse EnableUser(Elastic.Clients.Elasticsearch.Usern /// /// - /// Enables users in the native realm. + /// Enable users. + /// + /// + /// Enable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2526,7 +3507,10 @@ public virtual Task EnableUserAsync(EnableUserRequestDescrip /// /// - /// Enables users in the native realm. + /// Enable users. + /// + /// + /// Enable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2539,7 +3523,10 @@ public virtual Task EnableUserAsync(Elastic.Clients.Elastics /// /// - /// Enables users in the native realm. + /// Enable users. + /// + /// + /// Enable users in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2553,7 +3540,10 @@ public virtual Task EnableUserAsync(Elastic.Clients.Elastics /// /// - /// Enables a user profile so it's visible in user profile searches. + /// Enable a user profile. + /// + /// + /// Enable user profiles to make them visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2566,7 +3556,10 @@ public virtual EnableUserProfileResponse EnableUserProfile(EnableUserProfileRequ /// /// - /// Enables a user profile so it's visible in user profile searches. + /// Enable a user profile. + /// + /// + /// Enable user profiles to make them visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2578,7 +3571,10 @@ public virtual Task EnableUserProfileAsync(EnableUser /// /// - /// Enables a user profile so it's visible in user profile searches. + /// Enable a user profile. + /// + /// + /// Enable user profiles to make them visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2591,7 +3587,10 @@ public virtual EnableUserProfileResponse EnableUserProfile(EnableUserProfileRequ /// /// - /// Enables a user profile so it's visible in user profile searches. + /// Enable a user profile. + /// + /// + /// Enable user profiles to make them visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2605,7 +3604,10 @@ public virtual EnableUserProfileResponse EnableUserProfile(string uid) /// /// - /// Enables a user profile so it's visible in user profile searches. + /// Enable a user profile. + /// + /// + /// Enable user profiles to make them visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2620,7 +3622,10 @@ public virtual EnableUserProfileResponse EnableUserProfile(string uid, Action /// - /// Enables a user profile so it's visible in user profile searches. + /// Enable a user profile. + /// + /// + /// Enable user profiles to make them visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2632,7 +3637,10 @@ public virtual Task EnableUserProfileAsync(EnableUser /// /// - /// Enables a user profile so it's visible in user profile searches. + /// Enable a user profile. + /// + /// + /// Enable user profiles to make them visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2645,7 +3653,10 @@ public virtual Task EnableUserProfileAsync(string uid /// /// - /// Enables a user profile so it's visible in user profile searches. + /// Enable a user profile. + /// + /// + /// Enable user profiles to make them visible in user profile searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2659,7 +3670,10 @@ public virtual Task EnableUserProfileAsync(string uid /// /// - /// Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. + /// Enroll Kibana. + /// + /// + /// Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2672,7 +3686,10 @@ public virtual EnrollKibanaResponse EnrollKibana(EnrollKibanaRequest request) /// /// - /// Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. + /// Enroll Kibana. + /// + /// + /// Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2684,7 +3701,10 @@ public virtual Task EnrollKibanaAsync(EnrollKibanaRequest /// /// - /// Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. + /// Enroll Kibana. + /// + /// + /// Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2697,7 +3717,10 @@ public virtual EnrollKibanaResponse EnrollKibana(EnrollKibanaRequestDescriptor d /// /// - /// Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. + /// Enroll Kibana. + /// + /// + /// Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2711,7 +3734,10 @@ public virtual EnrollKibanaResponse EnrollKibana() /// /// - /// Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. + /// Enroll Kibana. + /// + /// + /// Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2726,7 +3752,10 @@ public virtual EnrollKibanaResponse EnrollKibana(Action /// - /// Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. + /// Enroll Kibana. + /// + /// + /// Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2738,7 +3767,10 @@ public virtual Task EnrollKibanaAsync(EnrollKibanaRequestD /// /// - /// Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. + /// Enroll Kibana. + /// + /// + /// Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2751,7 +3783,10 @@ public virtual Task EnrollKibanaAsync(CancellationToken ca /// /// - /// Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. + /// Enroll Kibana. + /// + /// + /// Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2765,7 +3800,10 @@ public virtual Task EnrollKibanaAsync(Action /// - /// Allows a new node to join an existing cluster with security features enabled. + /// Enroll a node. + /// + /// + /// Enroll a new node to allow it to join an existing cluster with security features enabled. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2778,7 +3816,10 @@ public virtual EnrollNodeResponse EnrollNode(EnrollNodeRequest request) /// /// - /// Allows a new node to join an existing cluster with security features enabled. + /// Enroll a node. + /// + /// + /// Enroll a new node to allow it to join an existing cluster with security features enabled. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2790,7 +3831,10 @@ public virtual Task EnrollNodeAsync(EnrollNodeRequest reques /// /// - /// Allows a new node to join an existing cluster with security features enabled. + /// Enroll a node. + /// + /// + /// Enroll a new node to allow it to join an existing cluster with security features enabled. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2803,7 +3847,10 @@ public virtual EnrollNodeResponse EnrollNode(EnrollNodeRequestDescriptor descrip /// /// - /// Allows a new node to join an existing cluster with security features enabled. + /// Enroll a node. + /// + /// + /// Enroll a new node to allow it to join an existing cluster with security features enabled. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2817,7 +3864,10 @@ public virtual EnrollNodeResponse EnrollNode() /// /// - /// Allows a new node to join an existing cluster with security features enabled. + /// Enroll a node. + /// + /// + /// Enroll a new node to allow it to join an existing cluster with security features enabled. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2832,7 +3882,10 @@ public virtual EnrollNodeResponse EnrollNode(Action /// /// - /// Allows a new node to join an existing cluster with security features enabled. + /// Enroll a node. + /// + /// + /// Enroll a new node to allow it to join an existing cluster with security features enabled. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2844,7 +3897,10 @@ public virtual Task EnrollNodeAsync(EnrollNodeRequestDescrip /// /// - /// Allows a new node to join an existing cluster with security features enabled. + /// Enroll a node. + /// + /// + /// Enroll a new node to allow it to join an existing cluster with security features enabled. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2857,7 +3913,10 @@ public virtual Task EnrollNodeAsync(CancellationToken cancel /// /// - /// Allows a new node to join an existing cluster with security features enabled. + /// Enroll a node. + /// + /// + /// Enroll a new node to allow it to join an existing cluster with security features enabled. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2872,6 +3931,8 @@ public virtual Task EnrollNodeAsync(Action /// /// Get API key information. + /// + /// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -2888,6 +3949,8 @@ public virtual GetApiKeyResponse GetApiKey(GetApiKeyRequest request) /// /// /// Get API key information. + /// + /// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -2903,6 +3966,8 @@ public virtual Task GetApiKeyAsync(GetApiKeyRequest request, /// /// /// Get API key information. + /// + /// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -2919,6 +3984,8 @@ public virtual GetApiKeyResponse GetApiKey(GetApiKeyRequestDescriptor descriptor /// /// /// Get API key information. + /// + /// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -2936,6 +4003,8 @@ public virtual GetApiKeyResponse GetApiKey() /// /// /// Get API key information. + /// + /// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -2954,6 +4023,8 @@ public virtual GetApiKeyResponse GetApiKey(Action co /// /// /// Get API key information. + /// + /// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -2969,6 +4040,8 @@ public virtual Task GetApiKeyAsync(GetApiKeyRequestDescriptor /// /// /// Get API key information. + /// + /// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -2985,6 +4058,8 @@ public virtual Task GetApiKeyAsync(CancellationToken cancella /// /// /// Get API key information. + /// + /// /// Retrieves information for one or more API keys. /// NOTE: If you have only the manage_own_api_key privilege, this API returns only the API keys that you own. /// If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership. @@ -3001,7 +4076,10 @@ public virtual Task GetApiKeyAsync(Action /// - /// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + /// Get builtin privileges. + /// + /// + /// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3014,7 +4092,10 @@ public virtual GetBuiltinPrivilegesResponse GetBuiltinPrivileges(GetBuiltinPrivi /// /// - /// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + /// Get builtin privileges. + /// + /// + /// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3026,7 +4107,10 @@ public virtual Task GetBuiltinPrivilegesAsync(GetB /// /// - /// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + /// Get builtin privileges. + /// + /// + /// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3039,7 +4123,10 @@ public virtual GetBuiltinPrivilegesResponse GetBuiltinPrivileges(GetBuiltinPrivi /// /// - /// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + /// Get builtin privileges. + /// + /// + /// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3053,7 +4140,10 @@ public virtual GetBuiltinPrivilegesResponse GetBuiltinPrivileges() /// /// - /// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + /// Get builtin privileges. + /// + /// + /// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3068,7 +4158,10 @@ public virtual GetBuiltinPrivilegesResponse GetBuiltinPrivileges(Action /// - /// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + /// Get builtin privileges. + /// + /// + /// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3080,7 +4173,10 @@ public virtual Task GetBuiltinPrivilegesAsync(GetB /// /// - /// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + /// Get builtin privileges. + /// + /// + /// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3093,7 +4189,10 @@ public virtual Task GetBuiltinPrivilegesAsync(Canc /// /// - /// Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + /// Get builtin privileges. + /// + /// + /// Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3107,7 +4206,7 @@ public virtual Task GetBuiltinPrivilegesAsync(Acti /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3120,7 +4219,7 @@ public virtual GetPrivilegesResponse GetPrivileges(GetPrivilegesRequest request) /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3132,7 +4231,7 @@ public virtual Task GetPrivilegesAsync(GetPrivilegesReque /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3145,7 +4244,7 @@ public virtual GetPrivilegesResponse GetPrivileges(GetPrivilegesRequestDescripto /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3159,7 +4258,7 @@ public virtual GetPrivilegesResponse GetPrivileges(Elastic.Clients.Elasticsearch /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3174,7 +4273,7 @@ public virtual GetPrivilegesResponse GetPrivileges(Elastic.Clients.Elasticsearch /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3188,7 +4287,7 @@ public virtual GetPrivilegesResponse GetPrivileges() /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3203,7 +4302,7 @@ public virtual GetPrivilegesResponse GetPrivileges(Action /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3215,7 +4314,7 @@ public virtual Task GetPrivilegesAsync(GetPrivilegesReque /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3228,7 +4327,7 @@ public virtual Task GetPrivilegesAsync(Elastic.Clients.El /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3242,7 +4341,7 @@ public virtual Task GetPrivilegesAsync(Elastic.Clients.El /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3255,7 +4354,7 @@ public virtual Task GetPrivilegesAsync(CancellationToken /// /// - /// Retrieves application privileges. + /// Get application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3269,8 +4368,10 @@ public virtual Task GetPrivilegesAsync(Action /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3283,8 +4384,10 @@ public virtual GetRoleResponse GetRole(GetRoleRequest request) /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3296,8 +4399,10 @@ public virtual Task GetRoleAsync(GetRoleRequest request, Cancel /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3310,8 +4415,10 @@ public virtual GetRoleResponse GetRole(GetRoleRequestDescriptor descriptor) /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3325,8 +4432,10 @@ public virtual GetRoleResponse GetRole(Elastic.Clients.Elasticsearch.Names? name /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3341,8 +4450,10 @@ public virtual GetRoleResponse GetRole(Elastic.Clients.Elasticsearch.Names? name /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3356,8 +4467,10 @@ public virtual GetRoleResponse GetRole() /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3372,8 +4485,10 @@ public virtual GetRoleResponse GetRole(Action configur /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3385,8 +4500,10 @@ public virtual Task GetRoleAsync(GetRoleRequestDescriptor descr /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3399,8 +4516,10 @@ public virtual Task GetRoleAsync(Elastic.Clients.Elasticsearch. /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3414,8 +4533,10 @@ public virtual Task GetRoleAsync(Elastic.Clients.Elasticsearch. /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3428,8 +4549,10 @@ public virtual Task GetRoleAsync(CancellationToken cancellation /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. - /// The get roles API cannot retrieve roles that are defined in roles files. + /// Get roles. + /// + /// + /// Get roles in the native realm. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3443,7 +4566,12 @@ public virtual Task GetRoleAsync(Action /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3456,7 +4584,12 @@ public virtual GetRoleMappingResponse GetRoleMapping(GetRoleMappingRequest reque /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3468,7 +4601,12 @@ public virtual Task GetRoleMappingAsync(GetRoleMappingRe /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3481,7 +4619,12 @@ public virtual GetRoleMappingResponse GetRoleMapping(GetRoleMappingRequestDescri /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3495,7 +4638,12 @@ public virtual GetRoleMappingResponse GetRoleMapping(Elastic.Clients.Elasticsear /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3510,7 +4658,12 @@ public virtual GetRoleMappingResponse GetRoleMapping(Elastic.Clients.Elasticsear /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3524,7 +4677,12 @@ public virtual GetRoleMappingResponse GetRoleMapping() /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3539,7 +4697,12 @@ public virtual GetRoleMappingResponse GetRoleMapping(Action /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3551,7 +4714,12 @@ public virtual Task GetRoleMappingAsync(GetRoleMappingRe /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3564,7 +4732,12 @@ public virtual Task GetRoleMappingAsync(Elastic.Clients. /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3578,7 +4751,12 @@ public virtual Task GetRoleMappingAsync(Elastic.Clients. /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3591,7 +4769,12 @@ public virtual Task GetRoleMappingAsync(CancellationToke /// /// - /// Retrieves role mappings. + /// Get role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + /// The get role mappings API cannot retrieve role mappings that are defined in role mapping files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3605,7 +4788,10 @@ public virtual Task GetRoleMappingAsync(Action /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3618,7 +4804,10 @@ public virtual GetServiceAccountsResponse GetServiceAccounts(GetServiceAccountsR /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3630,7 +4819,10 @@ public virtual Task GetServiceAccountsAsync(GetServi /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3643,7 +4835,10 @@ public virtual GetServiceAccountsResponse GetServiceAccounts(GetServiceAccountsR /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3657,7 +4852,10 @@ public virtual GetServiceAccountsResponse GetServiceAccounts(string? ns, string? /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3672,7 +4870,10 @@ public virtual GetServiceAccountsResponse GetServiceAccounts(string? ns, string? /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3686,7 +4887,10 @@ public virtual GetServiceAccountsResponse GetServiceAccounts() /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3701,7 +4905,10 @@ public virtual GetServiceAccountsResponse GetServiceAccounts(Action /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3713,7 +4920,10 @@ public virtual Task GetServiceAccountsAsync(GetServi /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3726,7 +4936,10 @@ public virtual Task GetServiceAccountsAsync(string? /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3740,7 +4953,10 @@ public virtual Task GetServiceAccountsAsync(string? /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3753,7 +4969,10 @@ public virtual Task GetServiceAccountsAsync(Cancella /// /// - /// This API returns a list of service accounts that match the provided path parameter(s). + /// Get service accounts. + /// + /// + /// Get a list of service accounts that match the provided path parameters. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3767,7 +4986,7 @@ public virtual Task GetServiceAccountsAsync(Action /// - /// Retrieves information of all service credentials for a service account. + /// Get service account credentials. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3780,7 +4999,7 @@ public virtual GetServiceCredentialsResponse GetServiceCredentials(GetServiceCre /// /// - /// Retrieves information of all service credentials for a service account. + /// Get service account credentials. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3792,7 +5011,7 @@ public virtual Task GetServiceCredentialsAsync(Ge /// /// - /// Retrieves information of all service credentials for a service account. + /// Get service account credentials. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3805,7 +5024,7 @@ public virtual GetServiceCredentialsResponse GetServiceCredentials(GetServiceCre /// /// - /// Retrieves information of all service credentials for a service account. + /// Get service account credentials. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3819,7 +5038,7 @@ public virtual GetServiceCredentialsResponse GetServiceCredentials(string ns, El /// /// - /// Retrieves information of all service credentials for a service account. + /// Get service account credentials. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3834,7 +5053,7 @@ public virtual GetServiceCredentialsResponse GetServiceCredentials(string ns, El /// /// - /// Retrieves information of all service credentials for a service account. + /// Get service account credentials. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3846,7 +5065,7 @@ public virtual Task GetServiceCredentialsAsync(Ge /// /// - /// Retrieves information of all service credentials for a service account. + /// Get service account credentials. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3859,7 +5078,7 @@ public virtual Task GetServiceCredentialsAsync(st /// /// - /// Retrieves information of all service credentials for a service account. + /// Get service account credentials. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3873,7 +5092,10 @@ public virtual Task GetServiceCredentialsAsync(st /// /// - /// Creates a bearer token for access without requiring basic authentication. + /// Get a token. + /// + /// + /// Create a bearer token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3886,7 +5108,10 @@ public virtual GetTokenResponse GetToken(GetTokenRequest request) /// /// - /// Creates a bearer token for access without requiring basic authentication. + /// Get a token. + /// + /// + /// Create a bearer token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3898,7 +5123,10 @@ public virtual Task GetTokenAsync(GetTokenRequest request, Can /// /// - /// Creates a bearer token for access without requiring basic authentication. + /// Get a token. + /// + /// + /// Create a bearer token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3911,7 +5139,10 @@ public virtual GetTokenResponse GetToken(GetTokenRequestDescriptor descriptor) /// /// - /// Creates a bearer token for access without requiring basic authentication. + /// Get a token. + /// + /// + /// Create a bearer token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3925,7 +5156,10 @@ public virtual GetTokenResponse GetToken() /// /// - /// Creates a bearer token for access without requiring basic authentication. + /// Get a token. + /// + /// + /// Create a bearer token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3940,7 +5174,10 @@ public virtual GetTokenResponse GetToken(Action confi /// /// - /// Creates a bearer token for access without requiring basic authentication. + /// Get a token. + /// + /// + /// Create a bearer token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3952,7 +5189,10 @@ public virtual Task GetTokenAsync(GetTokenRequestDescriptor de /// /// - /// Creates a bearer token for access without requiring basic authentication. + /// Get a token. + /// + /// + /// Create a bearer token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3965,7 +5205,10 @@ public virtual Task GetTokenAsync(CancellationToken cancellati /// /// - /// Creates a bearer token for access without requiring basic authentication. + /// Get a token. + /// + /// + /// Create a bearer token for access without requiring basic authentication. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3979,7 +5222,10 @@ public virtual Task GetTokenAsync(Action /// - /// Retrieves information about users in the native realm and built-in users. + /// Get users. + /// + /// + /// Get information about users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3992,7 +5238,10 @@ public virtual GetUserResponse GetUser(GetUserRequest request) /// /// - /// Retrieves information about users in the native realm and built-in users. + /// Get users. + /// + /// + /// Get information about users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4004,7 +5253,10 @@ public virtual Task GetUserAsync(GetUserRequest request, Cancel /// /// - /// Retrieves information about users in the native realm and built-in users. + /// Get users. + /// + /// + /// Get information about users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4017,7 +5269,10 @@ public virtual GetUserResponse GetUser(GetUserRequestDescriptor descriptor) /// /// - /// Retrieves information about users in the native realm and built-in users. + /// Get users. + /// + /// + /// Get information about users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4031,7 +5286,10 @@ public virtual GetUserResponse GetUser(IReadOnlyCollection /// - /// Retrieves information about users in the native realm and built-in users. + /// Get users. + /// + /// + /// Get information about users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4046,7 +5304,10 @@ public virtual GetUserResponse GetUser(IReadOnlyCollection /// - /// Retrieves information about users in the native realm and built-in users. + /// Get users. + /// + /// + /// Get information about users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4060,7 +5321,10 @@ public virtual GetUserResponse GetUser() /// /// - /// Retrieves information about users in the native realm and built-in users. + /// Get users. + /// + /// + /// Get information about users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4075,7 +5339,10 @@ public virtual GetUserResponse GetUser(Action configur /// /// - /// Retrieves information about users in the native realm and built-in users. + /// Get users. + /// + /// + /// Get information about users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4087,7 +5354,10 @@ public virtual Task GetUserAsync(GetUserRequestDescriptor descr /// /// - /// Retrieves information about users in the native realm and built-in users. + /// Get users. + /// + /// + /// Get information about users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4100,7 +5370,10 @@ public virtual Task GetUserAsync(IReadOnlyCollection /// - /// Retrieves information about users in the native realm and built-in users. + /// Get users. + /// + /// + /// Get information about users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4114,7 +5387,10 @@ public virtual Task GetUserAsync(IReadOnlyCollection /// - /// Retrieves information about users in the native realm and built-in users. + /// Get users. + /// + /// + /// Get information about users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4127,7 +5403,10 @@ public virtual Task GetUserAsync(CancellationToken cancellation /// /// - /// Retrieves information about users in the native realm and built-in users. + /// Get users. + /// + /// + /// Get information about users in the native realm and built-in users. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4141,7 +5420,7 @@ public virtual Task GetUserAsync(Action /// - /// Retrieves security privileges for the logged in user. + /// Get user privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4154,7 +5433,7 @@ public virtual GetUserPrivilegesResponse GetUserPrivileges(GetUserPrivilegesRequ /// /// - /// Retrieves security privileges for the logged in user. + /// Get user privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4166,7 +5445,7 @@ public virtual Task GetUserPrivilegesAsync(GetUserPri /// /// - /// Retrieves security privileges for the logged in user. + /// Get user privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4179,7 +5458,7 @@ public virtual GetUserPrivilegesResponse GetUserPrivileges(GetUserPrivilegesRequ /// /// - /// Retrieves security privileges for the logged in user. + /// Get user privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4193,7 +5472,7 @@ public virtual GetUserPrivilegesResponse GetUserPrivileges() /// /// - /// Retrieves security privileges for the logged in user. + /// Get user privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4208,7 +5487,7 @@ public virtual GetUserPrivilegesResponse GetUserPrivileges(Action /// - /// Retrieves security privileges for the logged in user. + /// Get user privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4220,7 +5499,7 @@ public virtual Task GetUserPrivilegesAsync(GetUserPri /// /// - /// Retrieves security privileges for the logged in user. + /// Get user privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4233,7 +5512,7 @@ public virtual Task GetUserPrivilegesAsync(Cancellati /// /// - /// Retrieves security privileges for the logged in user. + /// Get user privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4247,7 +5526,10 @@ public virtual Task GetUserPrivilegesAsync(Action /// - /// Retrieves a user's profile using the unique profile ID. + /// Get a user profile. + /// + /// + /// Get a user's profile using the unique profile ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4260,7 +5542,10 @@ public virtual GetUserProfileResponse GetUserProfile(GetUserProfileRequest reque /// /// - /// Retrieves a user's profile using the unique profile ID. + /// Get a user profile. + /// + /// + /// Get a user's profile using the unique profile ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4272,7 +5557,10 @@ public virtual Task GetUserProfileAsync(GetUserProfileRe /// /// - /// Retrieves a user's profile using the unique profile ID. + /// Get a user profile. + /// + /// + /// Get a user's profile using the unique profile ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4285,7 +5573,10 @@ public virtual GetUserProfileResponse GetUserProfile(GetUserProfileRequestDescri /// /// - /// Retrieves a user's profile using the unique profile ID. + /// Get a user profile. + /// + /// + /// Get a user's profile using the unique profile ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4299,7 +5590,10 @@ public virtual GetUserProfileResponse GetUserProfile(IReadOnlyCollection /// /// - /// Retrieves a user's profile using the unique profile ID. + /// Get a user profile. + /// + /// + /// Get a user's profile using the unique profile ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4314,7 +5608,10 @@ public virtual GetUserProfileResponse GetUserProfile(IReadOnlyCollection /// /// - /// Retrieves a user's profile using the unique profile ID. + /// Get a user profile. + /// + /// + /// Get a user's profile using the unique profile ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4326,7 +5623,10 @@ public virtual Task GetUserProfileAsync(GetUserProfileRe /// /// - /// Retrieves a user's profile using the unique profile ID. + /// Get a user profile. + /// + /// + /// Get a user's profile using the unique profile ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4339,7 +5639,10 @@ public virtual Task GetUserProfileAsync(IReadOnlyCollect /// /// - /// Retrieves a user's profile using the unique profile ID. + /// Get a user profile. + /// + /// + /// Get a user's profile using the unique profile ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4353,8 +5656,11 @@ public virtual Task GetUserProfileAsync(IReadOnlyCollect /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4381,8 +5687,11 @@ public virtual GrantApiKeyResponse GrantApiKey(GrantApiKeyRequest request) /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4408,8 +5717,11 @@ public virtual Task GrantApiKeyAsync(GrantApiKeyRequest req /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4436,8 +5748,11 @@ public virtual GrantApiKeyResponse GrantApiKey(GrantApiKeyRequestDesc /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4465,8 +5780,11 @@ public virtual GrantApiKeyResponse GrantApiKey() /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4495,8 +5813,11 @@ public virtual GrantApiKeyResponse GrantApiKey(Action /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4523,8 +5844,11 @@ public virtual GrantApiKeyResponse GrantApiKey(GrantApiKeyRequestDescriptor desc /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4552,8 +5876,11 @@ public virtual GrantApiKeyResponse GrantApiKey() /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4582,8 +5909,11 @@ public virtual GrantApiKeyResponse GrantApiKey(Action /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4609,8 +5939,11 @@ public virtual Task GrantApiKeyAsync(GrantApiKey /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4637,8 +5970,11 @@ public virtual Task GrantApiKeyAsync(Cancellatio /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4666,8 +6002,11 @@ public virtual Task GrantApiKeyAsync(Action /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4693,8 +6032,11 @@ public virtual Task GrantApiKeyAsync(GrantApiKeyRequestDesc /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4721,8 +6063,11 @@ public virtual Task GrantApiKeyAsync(CancellationToken canc /// /// - /// Creates an API key on behalf of another user. - /// This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + /// Grant an API key. + /// + /// + /// Create an API key on behalf of another user. + /// This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. /// The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. /// It is not possible to use this API to create an API key without that user’s credentials. /// The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. @@ -4751,7 +6096,9 @@ public virtual Task GrantApiKeyAsync(Action /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4765,7 +6112,9 @@ public virtual HasPrivilegesResponse HasPrivileges(HasPrivilegesRequest request) /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4778,7 +6127,9 @@ public virtual Task HasPrivilegesAsync(HasPrivilegesReque /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4792,7 +6143,9 @@ public virtual HasPrivilegesResponse HasPrivileges(HasPrivilegesRequestDescripto /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4807,7 +6160,9 @@ public virtual HasPrivilegesResponse HasPrivileges(Elastic.Clients.Elasticsearch /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4823,7 +6178,9 @@ public virtual HasPrivilegesResponse HasPrivileges(Elastic.Clients.Elasticsearch /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4838,7 +6195,9 @@ public virtual HasPrivilegesResponse HasPrivileges() /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4854,7 +6213,9 @@ public virtual HasPrivilegesResponse HasPrivileges(Action /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4867,7 +6228,9 @@ public virtual Task HasPrivilegesAsync(HasPrivilegesReque /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4881,7 +6244,9 @@ public virtual Task HasPrivilegesAsync(Elastic.Clients.El /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4896,7 +6261,9 @@ public virtual Task HasPrivilegesAsync(Elastic.Clients.El /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4910,7 +6277,9 @@ public virtual Task HasPrivilegesAsync(CancellationToken /// /// /// Check user privileges. - /// Determines whether the specified user has a specified list of privileges. + /// + /// + /// Determine whether the specified user has a specified list of privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4924,7 +6293,10 @@ public virtual Task HasPrivilegesAsync(Action /// - /// Determines whether the users associated with the specified profile IDs have all the requested privileges. + /// Check user profile privileges. + /// + /// + /// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4937,7 +6309,10 @@ public virtual HasPrivilegesUserProfileResponse HasPrivilegesUserProfile(HasPriv /// /// - /// Determines whether the users associated with the specified profile IDs have all the requested privileges. + /// Check user profile privileges. + /// + /// + /// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4949,7 +6324,10 @@ public virtual Task HasPrivilegesUserProfileAs /// /// - /// Determines whether the users associated with the specified profile IDs have all the requested privileges. + /// Check user profile privileges. + /// + /// + /// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4962,7 +6340,10 @@ public virtual HasPrivilegesUserProfileResponse HasPrivilegesUserProfile(HasPriv /// /// - /// Determines whether the users associated with the specified profile IDs have all the requested privileges. + /// Check user profile privileges. + /// + /// + /// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4976,7 +6357,10 @@ public virtual HasPrivilegesUserProfileResponse HasPrivilegesUserProfile() /// /// - /// Determines whether the users associated with the specified profile IDs have all the requested privileges. + /// Check user profile privileges. + /// + /// + /// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4991,7 +6375,10 @@ public virtual HasPrivilegesUserProfileResponse HasPrivilegesUserProfile(Action< /// /// - /// Determines whether the users associated with the specified profile IDs have all the requested privileges. + /// Check user profile privileges. + /// + /// + /// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5003,7 +6390,10 @@ public virtual Task HasPrivilegesUserProfileAs /// /// - /// Determines whether the users associated with the specified profile IDs have all the requested privileges. + /// Check user profile privileges. + /// + /// + /// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5016,7 +6406,10 @@ public virtual Task HasPrivilegesUserProfileAs /// /// - /// Determines whether the users associated with the specified profile IDs have all the requested privileges. + /// Check user profile privileges. + /// + /// + /// Determine whether the users associated with the specified user profile IDs have all the requested privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5031,7 +6424,10 @@ public virtual Task HasPrivilegesUserProfileAs /// /// /// Invalidate API keys. - /// Invalidates one or more API keys. + /// + /// + /// This API invalidates API keys created by the create API key or grant API key APIs. + /// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -5049,7 +6445,7 @@ public virtual Task HasPrivilegesUserProfileAs /// /// /// - /// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. + /// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -5065,7 +6461,10 @@ public virtual InvalidateApiKeyResponse InvalidateApiKey(InvalidateApiKeyRequest /// /// /// Invalidate API keys. - /// Invalidates one or more API keys. + /// + /// + /// This API invalidates API keys created by the create API key or grant API key APIs. + /// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -5083,7 +6482,7 @@ public virtual InvalidateApiKeyResponse InvalidateApiKey(InvalidateApiKeyRequest /// /// /// - /// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. + /// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -5098,7 +6497,10 @@ public virtual Task InvalidateApiKeyAsync(InvalidateAp /// /// /// Invalidate API keys. - /// Invalidates one or more API keys. + /// + /// + /// This API invalidates API keys created by the create API key or grant API key APIs. + /// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -5116,7 +6518,7 @@ public virtual Task InvalidateApiKeyAsync(InvalidateAp /// /// /// - /// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. + /// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -5132,7 +6534,10 @@ public virtual InvalidateApiKeyResponse InvalidateApiKey(InvalidateApiKeyRequest /// /// /// Invalidate API keys. - /// Invalidates one or more API keys. + /// + /// + /// This API invalidates API keys created by the create API key or grant API key APIs. + /// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -5150,7 +6555,7 @@ public virtual InvalidateApiKeyResponse InvalidateApiKey(InvalidateApiKeyRequest /// /// /// - /// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. + /// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -5166,8 +6571,11 @@ public virtual InvalidateApiKeyResponse InvalidateApiKey() /// /// - /// Invalidate API keys. - /// Invalidates one or more API keys. + /// Invalidate API keys. + /// + /// + /// This API invalidates API keys created by the create API key or grant API key APIs. + /// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -5185,7 +6593,7 @@ public virtual InvalidateApiKeyResponse InvalidateApiKey() /// /// /// - /// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. + /// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -5203,7 +6611,10 @@ public virtual InvalidateApiKeyResponse InvalidateApiKey(Action /// /// Invalidate API keys. - /// Invalidates one or more API keys. + /// + /// + /// This API invalidates API keys created by the create API key or grant API key APIs. + /// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -5221,7 +6632,7 @@ public virtual InvalidateApiKeyResponse InvalidateApiKey(Action /// /// - /// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. + /// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -5236,7 +6647,10 @@ public virtual Task InvalidateApiKeyAsync(InvalidateAp /// /// /// Invalidate API keys. - /// Invalidates one or more API keys. + /// + /// + /// This API invalidates API keys created by the create API key or grant API key APIs. + /// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -5254,7 +6668,7 @@ public virtual Task InvalidateApiKeyAsync(InvalidateAp /// /// /// - /// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. + /// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -5270,7 +6684,10 @@ public virtual Task InvalidateApiKeyAsync(Cancellation /// /// /// Invalidate API keys. - /// Invalidates one or more API keys. + /// + /// + /// This API invalidates API keys created by the create API key or grant API key APIs. + /// Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. /// The manage_api_key privilege allows deleting any API keys. /// The manage_own_api_key only allows deleting API keys that are owned by the user. /// In addition, with the manage_own_api_key privilege, an invalidation request must be issued in one of the three formats: @@ -5288,7 +6705,7 @@ public virtual Task InvalidateApiKeyAsync(Cancellation /// /// /// - /// Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the ids field. + /// Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the ids field. /// /// /// @@ -5304,7 +6721,16 @@ public virtual Task InvalidateApiKeyAsync(Action /// - /// Invalidates one or more access tokens or refresh tokens. + /// Invalidate a token. + /// + /// + /// The access tokens returned by the get token API have a finite period of time for which they are valid. + /// After that time period, they can no longer be used. + /// The time period is defined by the xpack.security.authc.token.timeout setting. + /// + /// + /// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. + /// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5317,7 +6743,16 @@ public virtual InvalidateTokenResponse InvalidateToken(InvalidateTokenRequest re /// /// - /// Invalidates one or more access tokens or refresh tokens. + /// Invalidate a token. + /// + /// + /// The access tokens returned by the get token API have a finite period of time for which they are valid. + /// After that time period, they can no longer be used. + /// The time period is defined by the xpack.security.authc.token.timeout setting. + /// + /// + /// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. + /// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5329,7 +6764,16 @@ public virtual Task InvalidateTokenAsync(InvalidateToke /// /// - /// Invalidates one or more access tokens or refresh tokens. + /// Invalidate a token. + /// + /// + /// The access tokens returned by the get token API have a finite period of time for which they are valid. + /// After that time period, they can no longer be used. + /// The time period is defined by the xpack.security.authc.token.timeout setting. + /// + /// + /// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. + /// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5342,7 +6786,16 @@ public virtual InvalidateTokenResponse InvalidateToken(InvalidateTokenRequestDes /// /// - /// Invalidates one or more access tokens or refresh tokens. + /// Invalidate a token. + /// + /// + /// The access tokens returned by the get token API have a finite period of time for which they are valid. + /// After that time period, they can no longer be used. + /// The time period is defined by the xpack.security.authc.token.timeout setting. + /// + /// + /// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. + /// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5356,7 +6809,16 @@ public virtual InvalidateTokenResponse InvalidateToken() /// /// - /// Invalidates one or more access tokens or refresh tokens. + /// Invalidate a token. + /// + /// + /// The access tokens returned by the get token API have a finite period of time for which they are valid. + /// After that time period, they can no longer be used. + /// The time period is defined by the xpack.security.authc.token.timeout setting. + /// + /// + /// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. + /// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5371,7 +6833,16 @@ public virtual InvalidateTokenResponse InvalidateToken(Action /// - /// Invalidates one or more access tokens or refresh tokens. + /// Invalidate a token. + /// + /// + /// The access tokens returned by the get token API have a finite period of time for which they are valid. + /// After that time period, they can no longer be used. + /// The time period is defined by the xpack.security.authc.token.timeout setting. + /// + /// + /// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. + /// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5383,7 +6854,16 @@ public virtual Task InvalidateTokenAsync(InvalidateToke /// /// - /// Invalidates one or more access tokens or refresh tokens. + /// Invalidate a token. + /// + /// + /// The access tokens returned by the get token API have a finite period of time for which they are valid. + /// After that time period, they can no longer be used. + /// The time period is defined by the xpack.security.authc.token.timeout setting. + /// + /// + /// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. + /// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5396,7 +6876,16 @@ public virtual Task InvalidateTokenAsync(CancellationTo /// /// - /// Invalidates one or more access tokens or refresh tokens. + /// Invalidate a token. + /// + /// + /// The access tokens returned by the get token API have a finite period of time for which they are valid. + /// After that time period, they can no longer be used. + /// The time period is defined by the xpack.security.authc.token.timeout setting. + /// + /// + /// The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. + /// If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5410,7 +6899,7 @@ public virtual Task InvalidateTokenAsync(Action /// - /// Adds or updates application privileges. + /// Create or update application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5423,7 +6912,7 @@ public virtual PutPrivilegesResponse PutPrivileges(PutPrivilegesRequest request) /// /// - /// Adds or updates application privileges. + /// Create or update application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5435,7 +6924,7 @@ public virtual Task PutPrivilegesAsync(PutPrivilegesReque /// /// - /// Adds or updates application privileges. + /// Create or update application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5448,7 +6937,7 @@ public virtual PutPrivilegesResponse PutPrivileges(PutPrivilegesRequestDescripto /// /// - /// Adds or updates application privileges. + /// Create or update application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5462,7 +6951,7 @@ public virtual PutPrivilegesResponse PutPrivileges() /// /// - /// Adds or updates application privileges. + /// Create or update application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5477,7 +6966,7 @@ public virtual PutPrivilegesResponse PutPrivileges(Action /// - /// Adds or updates application privileges. + /// Create or update application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5489,7 +6978,7 @@ public virtual Task PutPrivilegesAsync(PutPrivilegesReque /// /// - /// Adds or updates application privileges. + /// Create or update application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5502,7 +6991,7 @@ public virtual Task PutPrivilegesAsync(CancellationToken /// /// - /// Adds or updates application privileges. + /// Create or update application privileges. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5516,8 +7005,12 @@ public virtual Task PutPrivilegesAsync(Action /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5530,8 +7023,12 @@ public virtual PutRoleResponse PutRole(PutRoleRequest request) /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5543,8 +7040,12 @@ public virtual Task PutRoleAsync(PutRoleRequest request, Cancel /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5557,8 +7058,12 @@ public virtual PutRoleResponse PutRole(PutRoleRequestDescriptor /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5572,8 +7077,12 @@ public virtual PutRoleResponse PutRole(Elastic.Clients.Elasticsearch. /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5588,8 +7097,12 @@ public virtual PutRoleResponse PutRole(Elastic.Clients.Elasticsearch. /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5602,8 +7115,12 @@ public virtual PutRoleResponse PutRole(PutRoleRequestDescriptor descriptor) /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5617,8 +7134,12 @@ public virtual PutRoleResponse PutRole(Elastic.Clients.Elasticsearch.Name name) /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5633,8 +7154,12 @@ public virtual PutRoleResponse PutRole(Elastic.Clients.Elasticsearch.Name name, /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5646,8 +7171,12 @@ public virtual Task PutRoleAsync(PutRoleRequestDescr /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5660,8 +7189,12 @@ public virtual Task PutRoleAsync(Elastic.Clients.Ela /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5675,8 +7208,12 @@ public virtual Task PutRoleAsync(Elastic.Clients.Ela /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5688,8 +7225,12 @@ public virtual Task PutRoleAsync(PutRoleRequestDescriptor descr /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5702,8 +7243,12 @@ public virtual Task PutRoleAsync(Elastic.Clients.Elasticsearch. /// /// - /// The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + /// Create or update roles. + /// + /// + /// The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. /// The create or update roles API cannot update roles that are defined in roles files. + /// File-based role management is not available in Elastic Serverless. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5717,7 +7262,16 @@ public virtual Task PutRoleAsync(Elastic.Clients.Elasticsearch. /// /// - /// Creates and updates role mappings. + /// Create or update role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// Each mapping has rules that identify users and a list of roles that are granted to those users. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + /// + /// + /// This API does not create roles. Rather, it maps users to existing roles. + /// Roles can be created by using the create or update roles API or roles files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5730,7 +7284,16 @@ public virtual PutRoleMappingResponse PutRoleMapping(PutRoleMappingRequest reque /// /// - /// Creates and updates role mappings. + /// Create or update role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// Each mapping has rules that identify users and a list of roles that are granted to those users. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + /// + /// + /// This API does not create roles. Rather, it maps users to existing roles. + /// Roles can be created by using the create or update roles API or roles files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5742,7 +7305,16 @@ public virtual Task PutRoleMappingAsync(PutRoleMappingRe /// /// - /// Creates and updates role mappings. + /// Create or update role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// Each mapping has rules that identify users and a list of roles that are granted to those users. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + /// + /// + /// This API does not create roles. Rather, it maps users to existing roles. + /// Roles can be created by using the create or update roles API or roles files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5755,7 +7327,16 @@ public virtual PutRoleMappingResponse PutRoleMapping(PutRoleMappingRequestDescri /// /// - /// Creates and updates role mappings. + /// Create or update role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// Each mapping has rules that identify users and a list of roles that are granted to those users. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + /// + /// + /// This API does not create roles. Rather, it maps users to existing roles. + /// Roles can be created by using the create or update roles API or roles files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5769,7 +7350,16 @@ public virtual PutRoleMappingResponse PutRoleMapping(Elastic.Clients.Elasticsear /// /// - /// Creates and updates role mappings. + /// Create or update role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// Each mapping has rules that identify users and a list of roles that are granted to those users. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + /// + /// + /// This API does not create roles. Rather, it maps users to existing roles. + /// Roles can be created by using the create or update roles API or roles files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5784,7 +7374,16 @@ public virtual PutRoleMappingResponse PutRoleMapping(Elastic.Clients.Elasticsear /// /// - /// Creates and updates role mappings. + /// Create or update role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// Each mapping has rules that identify users and a list of roles that are granted to those users. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + /// + /// + /// This API does not create roles. Rather, it maps users to existing roles. + /// Roles can be created by using the create or update roles API or roles files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5796,7 +7395,16 @@ public virtual Task PutRoleMappingAsync(PutRoleMappingRe /// /// - /// Creates and updates role mappings. + /// Create or update role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// Each mapping has rules that identify users and a list of roles that are granted to those users. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + /// + /// + /// This API does not create roles. Rather, it maps users to existing roles. + /// Roles can be created by using the create or update roles API or roles files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5809,7 +7417,16 @@ public virtual Task PutRoleMappingAsync(Elastic.Clients. /// /// - /// Creates and updates role mappings. + /// Create or update role mappings. + /// + /// + /// Role mappings define which roles are assigned to each user. + /// Each mapping has rules that identify users and a list of roles that are granted to those users. + /// The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + /// + /// + /// This API does not create roles. Rather, it maps users to existing roles. + /// Roles can be created by using the create or update roles API or roles files. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5823,7 +7440,11 @@ public virtual Task PutRoleMappingAsync(Elastic.Clients. /// /// - /// Adds and updates users in the native realm. These users are commonly referred to as native users. + /// Create or update users. + /// + /// + /// A password is required for adding a new user but is optional when updating an existing user. + /// To change a user’s password without updating any other fields, use the change password API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5836,7 +7457,11 @@ public virtual PutUserResponse PutUser(PutUserRequest request) /// /// - /// Adds and updates users in the native realm. These users are commonly referred to as native users. + /// Create or update users. + /// + /// + /// A password is required for adding a new user but is optional when updating an existing user. + /// To change a user’s password without updating any other fields, use the change password API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5848,7 +7473,11 @@ public virtual Task PutUserAsync(PutUserRequest request, Cancel /// /// - /// Adds and updates users in the native realm. These users are commonly referred to as native users. + /// Create or update users. + /// + /// + /// A password is required for adding a new user but is optional when updating an existing user. + /// To change a user’s password without updating any other fields, use the change password API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5861,7 +7490,11 @@ public virtual PutUserResponse PutUser(PutUserRequestDescriptor descriptor) /// /// - /// Adds and updates users in the native realm. These users are commonly referred to as native users. + /// Create or update users. + /// + /// + /// A password is required for adding a new user but is optional when updating an existing user. + /// To change a user’s password without updating any other fields, use the change password API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5873,8 +7506,10 @@ public virtual Task PutUserAsync(PutUserRequestDescriptor descr /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5887,8 +7522,10 @@ public virtual QueryApiKeysResponse QueryApiKeys(QueryApiKeysRequest request) /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5900,8 +7537,10 @@ public virtual Task QueryApiKeysAsync(QueryApiKeysRequest /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5914,8 +7553,10 @@ public virtual QueryApiKeysResponse QueryApiKeys(QueryApiKeysRequestD /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5929,8 +7570,10 @@ public virtual QueryApiKeysResponse QueryApiKeys() /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5945,8 +7588,10 @@ public virtual QueryApiKeysResponse QueryApiKeys(Action /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5959,8 +7604,10 @@ public virtual QueryApiKeysResponse QueryApiKeys(QueryApiKeysRequestDescriptor d /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5974,8 +7621,10 @@ public virtual QueryApiKeysResponse QueryApiKeys() /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5990,8 +7639,10 @@ public virtual QueryApiKeysResponse QueryApiKeys(Action /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6003,8 +7654,10 @@ public virtual Task QueryApiKeysAsync(QueryApiK /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6017,8 +7670,10 @@ public virtual Task QueryApiKeysAsync(Cancellat /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6032,8 +7687,10 @@ public virtual Task QueryApiKeysAsync(Action /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6045,8 +7702,10 @@ public virtual Task QueryApiKeysAsync(QueryApiKeysRequestD /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6059,8 +7718,10 @@ public virtual Task QueryApiKeysAsync(CancellationToken ca /// /// - /// Query API keys. - /// Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + /// Find API keys with a query. + /// + /// + /// Get a paginated list of API keys and their information. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6074,7 +7735,10 @@ public virtual Task QueryApiKeysAsync(Action /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6087,7 +7751,10 @@ public virtual QueryRoleResponse QueryRole(QueryRoleRequest request) /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6099,7 +7766,10 @@ public virtual Task QueryRoleAsync(QueryRoleRequest request, /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6112,7 +7782,10 @@ public virtual QueryRoleResponse QueryRole(QueryRoleRequestDescriptor /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6126,7 +7799,10 @@ public virtual QueryRoleResponse QueryRole() /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6141,7 +7817,10 @@ public virtual QueryRoleResponse QueryRole(Action /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6154,7 +7833,10 @@ public virtual QueryRoleResponse QueryRole(QueryRoleRequestDescriptor descriptor /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6168,7 +7850,10 @@ public virtual QueryRoleResponse QueryRole() /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6183,7 +7868,10 @@ public virtual QueryRoleResponse QueryRole(Action co /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6195,7 +7883,10 @@ public virtual Task QueryRoleAsync(QueryRoleReques /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6208,7 +7899,10 @@ public virtual Task QueryRoleAsync(CancellationTok /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6222,7 +7916,10 @@ public virtual Task QueryRoleAsync(Action /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6234,7 +7931,10 @@ public virtual Task QueryRoleAsync(QueryRoleRequestDescriptor /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6247,7 +7947,10 @@ public virtual Task QueryRoleAsync(CancellationToken cancella /// /// - /// Retrieves roles in a paginated manner. You can optionally filter the results with a query. + /// Find roles with a query. + /// + /// + /// Get roles in a paginated manner. You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6261,7 +7964,11 @@ public virtual Task QueryRoleAsync(Action /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6274,7 +7981,11 @@ public virtual QueryUserResponse QueryUser(QueryUserRequest request) /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6286,7 +7997,11 @@ public virtual Task QueryUserAsync(QueryUserRequest request, /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6299,7 +8014,11 @@ public virtual QueryUserResponse QueryUser(QueryUserRequestDescriptor /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6313,7 +8032,11 @@ public virtual QueryUserResponse QueryUser() /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6328,7 +8051,11 @@ public virtual QueryUserResponse QueryUser(Action /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6341,7 +8068,11 @@ public virtual QueryUserResponse QueryUser(QueryUserRequestDescriptor descriptor /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6355,7 +8086,11 @@ public virtual QueryUserResponse QueryUser() /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6370,7 +8105,11 @@ public virtual QueryUserResponse QueryUser(Action co /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6382,7 +8121,11 @@ public virtual Task QueryUserAsync(QueryUserReques /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6395,7 +8138,11 @@ public virtual Task QueryUserAsync(CancellationTok /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6409,7 +8156,11 @@ public virtual Task QueryUserAsync(Action /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6421,7 +8172,11 @@ public virtual Task QueryUserAsync(QueryUserRequestDescriptor /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6434,7 +8189,11 @@ public virtual Task QueryUserAsync(CancellationToken cancella /// /// - /// Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + /// Find users with a query. + /// + /// + /// Get information for users in a paginated manner. + /// You can optionally filter the results with a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6448,7 +8207,10 @@ public virtual Task QueryUserAsync(Action /// - /// Submits a SAML Response message to Elasticsearch for consumption. + /// Authenticate SAML. + /// + /// + /// Submits a SAML response message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6461,7 +8223,10 @@ public virtual SamlAuthenticateResponse SamlAuthenticate(SamlAuthenticateRequest /// /// - /// Submits a SAML Response message to Elasticsearch for consumption. + /// Authenticate SAML. + /// + /// + /// Submits a SAML response message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6473,7 +8238,10 @@ public virtual Task SamlAuthenticateAsync(SamlAuthenti /// /// - /// Submits a SAML Response message to Elasticsearch for consumption. + /// Authenticate SAML. + /// + /// + /// Submits a SAML response message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6486,7 +8254,10 @@ public virtual SamlAuthenticateResponse SamlAuthenticate(SamlAuthenticateRequest /// /// - /// Submits a SAML Response message to Elasticsearch for consumption. + /// Authenticate SAML. + /// + /// + /// Submits a SAML response message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6500,7 +8271,10 @@ public virtual SamlAuthenticateResponse SamlAuthenticate() /// /// - /// Submits a SAML Response message to Elasticsearch for consumption. + /// Authenticate SAML. + /// + /// + /// Submits a SAML response message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6515,7 +8289,10 @@ public virtual SamlAuthenticateResponse SamlAuthenticate(Action /// - /// Submits a SAML Response message to Elasticsearch for consumption. + /// Authenticate SAML. + /// + /// + /// Submits a SAML response message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6527,7 +8304,10 @@ public virtual Task SamlAuthenticateAsync(SamlAuthenti /// /// - /// Submits a SAML Response message to Elasticsearch for consumption. + /// Authenticate SAML. + /// + /// + /// Submits a SAML response message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6540,7 +8320,10 @@ public virtual Task SamlAuthenticateAsync(Cancellation /// /// - /// Submits a SAML Response message to Elasticsearch for consumption. + /// Authenticate SAML. + /// + /// + /// Submits a SAML response message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6554,6 +8337,9 @@ public virtual Task SamlAuthenticateAsync(Action /// + /// Logout of SAML completely. + /// + /// /// Verifies the logout response sent from the SAML IdP. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6567,6 +8353,9 @@ public virtual SamlCompleteLogoutResponse SamlCompleteLogout(SamlCompleteLogoutR /// /// + /// Logout of SAML completely. + /// + /// /// Verifies the logout response sent from the SAML IdP. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6579,6 +8368,9 @@ public virtual Task SamlCompleteLogoutAsync(SamlComp /// /// + /// Logout of SAML completely. + /// + /// /// Verifies the logout response sent from the SAML IdP. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6592,6 +8384,9 @@ public virtual SamlCompleteLogoutResponse SamlCompleteLogout(SamlCompleteLogoutR /// /// + /// Logout of SAML completely. + /// + /// /// Verifies the logout response sent from the SAML IdP. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6606,6 +8401,9 @@ public virtual SamlCompleteLogoutResponse SamlCompleteLogout() /// /// + /// Logout of SAML completely. + /// + /// /// Verifies the logout response sent from the SAML IdP. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6621,6 +8419,9 @@ public virtual SamlCompleteLogoutResponse SamlCompleteLogout(Action /// + /// Logout of SAML completely. + /// + /// /// Verifies the logout response sent from the SAML IdP. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6633,6 +8434,9 @@ public virtual Task SamlCompleteLogoutAsync(SamlComp /// /// + /// Logout of SAML completely. + /// + /// /// Verifies the logout response sent from the SAML IdP. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6646,6 +8450,9 @@ public virtual Task SamlCompleteLogoutAsync(Cancella /// /// + /// Logout of SAML completely. + /// + /// /// Verifies the logout response sent from the SAML IdP. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6660,6 +8467,9 @@ public virtual Task SamlCompleteLogoutAsync(Action /// + /// Invalidate SAML. + /// + /// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6673,6 +8483,9 @@ public virtual SamlInvalidateResponse SamlInvalidate(SamlInvalidateRequest reque /// /// + /// Invalidate SAML. + /// + /// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6685,6 +8498,9 @@ public virtual Task SamlInvalidateAsync(SamlInvalidateRe /// /// + /// Invalidate SAML. + /// + /// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6698,6 +8514,9 @@ public virtual SamlInvalidateResponse SamlInvalidate(SamlInvalidateRequestDescri /// /// + /// Invalidate SAML. + /// + /// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6712,6 +8531,9 @@ public virtual SamlInvalidateResponse SamlInvalidate() /// /// + /// Invalidate SAML. + /// + /// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6727,6 +8549,9 @@ public virtual SamlInvalidateResponse SamlInvalidate(Action /// + /// Invalidate SAML. + /// + /// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6739,6 +8564,9 @@ public virtual Task SamlInvalidateAsync(SamlInvalidateRe /// /// + /// Invalidate SAML. + /// + /// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6752,6 +8580,9 @@ public virtual Task SamlInvalidateAsync(CancellationToke /// /// + /// Invalidate SAML. + /// + /// /// Submits a SAML LogoutRequest message to Elasticsearch for consumption. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6766,6 +8597,9 @@ public virtual Task SamlInvalidateAsync(Action /// + /// Logout of SAML. + /// + /// /// Submits a request to invalidate an access token and refresh token. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6779,6 +8613,9 @@ public virtual SamlLogoutResponse SamlLogout(SamlLogoutRequest request) /// /// + /// Logout of SAML. + /// + /// /// Submits a request to invalidate an access token and refresh token. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6791,6 +8628,9 @@ public virtual Task SamlLogoutAsync(SamlLogoutRequest reques /// /// + /// Logout of SAML. + /// + /// /// Submits a request to invalidate an access token and refresh token. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6804,6 +8644,9 @@ public virtual SamlLogoutResponse SamlLogout(SamlLogoutRequestDescriptor descrip /// /// + /// Logout of SAML. + /// + /// /// Submits a request to invalidate an access token and refresh token. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6818,6 +8661,9 @@ public virtual SamlLogoutResponse SamlLogout() /// /// + /// Logout of SAML. + /// + /// /// Submits a request to invalidate an access token and refresh token. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6833,6 +8679,9 @@ public virtual SamlLogoutResponse SamlLogout(Action /// /// + /// Logout of SAML. + /// + /// /// Submits a request to invalidate an access token and refresh token. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6845,6 +8694,9 @@ public virtual Task SamlLogoutAsync(SamlLogoutRequestDescrip /// /// + /// Logout of SAML. + /// + /// /// Submits a request to invalidate an access token and refresh token. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6858,6 +8710,9 @@ public virtual Task SamlLogoutAsync(CancellationToken cancel /// /// + /// Logout of SAML. + /// + /// /// Submits a request to invalidate an access token and refresh token. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6872,7 +8727,10 @@ public virtual Task SamlLogoutAsync(Action /// - /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + /// Prepare SAML authentication. + /// + /// + /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6885,7 +8743,10 @@ public virtual SamlPrepareAuthenticationResponse SamlPrepareAuthentication(SamlP /// /// - /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + /// Prepare SAML authentication. + /// + /// + /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6897,7 +8758,10 @@ public virtual Task SamlPrepareAuthentication /// /// - /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + /// Prepare SAML authentication. + /// + /// + /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6910,7 +8774,10 @@ public virtual SamlPrepareAuthenticationResponse SamlPrepareAuthentication(SamlP /// /// - /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + /// Prepare SAML authentication. + /// + /// + /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6924,7 +8791,10 @@ public virtual SamlPrepareAuthenticationResponse SamlPrepareAuthentication() /// /// - /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + /// Prepare SAML authentication. + /// + /// + /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6939,7 +8809,10 @@ public virtual SamlPrepareAuthenticationResponse SamlPrepareAuthentication(Actio /// /// - /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + /// Prepare SAML authentication. + /// + /// + /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6951,7 +8824,10 @@ public virtual Task SamlPrepareAuthentication /// /// - /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + /// Prepare SAML authentication. + /// + /// + /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6964,7 +8840,10 @@ public virtual Task SamlPrepareAuthentication /// /// - /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + /// Prepare SAML authentication. + /// + /// + /// Creates a SAML authentication request (<AuthnRequest>) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6978,6 +8857,9 @@ public virtual Task SamlPrepareAuthentication /// /// + /// Create SAML service provider metadata. + /// + /// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// Learn more about this API in the Elasticsearch documentation. @@ -6991,6 +8873,9 @@ public virtual SamlServiceProviderMetadataResponse SamlServiceProviderMetadata(S /// /// + /// Create SAML service provider metadata. + /// + /// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7003,6 +8888,9 @@ public virtual Task SamlServiceProviderMeta /// /// + /// Create SAML service provider metadata. + /// + /// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7016,6 +8904,9 @@ public virtual SamlServiceProviderMetadataResponse SamlServiceProviderMetadata(S /// /// + /// Create SAML service provider metadata. + /// + /// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7030,6 +8921,9 @@ public virtual SamlServiceProviderMetadataResponse SamlServiceProviderMetadata(E /// /// + /// Create SAML service provider metadata. + /// + /// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7045,6 +8939,9 @@ public virtual SamlServiceProviderMetadataResponse SamlServiceProviderMetadata(E /// /// + /// Create SAML service provider metadata. + /// + /// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7057,6 +8954,9 @@ public virtual Task SamlServiceProviderMeta /// /// + /// Create SAML service provider metadata. + /// + /// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7070,6 +8970,9 @@ public virtual Task SamlServiceProviderMeta /// /// + /// Create SAML service provider metadata. + /// + /// /// Generate SAML metadata for a SAML 2.0 Service Provider. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7084,6 +8987,9 @@ public virtual Task SamlServiceProviderMeta /// /// + /// Suggest a user profile. + /// + /// /// Get suggestions for user profiles that match specified search criteria. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7097,6 +9003,9 @@ public virtual SuggestUserProfilesResponse SuggestUserProfiles(SuggestUserProfil /// /// + /// Suggest a user profile. + /// + /// /// Get suggestions for user profiles that match specified search criteria. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7109,6 +9018,9 @@ public virtual Task SuggestUserProfilesAsync(Sugges /// /// + /// Suggest a user profile. + /// + /// /// Get suggestions for user profiles that match specified search criteria. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7122,6 +9034,9 @@ public virtual SuggestUserProfilesResponse SuggestUserProfiles(SuggestUserProfil /// /// + /// Suggest a user profile. + /// + /// /// Get suggestions for user profiles that match specified search criteria. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7136,6 +9051,9 @@ public virtual SuggestUserProfilesResponse SuggestUserProfiles() /// /// + /// Suggest a user profile. + /// + /// /// Get suggestions for user profiles that match specified search criteria. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7151,6 +9069,9 @@ public virtual SuggestUserProfilesResponse SuggestUserProfiles(Action /// + /// Suggest a user profile. + /// + /// /// Get suggestions for user profiles that match specified search criteria. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7163,6 +9084,9 @@ public virtual Task SuggestUserProfilesAsync(Sugges /// /// + /// Suggest a user profile. + /// + /// /// Get suggestions for user profiles that match specified search criteria. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7176,6 +9100,9 @@ public virtual Task SuggestUserProfilesAsync(Cancel /// /// + /// Suggest a user profile. + /// + /// /// Get suggestions for user profiles that match specified search criteria. /// /// Learn more about this API in the Elasticsearch documentation. @@ -7191,6 +9118,8 @@ public virtual Task SuggestUserProfilesAsync(Action /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7217,6 +9146,8 @@ public virtual UpdateApiKeyResponse UpdateApiKey(UpdateApiKeyRequest request) /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7242,6 +9173,8 @@ public virtual Task UpdateApiKeyAsync(UpdateApiKeyRequest /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7268,6 +9201,8 @@ public virtual UpdateApiKeyResponse UpdateApiKey(UpdateApiKeyRequestD /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7295,6 +9230,8 @@ public virtual UpdateApiKeyResponse UpdateApiKey(Elastic.Clients.Elas /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7323,6 +9260,8 @@ public virtual UpdateApiKeyResponse UpdateApiKey(Elastic.Clients.Elas /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7349,6 +9288,8 @@ public virtual UpdateApiKeyResponse UpdateApiKey(UpdateApiKeyRequestDescriptor d /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7376,6 +9317,8 @@ public virtual UpdateApiKeyResponse UpdateApiKey(Elastic.Clients.Elasticsearch.I /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7404,6 +9347,8 @@ public virtual UpdateApiKeyResponse UpdateApiKey(Elastic.Clients.Elasticsearch.I /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7429,6 +9374,8 @@ public virtual Task UpdateApiKeyAsync(UpdateApi /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7455,6 +9402,8 @@ public virtual Task UpdateApiKeyAsync(Elastic.C /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7482,6 +9431,8 @@ public virtual Task UpdateApiKeyAsync(Elastic.C /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7507,6 +9458,8 @@ public virtual Task UpdateApiKeyAsync(UpdateApiKeyRequestD /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7533,6 +9486,8 @@ public virtual Task UpdateApiKeyAsync(Elastic.Clients.Elas /// /// /// Update an API key. + /// + /// /// Updates attributes of an existing API key. /// Users can only update API keys that they created or that were granted to them. /// Use this API to update API keys created by the create API Key or grant API Key APIs. @@ -7559,7 +9514,239 @@ public virtual Task UpdateApiKeyAsync(Elastic.Clients.Elas /// /// - /// Updates specific data for the user profile that's associated with the specified unique ID. + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual UpdateCrossClusterApiKeyResponse UpdateCrossClusterApiKey(UpdateCrossClusterApiKeyRequest request) + { + request.BeforeRequest(); + return DoRequest(request); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task UpdateCrossClusterApiKeyAsync(UpdateCrossClusterApiKeyRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual UpdateCrossClusterApiKeyResponse UpdateCrossClusterApiKey(UpdateCrossClusterApiKeyRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest, UpdateCrossClusterApiKeyResponse, UpdateCrossClusterApiKeyRequestParameters>(descriptor); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual UpdateCrossClusterApiKeyResponse UpdateCrossClusterApiKey(Elastic.Clients.Elasticsearch.Id id) + { + var descriptor = new UpdateCrossClusterApiKeyRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequest, UpdateCrossClusterApiKeyResponse, UpdateCrossClusterApiKeyRequestParameters>(descriptor); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual UpdateCrossClusterApiKeyResponse UpdateCrossClusterApiKey(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest) + { + var descriptor = new UpdateCrossClusterApiKeyRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest, UpdateCrossClusterApiKeyResponse, UpdateCrossClusterApiKeyRequestParameters>(descriptor); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual UpdateCrossClusterApiKeyResponse UpdateCrossClusterApiKey(UpdateCrossClusterApiKeyRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual UpdateCrossClusterApiKeyResponse UpdateCrossClusterApiKey(Elastic.Clients.Elasticsearch.Id id) + { + var descriptor = new UpdateCrossClusterApiKeyRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual UpdateCrossClusterApiKeyResponse UpdateCrossClusterApiKey(Elastic.Clients.Elasticsearch.Id id, Action configureRequest) + { + var descriptor = new UpdateCrossClusterApiKeyRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task UpdateCrossClusterApiKeyAsync(UpdateCrossClusterApiKeyRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync, UpdateCrossClusterApiKeyResponse, UpdateCrossClusterApiKeyRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task UpdateCrossClusterApiKeyAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) + { + var descriptor = new UpdateCrossClusterApiKeyRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequestAsync, UpdateCrossClusterApiKeyResponse, UpdateCrossClusterApiKeyRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task UpdateCrossClusterApiKeyAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new UpdateCrossClusterApiKeyRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, UpdateCrossClusterApiKeyResponse, UpdateCrossClusterApiKeyRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task UpdateCrossClusterApiKeyAsync(UpdateCrossClusterApiKeyRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task UpdateCrossClusterApiKeyAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) + { + var descriptor = new UpdateCrossClusterApiKeyRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Update a cross-cluster API key. + /// + /// + /// Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task UpdateCrossClusterApiKeyAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new UpdateCrossClusterApiKeyRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Update user profile data. + /// + /// + /// Update specific data for the user profile that is associated with a unique ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7572,7 +9759,10 @@ public virtual UpdateUserProfileDataResponse UpdateUserProfileData(UpdateUserPro /// /// - /// Updates specific data for the user profile that's associated with the specified unique ID. + /// Update user profile data. + /// + /// + /// Update specific data for the user profile that is associated with a unique ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7584,7 +9774,10 @@ public virtual Task UpdateUserProfileDataAsync(Up /// /// - /// Updates specific data for the user profile that's associated with the specified unique ID. + /// Update user profile data. + /// + /// + /// Update specific data for the user profile that is associated with a unique ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7597,7 +9790,10 @@ public virtual UpdateUserProfileDataResponse UpdateUserProfileData(UpdateUserPro /// /// - /// Updates specific data for the user profile that's associated with the specified unique ID. + /// Update user profile data. + /// + /// + /// Update specific data for the user profile that is associated with a unique ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7611,7 +9807,10 @@ public virtual UpdateUserProfileDataResponse UpdateUserProfileData(string uid) /// /// - /// Updates specific data for the user profile that's associated with the specified unique ID. + /// Update user profile data. + /// + /// + /// Update specific data for the user profile that is associated with a unique ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7626,7 +9825,10 @@ public virtual UpdateUserProfileDataResponse UpdateUserProfileData(string uid, A /// /// - /// Updates specific data for the user profile that's associated with the specified unique ID. + /// Update user profile data. + /// + /// + /// Update specific data for the user profile that is associated with a unique ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7638,7 +9840,10 @@ public virtual Task UpdateUserProfileDataAsync(Up /// /// - /// Updates specific data for the user profile that's associated with the specified unique ID. + /// Update user profile data. + /// + /// + /// Update specific data for the user profile that is associated with a unique ID. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7651,7 +9856,10 @@ public virtual Task UpdateUserProfileDataAsync(st /// /// - /// Updates specific data for the user profile that's associated with the specified unique ID. + /// Update user profile data. + /// + /// + /// Update specific data for the user profile that is associated with a unique ID. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Snapshot.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Snapshot.g.cs index cc63541ea8..4509b309db 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Snapshot.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Snapshot.g.cs @@ -943,6 +943,112 @@ public virtual Task GetRepositoryAsync(Action(descriptor, cancellationToken); } + /// + /// + /// Verifies the integrity of the contents of a snapshot repository + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual RepositoryVerifyIntegrityResponse RepositoryVerifyIntegrity(RepositoryVerifyIntegrityRequest request) + { + request.BeforeRequest(); + return DoRequest(request); + } + + /// + /// + /// Verifies the integrity of the contents of a snapshot repository + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task RepositoryVerifyIntegrityAsync(RepositoryVerifyIntegrityRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Verifies the integrity of the contents of a snapshot repository + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual RepositoryVerifyIntegrityResponse RepositoryVerifyIntegrity(RepositoryVerifyIntegrityRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Verifies the integrity of the contents of a snapshot repository + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual RepositoryVerifyIntegrityResponse RepositoryVerifyIntegrity(Elastic.Clients.Elasticsearch.Names name) + { + var descriptor = new RepositoryVerifyIntegrityRequestDescriptor(name); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Verifies the integrity of the contents of a snapshot repository + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual RepositoryVerifyIntegrityResponse RepositoryVerifyIntegrity(Elastic.Clients.Elasticsearch.Names name, Action configureRequest) + { + var descriptor = new RepositoryVerifyIntegrityRequestDescriptor(name); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Verifies the integrity of the contents of a snapshot repository + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task RepositoryVerifyIntegrityAsync(RepositoryVerifyIntegrityRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Verifies the integrity of the contents of a snapshot repository + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task RepositoryVerifyIntegrityAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) + { + var descriptor = new RepositoryVerifyIntegrityRequestDescriptor(name); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Verifies the integrity of the contents of a snapshot repository + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task RepositoryVerifyIntegrityAsync(Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new RepositoryVerifyIntegrityRequestDescriptor(name); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + /// /// /// Restores a snapshot. diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Tasks.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Tasks.g.cs index 254c520972..aef9a3c6a5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Tasks.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Tasks.g.cs @@ -43,7 +43,7 @@ internal TasksNamespacedClient(ElasticsearchClient client) : base(client) /// /// Cancels a task, if it can be cancelled through an API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CancelResponse Cancel(CancelRequest request) @@ -56,7 +56,7 @@ public virtual CancelResponse Cancel(CancelRequest request) /// /// Cancels a task, if it can be cancelled through an API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(CancelRequest request, CancellationToken cancellationToken = default) { @@ -68,7 +68,7 @@ public virtual Task CancelAsync(CancelRequest request, Cancellat /// /// Cancels a task, if it can be cancelled through an API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CancelResponse Cancel(CancelRequestDescriptor descriptor) @@ -81,7 +81,7 @@ public virtual CancelResponse Cancel(CancelRequestDescriptor descriptor) /// /// Cancels a task, if it can be cancelled through an API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CancelResponse Cancel(Elastic.Clients.Elasticsearch.TaskId? taskId) @@ -95,7 +95,7 @@ public virtual CancelResponse Cancel(Elastic.Clients.Elasticsearch.TaskId? taskI /// /// Cancels a task, if it can be cancelled through an API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CancelResponse Cancel(Elastic.Clients.Elasticsearch.TaskId? taskId, Action configureRequest) @@ -110,7 +110,7 @@ public virtual CancelResponse Cancel(Elastic.Clients.Elasticsearch.TaskId? taskI /// /// Cancels a task, if it can be cancelled through an API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CancelResponse Cancel() @@ -124,7 +124,7 @@ public virtual CancelResponse Cancel() /// /// Cancels a task, if it can be cancelled through an API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual CancelResponse Cancel(Action configureRequest) @@ -139,7 +139,7 @@ public virtual CancelResponse Cancel(Action configureRe /// /// Cancels a task, if it can be cancelled through an API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(CancelRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -151,7 +151,7 @@ public virtual Task CancelAsync(CancelRequestDescriptor descript /// /// Cancels a task, if it can be cancelled through an API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(Elastic.Clients.Elasticsearch.TaskId? taskId, CancellationToken cancellationToken = default) { @@ -164,7 +164,7 @@ public virtual Task CancelAsync(Elastic.Clients.Elasticsearch.Ta /// /// Cancels a task, if it can be cancelled through an API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(Elastic.Clients.Elasticsearch.TaskId? taskId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -178,7 +178,7 @@ public virtual Task CancelAsync(Elastic.Clients.Elasticsearch.Ta /// /// Cancels a task, if it can be cancelled through an API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(CancellationToken cancellationToken = default) { @@ -191,7 +191,7 @@ public virtual Task CancelAsync(CancellationToken cancellationTo /// /// Cancels a task, if it can be cancelled through an API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -206,7 +206,7 @@ public virtual Task CancelAsync(Action /// Get task information. /// Returns information about the tasks currently executing in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetTasksResponse Get(GetTasksRequest request) @@ -220,7 +220,7 @@ public virtual GetTasksResponse Get(GetTasksRequest request) /// Get task information. /// Returns information about the tasks currently executing in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetTasksRequest request, CancellationToken cancellationToken = default) { @@ -233,7 +233,7 @@ public virtual Task GetAsync(GetTasksRequest request, Cancella /// Get task information. /// Returns information about the tasks currently executing in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetTasksResponse Get(GetTasksRequestDescriptor descriptor) @@ -247,7 +247,7 @@ public virtual GetTasksResponse Get(GetTasksRequestDescriptor descriptor) /// Get task information. /// Returns information about the tasks currently executing in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetTasksResponse Get(Elastic.Clients.Elasticsearch.Id taskId) @@ -262,7 +262,7 @@ public virtual GetTasksResponse Get(Elastic.Clients.Elasticsearch.Id taskId) /// Get task information. /// Returns information about the tasks currently executing in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual GetTasksResponse Get(Elastic.Clients.Elasticsearch.Id taskId, Action configureRequest) @@ -278,7 +278,7 @@ public virtual GetTasksResponse Get(Elastic.Clients.Elasticsearch.Id taskId, Act /// Get task information. /// Returns information about the tasks currently executing in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetAsync(GetTasksRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -291,7 +291,7 @@ public virtual Task GetAsync(GetTasksRequestDescriptor descrip /// Get task information. /// Returns information about the tasks currently executing in the cluster. /// - /// 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 taskId, CancellationToken cancellationToken = default) { @@ -305,7 +305,7 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Id /// Get task information. /// Returns information about the tasks currently executing in the cluster. /// - /// 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 taskId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -319,7 +319,7 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Id /// /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ListResponse List(ListRequest request) @@ -332,7 +332,7 @@ public virtual ListResponse List(ListRequest request) /// /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListAsync(ListRequest request, CancellationToken cancellationToken = default) { @@ -344,7 +344,7 @@ public virtual Task ListAsync(ListRequest request, CancellationTok /// /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ListResponse List(ListRequestDescriptor descriptor) @@ -357,7 +357,7 @@ public virtual ListResponse List(ListRequestDescriptor descriptor) /// /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ListResponse List() @@ -371,7 +371,7 @@ public virtual ListResponse List() /// /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ListResponse List(Action configureRequest) @@ -386,7 +386,7 @@ public virtual ListResponse List(Action configureRequest) /// /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListAsync(ListRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -398,7 +398,7 @@ public virtual Task ListAsync(ListRequestDescriptor descriptor, Ca /// /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListAsync(CancellationToken cancellationToken = default) { @@ -411,7 +411,7 @@ public virtual Task ListAsync(CancellationToken cancellationToken /// /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ListAsync(Action configureRequest, CancellationToken cancellationToken = default) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.g.cs index c28ef2403d..d4166fe322 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.g.cs @@ -124,7 +124,7 @@ private partial void SetupNamespaces() /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual BulkResponse Bulk(BulkRequest request) @@ -139,7 +139,7 @@ public virtual BulkResponse Bulk(BulkRequest request) /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(BulkRequest request, CancellationToken cancellationToken = default) { @@ -153,7 +153,7 @@ public virtual Task BulkAsync(BulkRequest request, CancellationTok /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual BulkResponse Bulk(BulkRequestDescriptor descriptor) @@ -168,7 +168,7 @@ public virtual BulkResponse Bulk(BulkRequestDescriptor des /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual BulkResponse Bulk(Elastic.Clients.Elasticsearch.IndexName? index) @@ -184,7 +184,7 @@ public virtual BulkResponse Bulk(Elastic.Clients.Elasticsearch.IndexN /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual BulkResponse Bulk(Elastic.Clients.Elasticsearch.IndexName? index, Action> configureRequest) @@ -201,7 +201,7 @@ public virtual BulkResponse Bulk(Elastic.Clients.Elasticsearch.IndexN /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual BulkResponse Bulk() @@ -217,7 +217,7 @@ public virtual BulkResponse Bulk() /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual BulkResponse Bulk(Action> configureRequest) @@ -234,7 +234,7 @@ public virtual BulkResponse Bulk(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual BulkResponse Bulk(BulkRequestDescriptor descriptor) @@ -249,7 +249,7 @@ public virtual BulkResponse Bulk(BulkRequestDescriptor descriptor) /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual BulkResponse Bulk(Elastic.Clients.Elasticsearch.IndexName? index) @@ -265,7 +265,7 @@ public virtual BulkResponse Bulk(Elastic.Clients.Elasticsearch.IndexName? index) /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual BulkResponse Bulk(Elastic.Clients.Elasticsearch.IndexName? index, Action configureRequest) @@ -282,7 +282,7 @@ public virtual BulkResponse Bulk(Elastic.Clients.Elasticsearch.IndexName? index, /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual BulkResponse Bulk() @@ -298,7 +298,7 @@ public virtual BulkResponse Bulk() /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual BulkResponse Bulk(Action configureRequest) @@ -315,7 +315,7 @@ public virtual BulkResponse Bulk(Action configureRequest) /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(BulkRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -329,7 +329,7 @@ public virtual Task BulkAsync(BulkRequestDescriptor - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.IndexName? index, CancellationToken cancellationToken = default) { @@ -344,7 +344,7 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticse /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.IndexName? index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -360,7 +360,7 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticse /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(CancellationToken cancellationToken = default) { @@ -375,7 +375,7 @@ public virtual Task BulkAsync(CancellationToken cancell /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -391,7 +391,7 @@ public virtual Task BulkAsync(Action - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(BulkRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -405,7 +405,7 @@ public virtual Task BulkAsync(BulkRequestDescriptor descriptor, Ca /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.IndexName? index, CancellationToken cancellationToken = default) { @@ -420,7 +420,7 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.IndexN /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.IndexName? index, Action configureRequest, CancellationToken cancellationToken = default) { @@ -436,7 +436,7 @@ public virtual Task BulkAsync(Elastic.Clients.Elasticsearch.IndexN /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(CancellationToken cancellationToken = default) { @@ -451,7 +451,7 @@ public virtual Task BulkAsync(CancellationToken cancellationToken /// Performs multiple indexing or delete operations in a single API call. /// This reduces overhead and can greatly increase indexing speed. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task BulkAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -463,9 +463,12 @@ public virtual Task BulkAsync(Action config /// /// - /// Clears the search context and results for a scrolling search. + /// Clear a scrolling search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Clear the search context and results for a scrolling search. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClearScrollResponse ClearScroll(ClearScrollRequest request) @@ -476,9 +479,12 @@ public virtual ClearScrollResponse ClearScroll(ClearScrollRequest request) /// /// - /// Clears the search context and results for a scrolling search. + /// Clear a scrolling search. + /// + /// + /// Clear the search context and results for a scrolling search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(ClearScrollRequest request, CancellationToken cancellationToken = default) { @@ -488,9 +494,12 @@ public virtual Task ClearScrollAsync(ClearScrollRequest req /// /// - /// Clears the search context and results for a scrolling search. + /// Clear a scrolling search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Clear the search context and results for a scrolling search. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClearScrollResponse ClearScroll(ClearScrollRequestDescriptor descriptor) @@ -501,9 +510,12 @@ public virtual ClearScrollResponse ClearScroll(ClearScrollRequestDescriptor desc /// /// - /// Clears the search context and results for a scrolling search. + /// Clear a scrolling search. + /// + /// + /// Clear the search context and results for a scrolling search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClearScrollResponse ClearScroll() @@ -515,9 +527,12 @@ public virtual ClearScrollResponse ClearScroll() /// /// - /// Clears the search context and results for a scrolling search. + /// Clear a scrolling search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Clear the search context and results for a scrolling search. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClearScrollResponse ClearScroll(Action configureRequest) @@ -530,9 +545,12 @@ public virtual ClearScrollResponse ClearScroll(Action /// - /// Clears the search context and results for a scrolling search. + /// Clear a scrolling search. + /// + /// + /// Clear the search context and results for a scrolling search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(ClearScrollRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -542,9 +560,12 @@ public virtual Task ClearScrollAsync(ClearScrollRequestDesc /// /// - /// Clears the search context and results for a scrolling search. + /// Clear a scrolling search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Clear the search context and results for a scrolling search. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(CancellationToken cancellationToken = default) { @@ -555,9 +576,12 @@ public virtual Task ClearScrollAsync(CancellationToken canc /// /// - /// Clears the search context and results for a scrolling search. + /// Clear a scrolling search. + /// + /// + /// Clear the search context and results for a scrolling search. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClearScrollAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -569,9 +593,15 @@ public virtual Task ClearScrollAsync(Action /// - /// Closes a point-in-time. + /// Close a point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// A point in time is automatically closed when the keep_alive period has elapsed. + /// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClosePointInTimeResponse ClosePointInTime(ClosePointInTimeRequest request) @@ -582,9 +612,15 @@ public virtual ClosePointInTimeResponse ClosePointInTime(ClosePointInTimeRequest /// /// - /// Closes a point-in-time. + /// Close a point in time. + /// + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// A point in time is automatically closed when the keep_alive period has elapsed. + /// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(ClosePointInTimeRequest request, CancellationToken cancellationToken = default) { @@ -594,9 +630,15 @@ public virtual Task ClosePointInTimeAsync(ClosePointIn /// /// - /// Closes a point-in-time. + /// Close a point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// A point in time is automatically closed when the keep_alive period has elapsed. + /// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClosePointInTimeResponse ClosePointInTime(ClosePointInTimeRequestDescriptor descriptor) @@ -607,9 +649,15 @@ public virtual ClosePointInTimeResponse ClosePointInTime(ClosePointInTimeRequest /// /// - /// Closes a point-in-time. + /// Close a point in time. + /// + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// A point in time is automatically closed when the keep_alive period has elapsed. + /// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClosePointInTimeResponse ClosePointInTime() @@ -621,9 +669,15 @@ public virtual ClosePointInTimeResponse ClosePointInTime() /// /// - /// Closes a point-in-time. + /// Close a point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// A point in time is automatically closed when the keep_alive period has elapsed. + /// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual ClosePointInTimeResponse ClosePointInTime(Action configureRequest) @@ -636,9 +690,15 @@ public virtual ClosePointInTimeResponse ClosePointInTime(Action /// - /// Closes a point-in-time. + /// Close a point in time. + /// + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// A point in time is automatically closed when the keep_alive period has elapsed. + /// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(ClosePointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -648,9 +708,15 @@ public virtual Task ClosePointInTimeAsync(ClosePointIn /// /// - /// Closes a point-in-time. + /// Close a point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// A point in time is automatically closed when the keep_alive period has elapsed. + /// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(CancellationToken cancellationToken = default) { @@ -661,9 +727,15 @@ public virtual Task ClosePointInTimeAsync(Cancellation /// /// - /// Closes a point-in-time. + /// Close a point in time. + /// + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// A point in time is automatically closed when the keep_alive period has elapsed. + /// However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. /// - /// Learn more about this API in the Elasticsearch documentation. + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ClosePointInTimeAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -1990,7 +2062,11 @@ public virtual Task DeleteByQueryAsync(Elastic.Clients.El /// /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// Throttle a delete by query operation. + /// + /// + /// Change the number of requests per second for a particular delete by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2003,7 +2079,11 @@ public virtual DeleteByQueryRethrottleResponse DeleteByQueryRethrottle(DeleteByQ /// /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// Throttle a delete by query operation. + /// + /// + /// Change the number of requests per second for a particular delete by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2015,7 +2095,11 @@ public virtual Task DeleteByQueryRethrottleAsyn /// /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// Throttle a delete by query operation. + /// + /// + /// Change the number of requests per second for a particular delete by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2028,7 +2112,11 @@ public virtual DeleteByQueryRethrottleResponse DeleteByQueryRethrottle(DeleteByQ /// /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// Throttle a delete by query operation. + /// + /// + /// Change the number of requests per second for a particular delete by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2042,7 +2130,11 @@ public virtual DeleteByQueryRethrottleResponse DeleteByQueryRethrottle(Elastic.C /// /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// Throttle a delete by query operation. + /// + /// + /// Change the number of requests per second for a particular delete by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2057,7 +2149,11 @@ public virtual DeleteByQueryRethrottleResponse DeleteByQueryRethrottle(Elastic.C /// /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// Throttle a delete by query operation. + /// + /// + /// Change the number of requests per second for a particular delete by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2069,7 +2165,11 @@ public virtual Task DeleteByQueryRethrottleAsyn /// /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// Throttle a delete by query operation. + /// + /// + /// Change the number of requests per second for a particular delete by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2082,7 +2182,11 @@ public virtual Task DeleteByQueryRethrottleAsyn /// /// - /// Changes the number of requests per second for a particular Delete By Query operation. + /// Throttle a delete by query operation. + /// + /// + /// Change the number of requests per second for a particular delete by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3533,9 +3637,15 @@ public virtual Task> ExplainAsync(Elastic. /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3548,9 +3658,15 @@ public virtual FieldCapsResponse FieldCaps(FieldCapsRequest request) /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3562,9 +3678,15 @@ public virtual Task FieldCapsAsync(FieldCapsRequest request, /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3577,9 +3699,15 @@ public virtual FieldCapsResponse FieldCaps(FieldCapsRequestDescriptor /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3593,9 +3721,15 @@ public virtual FieldCapsResponse FieldCaps(Elastic.Clients.Elasticsea /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3610,9 +3744,15 @@ public virtual FieldCapsResponse FieldCaps(Elastic.Clients.Elasticsea /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3626,9 +3766,15 @@ public virtual FieldCapsResponse FieldCaps() /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3643,9 +3789,15 @@ public virtual FieldCapsResponse FieldCaps(Action /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3658,9 +3810,15 @@ public virtual FieldCapsResponse FieldCaps(FieldCapsRequestDescriptor descriptor /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3674,9 +3832,15 @@ public virtual FieldCapsResponse FieldCaps(Elastic.Clients.Elasticsearch.Indices /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3691,9 +3855,15 @@ public virtual FieldCapsResponse FieldCaps(Elastic.Clients.Elasticsearch.Indices /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3707,9 +3877,15 @@ public virtual FieldCapsResponse FieldCaps() /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3724,9 +3900,15 @@ public virtual FieldCapsResponse FieldCaps(Action co /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3738,9 +3920,15 @@ public virtual Task FieldCapsAsync(FieldCapsReques /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3753,9 +3941,15 @@ public virtual Task FieldCapsAsync(Elastic.Clients /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3769,9 +3963,15 @@ public virtual Task FieldCapsAsync(Elastic.Clients /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3784,9 +3984,15 @@ public virtual Task FieldCapsAsync(CancellationTok /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3800,9 +4006,15 @@ public virtual Task FieldCapsAsync(Action /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3814,9 +4026,15 @@ public virtual Task FieldCapsAsync(FieldCapsRequestDescriptor /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3829,9 +4047,15 @@ public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsea /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3845,9 +4069,15 @@ public virtual Task FieldCapsAsync(Elastic.Clients.Elasticsea /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3860,9 +4090,15 @@ public virtual Task FieldCapsAsync(CancellationToken cancella /// /// - /// The field capabilities API returns the information about the capabilities of fields among multiple indices. - /// The field capabilities API returns runtime fields like any other field. For example, a runtime field with a type - /// of keyword is returned as any other field that belongs to the keyword family. + /// Get the field capabilities. + /// + /// + /// Get information about the capabilities of fields among multiple indices. + /// + /// + /// For data streams, the API returns field capabilities among the stream’s backing indices. + /// It returns runtime fields like any other field. + /// For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4431,7 +4667,10 @@ public virtual Task GetScriptAsync(Elastic.Clients.Elasticsea /// /// - /// Returns all script contexts. + /// Get script contexts. + /// + /// + /// Get a list of supported script contexts and their methods. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4444,7 +4683,10 @@ public virtual GetScriptContextResponse GetScriptContext(GetScriptContextRequest /// /// - /// Returns all script contexts. + /// Get script contexts. + /// + /// + /// Get a list of supported script contexts and their methods. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4456,7 +4698,10 @@ public virtual Task GetScriptContextAsync(GetScriptCon /// /// - /// Returns all script contexts. + /// Get script contexts. + /// + /// + /// Get a list of supported script contexts and their methods. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4469,7 +4714,10 @@ public virtual GetScriptContextResponse GetScriptContext(GetScriptContextRequest /// /// - /// Returns all script contexts. + /// Get script contexts. + /// + /// + /// Get a list of supported script contexts and their methods. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4483,7 +4731,10 @@ public virtual GetScriptContextResponse GetScriptContext() /// /// - /// Returns all script contexts. + /// Get script contexts. + /// + /// + /// Get a list of supported script contexts and their methods. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4498,7 +4749,10 @@ public virtual GetScriptContextResponse GetScriptContext(Action /// - /// Returns all script contexts. + /// Get script contexts. + /// + /// + /// Get a list of supported script contexts and their methods. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4510,7 +4764,10 @@ public virtual Task GetScriptContextAsync(GetScriptCon /// /// - /// Returns all script contexts. + /// Get script contexts. + /// + /// + /// Get a list of supported script contexts and their methods. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4523,7 +4780,10 @@ public virtual Task GetScriptContextAsync(Cancellation /// /// - /// Returns all script contexts. + /// Get script contexts. + /// + /// + /// Get a list of supported script contexts and their methods. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4537,7 +4797,10 @@ public virtual Task GetScriptContextAsync(Action /// - /// Returns available script types, languages and contexts + /// Get script languages. + /// + /// + /// Get a list of available script types, languages, and contexts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4550,7 +4813,10 @@ public virtual GetScriptLanguagesResponse GetScriptLanguages(GetScriptLanguagesR /// /// - /// Returns available script types, languages and contexts + /// Get script languages. + /// + /// + /// Get a list of available script types, languages, and contexts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4562,7 +4828,10 @@ public virtual Task GetScriptLanguagesAsync(GetScrip /// /// - /// Returns available script types, languages and contexts + /// Get script languages. + /// + /// + /// Get a list of available script types, languages, and contexts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4575,7 +4844,10 @@ public virtual GetScriptLanguagesResponse GetScriptLanguages(GetScriptLanguagesR /// /// - /// Returns available script types, languages and contexts + /// Get script languages. + /// + /// + /// Get a list of available script types, languages, and contexts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4589,7 +4861,10 @@ public virtual GetScriptLanguagesResponse GetScriptLanguages() /// /// - /// Returns available script types, languages and contexts + /// Get script languages. + /// + /// + /// Get a list of available script types, languages, and contexts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4604,7 +4879,10 @@ public virtual GetScriptLanguagesResponse GetScriptLanguages(Action /// - /// Returns available script types, languages and contexts + /// Get script languages. + /// + /// + /// Get a list of available script types, languages, and contexts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4616,7 +4894,10 @@ public virtual Task GetScriptLanguagesAsync(GetScrip /// /// - /// Returns available script types, languages and contexts + /// Get script languages. + /// + /// + /// Get a list of available script types, languages, and contexts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4629,7 +4910,10 @@ public virtual Task GetScriptLanguagesAsync(Cancella /// /// - /// Returns available script types, languages and contexts + /// Get script languages. + /// + /// + /// Get a list of available script types, languages, and contexts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5587,7 +5871,13 @@ public virtual Task InfoAsync(Action config /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5600,7 +5890,13 @@ public virtual MultiTermVectorsResponse Mtermvectors(MultiTermVectorsRequest req /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5612,7 +5908,13 @@ public virtual Task MtermvectorsAsync(MultiTermVectors /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5625,7 +5927,13 @@ public virtual MultiTermVectorsResponse Mtermvectors(MultiTermVectors /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5639,7 +5947,13 @@ public virtual MultiTermVectorsResponse Mtermvectors(Elastic.Clients. /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5654,7 +5968,13 @@ public virtual MultiTermVectorsResponse Mtermvectors(Elastic.Clients. /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5668,7 +5988,13 @@ public virtual MultiTermVectorsResponse Mtermvectors() /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5683,7 +6009,13 @@ public virtual MultiTermVectorsResponse Mtermvectors(Action /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5696,7 +6028,13 @@ public virtual MultiTermVectorsResponse Mtermvectors(MultiTermVectorsRequestDesc /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5710,7 +6048,13 @@ public virtual MultiTermVectorsResponse Mtermvectors(Elastic.Clients.Elasticsear /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5725,7 +6069,13 @@ public virtual MultiTermVectorsResponse Mtermvectors(Elastic.Clients.Elasticsear /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5739,7 +6089,13 @@ public virtual MultiTermVectorsResponse Mtermvectors() /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5754,7 +6110,13 @@ public virtual MultiTermVectorsResponse Mtermvectors(Action /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5766,7 +6128,13 @@ public virtual Task MtermvectorsAsync(Multi /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5779,7 +6147,13 @@ public virtual Task MtermvectorsAsync(Elast /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5793,7 +6167,13 @@ public virtual Task MtermvectorsAsync(Elast /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5806,7 +6186,13 @@ public virtual Task MtermvectorsAsync(Cance /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5820,7 +6206,13 @@ public virtual Task MtermvectorsAsync(Actio /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5832,7 +6224,13 @@ public virtual Task MtermvectorsAsync(MultiTermVectors /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5845,7 +6243,13 @@ public virtual Task MtermvectorsAsync(Elastic.Clients. /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5859,7 +6263,13 @@ public virtual Task MtermvectorsAsync(Elastic.Clients. /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5872,7 +6282,13 @@ public virtual Task MtermvectorsAsync(CancellationToke /// /// - /// Returns multiple termvectors in one request. + /// Get multiple term vectors. + /// + /// + /// You can specify existing documents by index and ID or provide artificial documents in the body of the request. + /// You can specify the index in the request body or request URI. + /// The response contains a docs array with all the fetched termvectors. + /// Each element has the structure provided by the termvectors API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5886,7 +6302,12 @@ public virtual Task MtermvectorsAsync(Action /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5899,7 +6320,12 @@ public virtual MultiGetResponse MultiGet(MultiGetRequest r /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5911,7 +6337,12 @@ public virtual Task> MultiGetAsync(MultiG /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5924,7 +6355,12 @@ public virtual MultiGetResponse MultiGet(MultiGetRequestDe /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5938,7 +6374,12 @@ public virtual MultiGetResponse MultiGet(Elastic.Clients.E /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5953,7 +6394,12 @@ public virtual MultiGetResponse MultiGet(Elastic.Clients.E /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5967,7 +6413,12 @@ public virtual MultiGetResponse MultiGet() /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5982,7 +6433,12 @@ public virtual MultiGetResponse MultiGet(Action /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5994,7 +6450,12 @@ public virtual Task> MultiGetAsync(MultiG /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6007,7 +6468,12 @@ public virtual Task> MultiGetAsync(Elasti /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6021,7 +6487,12 @@ public virtual Task> MultiGetAsync(Elasti /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6034,7 +6505,12 @@ public virtual Task> MultiGetAsync(Cancel /// /// - /// Allows to get multiple documents in one request. + /// Get multiple documents. + /// + /// + /// Get multiple JSON documents by ID from one or more indices. + /// If you specify an index in the request URI, you only need to specify the document IDs in the request body. + /// To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6048,7 +6524,25 @@ public virtual Task> MultiGetAsync(Action /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6061,7 +6555,25 @@ public virtual MultiSearchResponse MultiSearch(MultiSearch /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6073,7 +6585,25 @@ public virtual Task> MultiSearchAsync( /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6086,10 +6616,28 @@ public virtual MultiSearchResponse MultiSearch(MultiSearch /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. /// - /// Learn more about this API in the Elasticsearch documentation. - /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual MultiSearchResponse MultiSearch(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -6100,7 +6648,25 @@ public virtual MultiSearchResponse MultiSearch(Elastic.Cli /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6115,7 +6681,25 @@ public virtual MultiSearchResponse MultiSearch(Elastic.Cli /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6129,7 +6713,25 @@ public virtual MultiSearchResponse MultiSearch() /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6144,7 +6746,25 @@ public virtual MultiSearchResponse MultiSearch(Action /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6156,7 +6776,25 @@ public virtual Task> MultiSearchAsync( /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6169,7 +6807,25 @@ public virtual Task> MultiSearchAsync( /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6183,7 +6839,25 @@ public virtual Task> MultiSearchAsync( /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6196,7 +6870,25 @@ public virtual Task> MultiSearchAsync( /// /// - /// Allows to execute several search operations in one request. + /// Run multiple searches. + /// + /// + /// The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + /// The structure is as follows: + /// + /// + /// header\n + /// body\n + /// header\n + /// body\n + /// + /// + /// This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + /// + /// + /// IMPORTANT: The final line of data must end with a newline character \n. + /// Each newline character may be preceded by a carriage return \r. + /// When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6210,7 +6902,7 @@ public virtual Task> MultiSearchAsync( /// /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6223,7 +6915,7 @@ public virtual MultiSearchTemplateResponse MultiSearchTemplate /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6235,7 +6927,7 @@ public virtual Task> MultiSearchTemplateA /// /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6248,7 +6940,7 @@ public virtual MultiSearchTemplateResponse MultiSearchTemplate /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6262,7 +6954,7 @@ public virtual MultiSearchTemplateResponse MultiSearchTemplate /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6277,7 +6969,7 @@ public virtual MultiSearchTemplateResponse MultiSearchTemplate /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6291,7 +6983,7 @@ public virtual MultiSearchTemplateResponse MultiSearchTemplate /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6306,7 +6998,7 @@ public virtual MultiSearchTemplateResponse MultiSearchTemplate /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6318,7 +7010,7 @@ public virtual Task> MultiSearchTemplateA /// /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6331,7 +7023,7 @@ public virtual Task> MultiSearchTemplateA /// /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6345,7 +7037,7 @@ public virtual Task> MultiSearchTemplateA /// /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6358,7 +7050,7 @@ public virtual Task> MultiSearchTemplateA /// /// - /// Runs multiple templated searches with a single request. + /// Run multiple templated searches. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6372,14 +7064,21 @@ public virtual Task> MultiSearchTemplateA /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual OpenPointInTimeResponse OpenPointInTime(OpenPointInTimeRequest request) @@ -6390,14 +7089,21 @@ public virtual OpenPointInTimeResponse OpenPointInTime(OpenPointInTimeRequest re /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(OpenPointInTimeRequest request, CancellationToken cancellationToken = default) { @@ -6407,14 +7113,21 @@ public virtual Task OpenPointInTimeAsync(OpenPointInTim /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual OpenPointInTimeResponse OpenPointInTime(OpenPointInTimeRequestDescriptor descriptor) @@ -6425,14 +7138,21 @@ public virtual OpenPointInTimeResponse OpenPointInTime(OpenPointInTim /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual OpenPointInTimeResponse OpenPointInTime(Elastic.Clients.Elasticsearch.Indices indices) @@ -6444,14 +7164,21 @@ public virtual OpenPointInTimeResponse OpenPointInTime(Elastic.Client /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual OpenPointInTimeResponse OpenPointInTime(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest) @@ -6464,14 +7191,21 @@ public virtual OpenPointInTimeResponse OpenPointInTime(Elastic.Client /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual OpenPointInTimeResponse OpenPointInTime() @@ -6483,14 +7217,21 @@ public virtual OpenPointInTimeResponse OpenPointInTime() /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual OpenPointInTimeResponse OpenPointInTime(Action> configureRequest) @@ -6503,14 +7244,21 @@ public virtual OpenPointInTimeResponse OpenPointInTime(Action /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual OpenPointInTimeResponse OpenPointInTime(OpenPointInTimeRequestDescriptor descriptor) @@ -6521,14 +7269,21 @@ public virtual OpenPointInTimeResponse OpenPointInTime(OpenPointInTimeRequestDes /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual OpenPointInTimeResponse OpenPointInTime(Elastic.Clients.Elasticsearch.Indices indices) @@ -6540,14 +7295,21 @@ public virtual OpenPointInTimeResponse OpenPointInTime(Elastic.Clients.Elasticse /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual OpenPointInTimeResponse OpenPointInTime(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest) @@ -6560,14 +7322,21 @@ public virtual OpenPointInTimeResponse OpenPointInTime(Elastic.Clients.Elasticse /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(OpenPointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -6577,14 +7346,21 @@ public virtual Task OpenPointInTimeAsync(Ope /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -6595,14 +7371,21 @@ public virtual Task OpenPointInTimeAsync(Ela /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -6614,14 +7397,21 @@ public virtual Task OpenPointInTimeAsync(Ela /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(CancellationToken cancellationToken = default) { @@ -6632,14 +7422,21 @@ public virtual Task OpenPointInTimeAsync(Can /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -6651,14 +7448,21 @@ public virtual Task OpenPointInTimeAsync(Act /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(OpenPointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -6668,14 +7472,21 @@ public virtual Task OpenPointInTimeAsync(OpenPointInTim /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -6686,14 +7497,21 @@ public virtual Task OpenPointInTimeAsync(Elastic.Client /// /// - /// A search request by default executes against the most recent visible data of the target indices, + /// Open a point in time. + /// + /// + /// A search request by default runs against the most recent visible data of the target indices, /// which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the /// state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple /// search requests using the same point in time. For example, if refreshes happen between /// search_after requests, then the results of those requests might not be consistent as changes happening /// between searches are only visible to the more recent point in time. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A point in time must be opened explicitly before being used in search requests. + /// The keep_alive parameter tells Elasticsearch how long it should persist. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task OpenPointInTimeAsync(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -7140,7 +7958,10 @@ public virtual Task PutScriptAsync(Elastic.Clients.Elasticsea /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7153,7 +7974,10 @@ public virtual RankEvalResponse RankEval(RankEvalRequest request) /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7165,7 +7989,10 @@ public virtual Task RankEvalAsync(RankEvalRequest request, Can /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7178,7 +8005,10 @@ public virtual RankEvalResponse RankEval(RankEvalRequestDescriptor /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7192,7 +8022,10 @@ public virtual RankEvalResponse RankEval(Elastic.Clients.Elasticsearc /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7207,7 +8040,10 @@ public virtual RankEvalResponse RankEval(Elastic.Clients.Elasticsearc /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7221,7 +8057,10 @@ public virtual RankEvalResponse RankEval() /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7236,7 +8075,10 @@ public virtual RankEvalResponse RankEval(Action /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7249,7 +8091,10 @@ public virtual RankEvalResponse RankEval(RankEvalRequestDescriptor descriptor) /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7263,7 +8108,10 @@ public virtual RankEvalResponse RankEval(Elastic.Clients.Elasticsearch.Indices? /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7278,7 +8126,10 @@ public virtual RankEvalResponse RankEval(Elastic.Clients.Elasticsearch.Indices? /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7292,7 +8143,10 @@ public virtual RankEvalResponse RankEval() /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7307,7 +8161,10 @@ public virtual RankEvalResponse RankEval(Action confi /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7319,7 +8176,10 @@ public virtual Task RankEvalAsync(RankEvalRequestDe /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7332,7 +8192,10 @@ public virtual Task RankEvalAsync(Elastic.Clients.E /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7346,7 +8209,10 @@ public virtual Task RankEvalAsync(Elastic.Clients.E /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7359,7 +8225,10 @@ public virtual Task RankEvalAsync(CancellationToken /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7373,7 +8242,10 @@ public virtual Task RankEvalAsync(Action /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7385,7 +8257,10 @@ public virtual Task RankEvalAsync(RankEvalRequestDescriptor de /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7398,7 +8273,10 @@ public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearc /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7412,7 +8290,10 @@ public virtual Task RankEvalAsync(Elastic.Clients.Elasticsearc /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7425,7 +8306,10 @@ public virtual Task RankEvalAsync(CancellationToken cancellati /// /// - /// Enables you to evaluate the quality of ranked search results over a set of typical search queries. + /// Evaluate ranked search results. + /// + /// + /// Evaluate the quality of ranked search results over a set of typical search queries. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7640,7 +8524,10 @@ public virtual Task ReindexAsync(Action /// - /// Copies documents from a source to a destination. + /// Throttle a reindex operation. + /// + /// + /// Change the number of requests per second for a particular reindex operation. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7653,7 +8540,10 @@ public virtual ReindexRethrottleResponse ReindexRethrottle(ReindexRethrottleRequ /// /// - /// Copies documents from a source to a destination. + /// Throttle a reindex operation. + /// + /// + /// Change the number of requests per second for a particular reindex operation. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7665,7 +8555,10 @@ public virtual Task ReindexRethrottleAsync(ReindexRet /// /// - /// Copies documents from a source to a destination. + /// Throttle a reindex operation. + /// + /// + /// Change the number of requests per second for a particular reindex operation. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7678,7 +8571,10 @@ public virtual ReindexRethrottleResponse ReindexRethrottle(ReindexRethrottleRequ /// /// - /// Copies documents from a source to a destination. + /// Throttle a reindex operation. + /// + /// + /// Change the number of requests per second for a particular reindex operation. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7692,7 +8588,10 @@ public virtual ReindexRethrottleResponse ReindexRethrottle(Elastic.Clients.Elast /// /// - /// Copies documents from a source to a destination. + /// Throttle a reindex operation. + /// + /// + /// Change the number of requests per second for a particular reindex operation. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7707,7 +8606,10 @@ public virtual ReindexRethrottleResponse ReindexRethrottle(Elastic.Clients.Elast /// /// - /// Copies documents from a source to a destination. + /// Throttle a reindex operation. + /// + /// + /// Change the number of requests per second for a particular reindex operation. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7719,7 +8621,10 @@ public virtual Task ReindexRethrottleAsync(ReindexRet /// /// - /// Copies documents from a source to a destination. + /// Throttle a reindex operation. + /// + /// + /// Change the number of requests per second for a particular reindex operation. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7732,7 +8637,10 @@ public virtual Task ReindexRethrottleAsync(Elastic.Cl /// /// - /// Copies documents from a source to a destination. + /// Throttle a reindex operation. + /// + /// + /// Change the number of requests per second for a particular reindex operation. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7746,7 +8654,10 @@ public virtual Task ReindexRethrottleAsync(Elastic.Cl /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7759,7 +8670,10 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(RenderSearchTem /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7771,7 +8685,10 @@ public virtual Task RenderSearchTemplateAsync(Rend /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7784,7 +8701,10 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Rend /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7798,7 +8718,10 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Elas /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7813,7 +8736,10 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Elas /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7827,7 +8753,10 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate() /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7842,7 +8771,10 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Acti /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7855,7 +8787,10 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(RenderSearchTem /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7869,7 +8804,10 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Elastic.Clients /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7884,7 +8822,10 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Elastic.Clients /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7898,7 +8839,10 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate() /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7913,7 +8857,10 @@ public virtual RenderSearchTemplateResponse RenderSearchTemplate(Action /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7925,7 +8872,10 @@ public virtual Task RenderSearchTemplateAsync /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7938,7 +8888,10 @@ public virtual Task RenderSearchTemplateAsync /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7952,7 +8905,10 @@ public virtual Task RenderSearchTemplateAsync /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7965,7 +8921,10 @@ public virtual Task RenderSearchTemplateAsync /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7979,7 +8938,10 @@ public virtual Task RenderSearchTemplateAsync /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7991,7 +8953,10 @@ public virtual Task RenderSearchTemplateAsync(Rend /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8004,7 +8969,10 @@ public virtual Task RenderSearchTemplateAsync(Elas /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8018,7 +8986,10 @@ public virtual Task RenderSearchTemplateAsync(Elas /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8031,7 +9002,10 @@ public virtual Task RenderSearchTemplateAsync(Canc /// /// - /// Renders a search template as a search request body. + /// Render a search template. + /// + /// + /// Render a search template as a search request body. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8159,7 +9133,24 @@ public virtual Task> ScriptsPainlessExec /// /// - /// Allows to retrieve a large numbers of results from a single search request. + /// Run a scrolling search. + /// + /// + /// IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the search_after parameter with a point in time (PIT). + /// + /// + /// The scroll API gets large sets of results from a single scrolling search request. + /// To get the necessary scroll ID, submit a search API request that includes an argument for the scroll query parameter. + /// The scroll parameter indicates how long Elasticsearch should retain the search context for the request. + /// The search response returns a scroll ID in the _scroll_id response body parameter. + /// You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. + /// If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. + /// + /// + /// You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. + /// + /// + /// IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8172,7 +9163,24 @@ public virtual ScrollResponse Scroll(ScrollRequest request /// /// - /// Allows to retrieve a large numbers of results from a single search request. + /// Run a scrolling search. + /// + /// + /// IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the search_after parameter with a point in time (PIT). + /// + /// + /// The scroll API gets large sets of results from a single scrolling search request. + /// To get the necessary scroll ID, submit a search API request that includes an argument for the scroll query parameter. + /// The scroll parameter indicates how long Elasticsearch should retain the search context for the request. + /// The search response returns a scroll ID in the _scroll_id response body parameter. + /// You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. + /// If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. + /// + /// + /// You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. + /// + /// + /// IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8184,7 +9192,10 @@ public virtual Task> ScrollAsync(ScrollRequ /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -8199,7 +9210,10 @@ public virtual SearchResponse Search(SearchRequest request /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -8213,7 +9227,10 @@ public virtual Task> SearchAsync(SearchRequ /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -8228,7 +9245,10 @@ public virtual SearchResponse Search(SearchRequestDescript /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -8244,7 +9264,10 @@ public virtual SearchResponse Search(Elastic.Clients.Elast /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -8261,7 +9284,10 @@ public virtual SearchResponse Search(Elastic.Clients.Elast /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -8277,7 +9303,10 @@ public virtual SearchResponse Search() /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -8294,7 +9323,10 @@ public virtual SearchResponse Search(Action /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -8308,7 +9340,10 @@ public virtual Task> SearchAsync(SearchRequ /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -8323,7 +9358,10 @@ public virtual Task> SearchAsync(Elastic.Cl /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -8339,7 +9377,10 @@ public virtual Task> SearchAsync(Elastic.Cl /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -8354,7 +9395,10 @@ public virtual Task> SearchAsync(Cancellati /// /// - /// Returns search hits that match the query defined in the request. + /// Run a search. + /// + /// + /// Get 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. /// @@ -8371,7 +9415,9 @@ public virtual Task> SearchAsync(Action /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8385,7 +9431,9 @@ public virtual SearchMvtResponse SearchMvt(SearchMvtRequest request) /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8398,7 +9446,9 @@ public virtual Task SearchMvtAsync(SearchMvtRequest request, /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8412,7 +9462,9 @@ public virtual SearchMvtResponse SearchMvt(SearchMvtRequestDescriptor /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8427,7 +9479,9 @@ public virtual SearchMvtResponse SearchMvt(Elastic.Clients.Elasticsea /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8443,7 +9497,9 @@ public virtual SearchMvtResponse SearchMvt(Elastic.Clients.Elasticsea /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8458,7 +9514,9 @@ public virtual SearchMvtResponse SearchMvt(Elastic.Clients.Elasticsea /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8474,7 +9532,9 @@ public virtual SearchMvtResponse SearchMvt(Elastic.Clients.Elasticsea /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8488,7 +9548,9 @@ public virtual SearchMvtResponse SearchMvt(SearchMvtRequestDescriptor descriptor /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8503,7 +9565,9 @@ public virtual SearchMvtResponse SearchMvt(Elastic.Clients.Elasticsearch.Indices /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8519,7 +9583,9 @@ public virtual SearchMvtResponse SearchMvt(Elastic.Clients.Elasticsearch.Indices /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8532,7 +9598,9 @@ public virtual Task SearchMvtAsync(SearchMvtReques /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8546,7 +9614,9 @@ public virtual Task SearchMvtAsync(Elastic.Clients /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8561,7 +9631,9 @@ public virtual Task SearchMvtAsync(Elastic.Clients /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8575,7 +9647,9 @@ public virtual Task SearchMvtAsync(Elastic.Clients /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8590,7 +9664,9 @@ public virtual Task SearchMvtAsync(Elastic.Clients /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8603,7 +9679,9 @@ public virtual Task SearchMvtAsync(SearchMvtRequestDescriptor /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8617,7 +9695,9 @@ public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsea /// /// /// Search a vector tile. - /// Searches a vector tile for geospatial values. + /// + /// + /// Search a vector tile for geospatial values. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8631,7 +9711,12 @@ public virtual Task SearchMvtAsync(Elastic.Clients.Elasticsea /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8644,7 +9729,12 @@ public virtual SearchShardsResponse SearchShards(SearchShardsRequest request) /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8656,7 +9746,12 @@ public virtual Task SearchShardsAsync(SearchShardsRequest /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8669,7 +9764,12 @@ public virtual SearchShardsResponse SearchShards(SearchShardsRequestD /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8683,7 +9783,12 @@ public virtual SearchShardsResponse SearchShards(Elastic.Clients.Elas /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8698,7 +9803,12 @@ public virtual SearchShardsResponse SearchShards(Elastic.Clients.Elas /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8712,7 +9822,12 @@ public virtual SearchShardsResponse SearchShards() /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8727,7 +9842,12 @@ public virtual SearchShardsResponse SearchShards(Action /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8740,7 +9860,12 @@ public virtual SearchShardsResponse SearchShards(SearchShardsRequestDescriptor d /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8754,7 +9879,12 @@ public virtual SearchShardsResponse SearchShards(Elastic.Clients.Elasticsearch.I /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8769,7 +9899,12 @@ public virtual SearchShardsResponse SearchShards(Elastic.Clients.Elasticsearch.I /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8783,7 +9918,12 @@ public virtual SearchShardsResponse SearchShards() /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8798,7 +9938,12 @@ public virtual SearchShardsResponse SearchShards(Action /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8810,7 +9955,12 @@ public virtual Task SearchShardsAsync(SearchSha /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8823,7 +9973,12 @@ public virtual Task SearchShardsAsync(Elastic.C /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8837,7 +9992,12 @@ public virtual Task SearchShardsAsync(Elastic.C /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8850,7 +10010,12 @@ public virtual Task SearchShardsAsync(Cancellat /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8864,7 +10029,12 @@ public virtual Task SearchShardsAsync(Action /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8876,7 +10046,12 @@ public virtual Task SearchShardsAsync(SearchShardsRequestD /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8889,7 +10064,12 @@ public virtual Task SearchShardsAsync(Elastic.Clients.Elas /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8903,7 +10083,12 @@ public virtual Task SearchShardsAsync(Elastic.Clients.Elas /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8916,7 +10101,12 @@ public virtual Task SearchShardsAsync(CancellationToken ca /// /// - /// Returns information about the indices and shards that a search request would be executed against. + /// Get the search shards. + /// + /// + /// Get the indices and shards that a search request would be run against. + /// This information can be useful for working out issues or planning optimizations with routing and shard preferences. + /// When filtered aliases are used, the filter is returned as part of the indices section. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8930,7 +10120,7 @@ public virtual Task SearchShardsAsync(Action /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8943,7 +10133,7 @@ public virtual SearchTemplateResponse SearchTemplate(Searc /// /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8955,7 +10145,7 @@ public virtual Task> SearchTemplateAsync /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8968,7 +10158,7 @@ public virtual SearchTemplateResponse SearchTemplate(Searc /// /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8982,7 +10172,7 @@ public virtual SearchTemplateResponse SearchTemplate(Elast /// /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8997,7 +10187,7 @@ public virtual SearchTemplateResponse SearchTemplate(Elast /// /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9011,7 +10201,7 @@ public virtual SearchTemplateResponse SearchTemplate() /// /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9026,7 +10216,7 @@ public virtual SearchTemplateResponse SearchTemplate(Actio /// /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9038,7 +10228,7 @@ public virtual Task> SearchTemplateAsync /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9051,7 +10241,7 @@ public virtual Task> SearchTemplateAsync /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9065,7 +10255,7 @@ public virtual Task> SearchTemplateAsync /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9078,7 +10268,7 @@ public virtual Task> SearchTemplateAsync /// - /// Runs a search with a search template. + /// Run a search with a search template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9092,7 +10282,18 @@ public virtual Task> SearchTemplateAsync /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9105,7 +10306,18 @@ public virtual TermsEnumResponse TermsEnum(TermsEnumRequest request) /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9117,7 +10329,18 @@ public virtual Task TermsEnumAsync(TermsEnumRequest request, /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9130,7 +10353,18 @@ public virtual TermsEnumResponse TermsEnum(TermsEnumRequestDescriptor /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9144,7 +10378,18 @@ public virtual TermsEnumResponse TermsEnum(Elastic.Clients.Elasticsea /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9159,7 +10404,18 @@ public virtual TermsEnumResponse TermsEnum(Elastic.Clients.Elasticsea /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9173,7 +10429,18 @@ public virtual TermsEnumResponse TermsEnum() /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9188,7 +10455,18 @@ public virtual TermsEnumResponse TermsEnum(Action /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9201,7 +10479,18 @@ public virtual TermsEnumResponse TermsEnum(TermsEnumRequestDescriptor descriptor /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9215,7 +10504,18 @@ public virtual TermsEnumResponse TermsEnum(Elastic.Clients.Elasticsearch.IndexNa /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9230,7 +10530,18 @@ public virtual TermsEnumResponse TermsEnum(Elastic.Clients.Elasticsearch.IndexNa /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9242,7 +10553,18 @@ public virtual Task TermsEnumAsync(TermsEnumReques /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9255,7 +10577,18 @@ public virtual Task TermsEnumAsync(Elastic.Clients /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9269,7 +10602,18 @@ public virtual Task TermsEnumAsync(Elastic.Clients /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9282,7 +10626,18 @@ public virtual Task TermsEnumAsync(CancellationTok /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9296,7 +10651,18 @@ public virtual Task TermsEnumAsync(Action /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9308,7 +10674,18 @@ public virtual Task TermsEnumAsync(TermsEnumRequestDescriptor /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9321,7 +10698,18 @@ public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsea /// /// - /// The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + /// Get terms in an index. + /// + /// + /// Discover terms that match a partial string in an index. + /// This "terms enum" API is designed for low-latency look-ups used in auto-complete scenarios. + /// + /// + /// If the complete property in the response is false, the returned terms set may be incomplete and should be treated as approximate. + /// This can occur due to a few reasons, such as a request timeout or a node error. + /// + /// + /// NOTE: The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9336,7 +10724,9 @@ public virtual Task TermsEnumAsync(Elastic.Clients.Elasticsea /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9350,7 +10740,9 @@ public virtual TermVectorsResponse Termvectors(TermVectorsRequest /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9363,7 +10755,9 @@ public virtual Task TermvectorsAsync(TermVectors /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9377,7 +10771,9 @@ public virtual TermVectorsResponse Termvectors(TermVectorsRequestDesc /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9392,7 +10788,9 @@ public virtual TermVectorsResponse Termvectors(Elastic.Clients.Elasti /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9408,7 +10806,9 @@ public virtual TermVectorsResponse Termvectors(Elastic.Clients.Elasti /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9423,7 +10823,9 @@ public virtual TermVectorsResponse Termvectors(Elastic.Clients.Elasti /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9439,7 +10841,9 @@ public virtual TermVectorsResponse Termvectors(Elastic.Clients.Elasti /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9454,7 +10858,9 @@ public virtual TermVectorsResponse Termvectors(TDocument document) /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9470,7 +10876,9 @@ public virtual TermVectorsResponse Termvectors(TDocument document, Ac /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9485,7 +10893,9 @@ public virtual TermVectorsResponse Termvectors(TDocument document, El /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9501,7 +10911,9 @@ public virtual TermVectorsResponse Termvectors(TDocument document, El /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9516,7 +10928,9 @@ public virtual TermVectorsResponse Termvectors(TDocument document, El /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9532,7 +10946,9 @@ public virtual TermVectorsResponse Termvectors(TDocument document, El /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9547,7 +10963,9 @@ public virtual TermVectorsResponse Termvectors(Elastic.Clients.Elasti /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9563,7 +10981,9 @@ public virtual TermVectorsResponse Termvectors(Elastic.Clients.Elasti /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9576,7 +10996,9 @@ public virtual Task TermvectorsAsync(TermVectors /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9590,7 +11012,9 @@ public virtual Task TermvectorsAsync(Elastic.Cli /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9605,7 +11029,9 @@ public virtual Task TermvectorsAsync(Elastic.Cli /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9619,7 +11045,9 @@ public virtual Task TermvectorsAsync(Elastic.Cli /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9634,7 +11062,9 @@ public virtual Task TermvectorsAsync(Elastic.Cli /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9648,7 +11078,9 @@ public virtual Task TermvectorsAsync(TDocument d /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9663,7 +11095,9 @@ public virtual Task TermvectorsAsync(TDocument d /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9677,7 +11111,9 @@ public virtual Task TermvectorsAsync(TDocument d /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9692,7 +11128,9 @@ public virtual Task TermvectorsAsync(TDocument d /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9706,7 +11144,9 @@ public virtual Task TermvectorsAsync(TDocument d /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9721,7 +11161,9 @@ public virtual Task TermvectorsAsync(TDocument d /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9735,7 +11177,9 @@ public virtual Task TermvectorsAsync(Elastic.Cli /// /// /// Get term vector information. - /// Returns information and statistics about terms in the fields of a particular document. + /// + /// + /// Get information and statistics about terms in the fields of a particular document. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10382,7 +11826,11 @@ public virtual Task UpdateByQueryAsync(Elastic.Clients.El /// /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// Throttle an update by query operation. + /// + /// + /// Change the number of requests per second for a particular update by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10395,7 +11843,11 @@ public virtual UpdateByQueryRethrottleResponse UpdateByQueryRethrottle(UpdateByQ /// /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// Throttle an update by query operation. + /// + /// + /// Change the number of requests per second for a particular update by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10407,7 +11859,11 @@ public virtual Task UpdateByQueryRethrottleAsyn /// /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// Throttle an update by query operation. + /// + /// + /// Change the number of requests per second for a particular update by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10420,7 +11876,11 @@ public virtual UpdateByQueryRethrottleResponse UpdateByQueryRethrottle(UpdateByQ /// /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// Throttle an update by query operation. + /// + /// + /// Change the number of requests per second for a particular update by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10434,7 +11894,11 @@ public virtual UpdateByQueryRethrottleResponse UpdateByQueryRethrottle(Elastic.C /// /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// Throttle an update by query operation. + /// + /// + /// Change the number of requests per second for a particular update by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10449,7 +11913,11 @@ public virtual UpdateByQueryRethrottleResponse UpdateByQueryRethrottle(Elastic.C /// /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// Throttle an update by query operation. + /// + /// + /// Change the number of requests per second for a particular update by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10461,7 +11929,11 @@ public virtual Task UpdateByQueryRethrottleAsyn /// /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// Throttle an update by query operation. + /// + /// + /// Change the number of requests per second for a particular update by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10474,7 +11946,11 @@ public virtual Task UpdateByQueryRethrottleAsyn /// /// - /// Changes the number of requests per second for a particular Update By Query operation. + /// Throttle an update by query operation. + /// + /// + /// Change the number of requests per second for a particular update by query operation. + /// Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/Normalizers.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/Normalizers.g.cs index efa42e9196..8c2e0cd884 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/Normalizers.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Analysis/Normalizers.g.cs @@ -122,7 +122,7 @@ public override void Write(Utf8JsonWriter writer, INormalizer value, JsonSeriali } /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// [JsonConverter(typeof(NormalizerInterfaceConverter))] public partial interface INormalizer diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/ByteSize.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ByteSize.g.cs index 5414414a25..c6791d2760 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/ByteSize.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/ByteSize.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch; /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ByteSize : Union { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Context.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Context.g.cs index 400b13112a..1ee285604c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Context.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/Context.g.cs @@ -34,7 +34,7 @@ namespace Elastic.Clients.Elasticsearch.Core.Search; /// /// Text or location that we want similar documents for or a lookup to a document's field for the text. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class Context : Union { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs index a8cc3f95f5..8f1672f3c2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricDiscountedCumulativeGain.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; /// /// Discounted cumulative gain (DCG) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricDiscountedCumulativeGain { @@ -56,7 +56,7 @@ public sealed partial class RankEvalMetricDiscountedCumulativeGain /// /// Discounted cumulative gain (DCG) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricDiscountedCumulativeGainDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs index 8228aa19f0..41bb06737a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricExpectedReciprocalRank.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; /// /// Expected Reciprocal Rank (ERR) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricExpectedReciprocalRank { @@ -56,7 +56,7 @@ public sealed partial class RankEvalMetricExpectedReciprocalRank /// /// Expected Reciprocal Rank (ERR) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricExpectedReciprocalRankDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs index f8eb8da98f..d55d0fb0c4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricMeanReciprocalRank.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; /// /// Mean Reciprocal Rank /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricMeanReciprocalRank { @@ -56,7 +56,7 @@ public sealed partial class RankEvalMetricMeanReciprocalRank /// /// Mean Reciprocal Rank /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricMeanReciprocalRankDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs index f20081bf15..a9d76d9556 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricPrecision.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; /// /// Precision at K (P@k) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricPrecision { @@ -64,7 +64,7 @@ public sealed partial class RankEvalMetricPrecision /// /// Precision at K (P@k) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricPrecisionDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs index a6c3382a51..86f62abbca 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/RankEval/RankEvalMetricRecall.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.Core.RankEval; /// /// Recall at K (R@k) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricRecall { @@ -56,7 +56,7 @@ public sealed partial class RankEvalMetricRecall /// /// Recall at K (R@k) /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class RankEvalMetricRecallDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/CrossClusterReplication/FollowerIndexParameters.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/CrossClusterReplication/FollowerIndexParameters.g.cs index 06ff51f8ad..95d202cef1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/CrossClusterReplication/FollowerIndexParameters.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/CrossClusterReplication/FollowerIndexParameters.g.cs @@ -29,24 +29,88 @@ namespace Elastic.Clients.Elasticsearch.CrossClusterReplication; public sealed partial class FollowerIndexParameters { + /// + /// + /// The maximum number of outstanding reads requests from the remote cluster. + /// + /// [JsonInclude, JsonPropertyName("max_outstanding_read_requests")] - public int MaxOutstandingReadRequests { get; init; } + public long? MaxOutstandingReadRequests { get; init; } + + /// + /// + /// The maximum number of outstanding write requests on the follower. + /// + /// [JsonInclude, JsonPropertyName("max_outstanding_write_requests")] - public int MaxOutstandingWriteRequests { get; init; } + public int? MaxOutstandingWriteRequests { get; init; } + + /// + /// + /// The maximum number of operations to pull per read from the remote cluster. + /// + /// [JsonInclude, JsonPropertyName("max_read_request_operation_count")] - public int MaxReadRequestOperationCount { get; init; } + public int? MaxReadRequestOperationCount { get; init; } + + /// + /// + /// The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. + /// + /// [JsonInclude, JsonPropertyName("max_read_request_size")] - public string MaxReadRequestSize { get; init; } + public Elastic.Clients.Elasticsearch.ByteSize? MaxReadRequestSize { get; init; } + + /// + /// + /// The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when + /// retrying. + /// + /// [JsonInclude, JsonPropertyName("max_retry_delay")] - public Elastic.Clients.Elasticsearch.Duration MaxRetryDelay { get; init; } + public Elastic.Clients.Elasticsearch.Duration? MaxRetryDelay { get; init; } + + /// + /// + /// The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be + /// deferred until the number of queued operations goes below the limit. + /// + /// [JsonInclude, JsonPropertyName("max_write_buffer_count")] - public int MaxWriteBufferCount { get; init; } + public int? MaxWriteBufferCount { get; init; } + + /// + /// + /// The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will + /// be deferred until the total bytes of queued operations goes below the limit. + /// + /// [JsonInclude, JsonPropertyName("max_write_buffer_size")] - public string MaxWriteBufferSize { get; init; } + public Elastic.Clients.Elasticsearch.ByteSize? MaxWriteBufferSize { get; init; } + + /// + /// + /// The maximum number of operations per bulk write request executed on the follower. + /// + /// [JsonInclude, JsonPropertyName("max_write_request_operation_count")] - public int MaxWriteRequestOperationCount { get; init; } + public int? MaxWriteRequestOperationCount { get; init; } + + /// + /// + /// The maximum total bytes of operations per bulk write request executed on the follower. + /// + /// [JsonInclude, JsonPropertyName("max_write_request_size")] - public string MaxWriteRequestSize { get; init; } + public Elastic.Clients.Elasticsearch.ByteSize? MaxWriteRequestSize { get; init; } + + /// + /// + /// The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. + /// When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. + /// Then the follower will immediately attempt to read from the leader again. + /// + /// [JsonInclude, JsonPropertyName("read_poll_timeout")] - public Elastic.Clients.Elasticsearch.Duration ReadPollTimeout { get; init; } + public Elastic.Clients.Elasticsearch.Duration? ReadPollTimeout { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Security.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Security.g.cs index 5d86de5b19..c7ab868ff1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Security.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Security.g.cs @@ -302,6 +302,64 @@ public override void Write(Utf8JsonWriter writer, GrantType value, JsonSerialize public static bool operator !=(IndexPrivilege a, IndexPrivilege b) => !(a == b); } +[JsonConverter(typeof(RemoteClusterPrivilegeConverter))] +public enum RemoteClusterPrivilege +{ + [EnumMember(Value = "monitor_enrich")] + MonitorEnrich +} + +internal sealed class RemoteClusterPrivilegeConverter : JsonConverter +{ + public override RemoteClusterPrivilege Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + var enumString = reader.GetString(); + switch (enumString) + { + case "monitor_enrich": + return RemoteClusterPrivilege.MonitorEnrich; + } + + ThrowHelper.ThrowJsonException(); + return default; + } + + public override void Write(Utf8JsonWriter writer, RemoteClusterPrivilege value, JsonSerializerOptions options) + { + switch (value) + { + case RemoteClusterPrivilege.MonitorEnrich: + writer.WriteStringValue("monitor_enrich"); + return; + } + + writer.WriteNullValue(); + } +} + +[JsonConverter(typeof(EnumStructConverter))] +public readonly partial struct RestrictionWorkflow : IEnumStruct +{ + public RestrictionWorkflow(string value) => Value = value; + + RestrictionWorkflow IEnumStruct.Create(string value) => value; + + public readonly string Value { get; } + public static RestrictionWorkflow SearchApplicationQuery { get; } = new RestrictionWorkflow("search_application_query"); + + public override string ToString() => Value ?? string.Empty; + + public static implicit operator string(RestrictionWorkflow restrictionWorkflow) => restrictionWorkflow.Value; + public static implicit operator RestrictionWorkflow(string value) => new(value); + + public override int GetHashCode() => Value.GetHashCode(); + public override bool Equals(object obj) => obj is RestrictionWorkflow other && this.Equals(other); + public bool Equals(RestrictionWorkflow other) => Value == other.Value; + + public static bool operator ==(RestrictionWorkflow a, RestrictionWorkflow b) => a.Equals(b); + public static bool operator !=(RestrictionWorkflow a, RestrictionWorkflow b) => !(a == b); +} + [JsonConverter(typeof(TemplateFormatConverter))] public enum TemplateFormat { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Fuzziness.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Fuzziness.g.cs index 8e7161ffe8..f54eb66abd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Fuzziness.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Fuzziness.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch; /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class Fuzziness : Union { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs index bde86c5aa7..af6ef53abc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycle.g.cs @@ -34,10 +34,32 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; /// public sealed partial class DataStreamLifecycle { + /// + /// + /// 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; } + + /// + /// + /// The downsampling configuration to execute for the managed backing index after rollover. + /// + /// [JsonInclude, JsonPropertyName("downsampling")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsampling? Downsampling { get; set; } + + /// + /// + /// If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle + /// that's disabled (enabled: false) will have no effect on the data stream. + /// + /// + [JsonInclude, JsonPropertyName("enabled")] + public bool? Enabled { get; set; } } /// @@ -57,13 +79,26 @@ public DataStreamLifecycleDescriptor() : base() private Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsampling? DownsamplingValue { get; set; } private Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsamplingDescriptor DownsamplingDescriptor { get; set; } private Action DownsamplingDescriptorAction { get; set; } + private bool? EnabledValue { 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 DataStreamLifecycleDescriptor DataRetention(Elastic.Clients.Elasticsearch.Duration? dataRetention) { DataRetentionValue = dataRetention; return Self; } + /// + /// + /// The downsampling configuration to execute for the managed backing index after rollover. + /// + /// public DataStreamLifecycleDescriptor Downsampling(Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsampling? downsampling) { DownsamplingDescriptor = null; @@ -88,6 +123,18 @@ public DataStreamLifecycleDescriptor Downsampling(Action + /// + /// If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle + /// that's disabled (enabled: false) will have no effect on the data stream. + /// + /// + public DataStreamLifecycleDescriptor Enabled(bool? enabled = true) + { + EnabledValue = enabled; + return Self; + } + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); @@ -113,6 +160,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, DownsamplingValue, options); } + if (EnabledValue.HasValue) + { + writer.WritePropertyName("enabled"); + writer.WriteBooleanValue(EnabledValue.Value); + } + writer.WriteEndObject(); } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs index 67be908fbd..974bb01a04 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamLifecycleWithRollover.g.cs @@ -53,6 +53,15 @@ public sealed partial class DataStreamLifecycleWithRollover [JsonInclude, JsonPropertyName("downsampling")] public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleDownsampling? Downsampling { get; init; } + /// + /// + /// If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle + /// that's disabled (enabled: false) will have no effect on the data stream. + /// + /// + [JsonInclude, JsonPropertyName("enabled")] + public bool? Enabled { get; init; } + /// /// /// The conditions which will trigger the rollover of a backing index as configured by the cluster setting cluster.lifecycle.default.rollover. diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamWithLifecycle.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamWithLifecycle.g.cs index f1f55abf69..68c2b4ced4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamWithLifecycle.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/DataStreamWithLifecycle.g.cs @@ -30,7 +30,7 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; public sealed partial class DataStreamWithLifecycle { [JsonInclude, JsonPropertyName("lifecycle")] - public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycle? Lifecycle { get; init; } + public Elastic.Clients.Elasticsearch.IndexManagement.DataStreamLifecycleWithRollover? Lifecycle { get; init; } [JsonInclude, JsonPropertyName("name")] public string Name { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettings.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettings.g.cs index 8a53108a91..cc6ae5e99a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettings.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexSettings.g.cs @@ -739,7 +739,7 @@ public override void Write(Utf8JsonWriter writer, IndexSettings value, JsonSeria } /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// [JsonConverter(typeof(IndexSettingsConverter))] public sealed partial class IndexSettings @@ -840,7 +840,7 @@ public sealed partial class IndexSettings } /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class IndexSettingsDescriptor : SerializableDescriptor> { @@ -2277,7 +2277,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class IndexSettingsDescriptor : SerializableDescriptor { 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 7b5cf8d780..f66dc302ac 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplate.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/IndexTemplate.g.cs @@ -51,6 +51,25 @@ public sealed partial class IndexTemplate [JsonInclude, JsonPropertyName("data_stream")] public Elastic.Clients.Elasticsearch.IndexManagement.IndexTemplateDataStreamConfiguration? DataStream { get; init; } + /// + /// + /// Marks this index template as deprecated. + /// When creating or updating a non-deprecated index template that uses deprecated components, + /// Elasticsearch will emit a deprecation warning. + /// + /// + [JsonInclude, JsonPropertyName("deprecated")] + public bool? Deprecated { get; init; } + + /// + /// + /// A list of component template names that are allowed to be absent. + /// + /// + [JsonInclude, JsonPropertyName("ignore_missing_component_templates")] + [SingleOrManyCollectionConverter(typeof(string))] + public IReadOnlyCollection? IgnoreMissingComponentTemplates { get; init; } + /// /// /// Name of the index template. diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs index 2dc02e63f1..e002ee38e7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettings.g.cs @@ -31,7 +31,7 @@ namespace Elastic.Clients.Elasticsearch.IndexManagement; /// /// Mapping Limit Settings /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class MappingLimitSettings { @@ -57,7 +57,7 @@ public sealed partial class MappingLimitSettings /// /// Mapping Limit Settings /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class MappingLimitSettingsDescriptor : SerializableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/IngestInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/IngestInfo.g.cs index fed73dac31..45e9a06e27 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/IngestInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/IngestInfo.g.cs @@ -31,6 +31,8 @@ public sealed partial class IngestInfo { [JsonInclude, JsonPropertyName("pipeline")] public string? Pipeline { get; init; } + [JsonInclude, JsonPropertyName("_redact")] + public Elastic.Clients.Elasticsearch.Ingest.Redact? Redact { get; init; } [JsonInclude, JsonPropertyName("timestamp")] public DateTimeOffset Timestamp { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/IpLocationProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/IpLocationProcessor.g.cs new file mode 100644 index 0000000000..c6691f1eb0 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/IpLocationProcessor.g.cs @@ -0,0 +1,798 @@ +// 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.Ingest; + +public sealed partial class IpLocationProcessor +{ + /// + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// + /// + [JsonInclude, JsonPropertyName("database_file")] + public string? DatabaseFile { get; set; } + + /// + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// + /// + [JsonInclude, JsonPropertyName("description")] + public string? Description { get; set; } + + /// + /// + /// If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. + /// Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index. + /// + /// + [JsonInclude, JsonPropertyName("download_database_on_pipeline_creation")] + public bool? DownloadDatabaseOnPipelineCreation { 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 IP location data will be returned, even if the field contains an array. + /// + /// + [JsonInclude, JsonPropertyName("first_only")] + public bool? FirstOnly { get; set; } + + /// + /// + /// Conditionally execute the processor. + /// + /// + [JsonInclude, JsonPropertyName("if")] + public string? If { get; set; } + + /// + /// + /// Ignore failures for the processor. + /// + /// + [JsonInclude, JsonPropertyName("ignore_failure")] + public bool? IgnoreFailure { get; set; } + + /// + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// + /// + [JsonInclude, JsonPropertyName("ignore_missing")] + public bool? IgnoreMissing { get; set; } + + /// + /// + /// Handle failures for the processor. + /// + /// + [JsonInclude, JsonPropertyName("on_failure")] + public ICollection? OnFailure { get; set; } + + /// + /// + /// Controls what properties are added to the target_field based on the IP location lookup. + /// + /// + [JsonInclude, JsonPropertyName("properties")] + public ICollection? Properties { get; set; } + + /// + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// + /// + [JsonInclude, JsonPropertyName("tag")] + public string? Tag { get; set; } + + /// + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// + [JsonInclude, JsonPropertyName("target_field")] + public Elastic.Clients.Elasticsearch.Field? TargetField { get; set; } + + public static implicit operator Elastic.Clients.Elasticsearch.Ingest.Processor(IpLocationProcessor ipLocationProcessor) => Elastic.Clients.Elasticsearch.Ingest.Processor.IpLocation(ipLocationProcessor); +} + +public sealed partial class IpLocationProcessorDescriptor : SerializableDescriptor> +{ + internal IpLocationProcessorDescriptor(Action> configure) => configure.Invoke(this); + + public IpLocationProcessorDescriptor() : base() + { + } + + private string? DatabaseFileValue { get; set; } + private string? DescriptionValue { get; set; } + private bool? DownloadDatabaseOnPipelineCreationValue { get; set; } + private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } + private bool? FirstOnlyValue { get; set; } + private string? IfValue { get; set; } + private bool? IgnoreFailureValue { get; set; } + private bool? IgnoreMissingValue { get; set; } + private ICollection? OnFailureValue { get; set; } + private Elastic.Clients.Elasticsearch.Ingest.ProcessorDescriptor OnFailureDescriptor { get; set; } + private Action> OnFailureDescriptorAction { get; set; } + private Action>[] OnFailureDescriptorActions { get; set; } + private ICollection? PropertiesValue { get; set; } + private string? TagValue { get; set; } + private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } + + /// + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// + /// + public IpLocationProcessorDescriptor DatabaseFile(string? databaseFile) + { + DatabaseFileValue = databaseFile; + return Self; + } + + /// + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// + /// + public IpLocationProcessorDescriptor Description(string? description) + { + DescriptionValue = description; + return Self; + } + + /// + /// + /// If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. + /// Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index. + /// + /// + public IpLocationProcessorDescriptor DownloadDatabaseOnPipelineCreation(bool? downloadDatabaseOnPipelineCreation = true) + { + DownloadDatabaseOnPipelineCreationValue = downloadDatabaseOnPipelineCreation; + return Self; + } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + public IpLocationProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + public IpLocationProcessorDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + public IpLocationProcessorDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// If true, only the first found IP location data will be returned, even if the field contains an array. + /// + /// + public IpLocationProcessorDescriptor FirstOnly(bool? firstOnly = true) + { + FirstOnlyValue = firstOnly; + return Self; + } + + /// + /// + /// Conditionally execute the processor. + /// + /// + public IpLocationProcessorDescriptor If(string? value) + { + IfValue = value; + return Self; + } + + /// + /// + /// Ignore failures for the processor. + /// + /// + public IpLocationProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) + { + IgnoreFailureValue = ignoreFailure; + return Self; + } + + /// + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// + /// + public IpLocationProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) + { + IgnoreMissingValue = ignoreMissing; + return Self; + } + + /// + /// + /// Handle failures for the processor. + /// + /// + public IpLocationProcessorDescriptor OnFailure(ICollection? onFailure) + { + OnFailureDescriptor = null; + OnFailureDescriptorAction = null; + OnFailureDescriptorActions = null; + OnFailureValue = onFailure; + return Self; + } + + public IpLocationProcessorDescriptor OnFailure(Elastic.Clients.Elasticsearch.Ingest.ProcessorDescriptor descriptor) + { + OnFailureValue = null; + OnFailureDescriptorAction = null; + OnFailureDescriptorActions = null; + OnFailureDescriptor = descriptor; + return Self; + } + + public IpLocationProcessorDescriptor OnFailure(Action> configure) + { + OnFailureValue = null; + OnFailureDescriptor = null; + OnFailureDescriptorActions = null; + OnFailureDescriptorAction = configure; + return Self; + } + + public IpLocationProcessorDescriptor OnFailure(params Action>[] configure) + { + OnFailureValue = null; + OnFailureDescriptor = null; + OnFailureDescriptorAction = null; + OnFailureDescriptorActions = configure; + return Self; + } + + /// + /// + /// Controls what properties are added to the target_field based on the IP location lookup. + /// + /// + public IpLocationProcessorDescriptor Properties(ICollection? properties) + { + PropertiesValue = properties; + return Self; + } + + /// + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// + /// + public IpLocationProcessorDescriptor Tag(string? tag) + { + TagValue = tag; + return Self; + } + + /// + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// + public IpLocationProcessorDescriptor 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 IpLocationProcessorDescriptor TargetField(Expression> targetField) + { + TargetFieldValue = targetField; + return Self; + } + + /// + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// + public IpLocationProcessorDescriptor TargetField(Expression> targetField) + { + TargetFieldValue = targetField; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(DatabaseFileValue)) + { + writer.WritePropertyName("database_file"); + writer.WriteStringValue(DatabaseFileValue); + } + + if (!string.IsNullOrEmpty(DescriptionValue)) + { + writer.WritePropertyName("description"); + writer.WriteStringValue(DescriptionValue); + } + + if (DownloadDatabaseOnPipelineCreationValue.HasValue) + { + writer.WritePropertyName("download_database_on_pipeline_creation"); + writer.WriteBooleanValue(DownloadDatabaseOnPipelineCreationValue.Value); + } + + writer.WritePropertyName("field"); + JsonSerializer.Serialize(writer, FieldValue, options); + if (FirstOnlyValue.HasValue) + { + writer.WritePropertyName("first_only"); + writer.WriteBooleanValue(FirstOnlyValue.Value); + } + + if (!string.IsNullOrEmpty(IfValue)) + { + writer.WritePropertyName("if"); + writer.WriteStringValue(IfValue); + } + + if (IgnoreFailureValue.HasValue) + { + writer.WritePropertyName("ignore_failure"); + writer.WriteBooleanValue(IgnoreFailureValue.Value); + } + + if (IgnoreMissingValue.HasValue) + { + writer.WritePropertyName("ignore_missing"); + writer.WriteBooleanValue(IgnoreMissingValue.Value); + } + + if (OnFailureDescriptor is not null) + { + writer.WritePropertyName("on_failure"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, OnFailureDescriptor, options); + writer.WriteEndArray(); + } + else if (OnFailureDescriptorAction is not null) + { + writer.WritePropertyName("on_failure"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Ingest.ProcessorDescriptor(OnFailureDescriptorAction), options); + writer.WriteEndArray(); + } + else if (OnFailureDescriptorActions is not null) + { + writer.WritePropertyName("on_failure"); + writer.WriteStartArray(); + foreach (var action in OnFailureDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Ingest.ProcessorDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (OnFailureValue is not null) + { + writer.WritePropertyName("on_failure"); + JsonSerializer.Serialize(writer, OnFailureValue, options); + } + + if (PropertiesValue is not null) + { + writer.WritePropertyName("properties"); + JsonSerializer.Serialize(writer, PropertiesValue, options); + } + + if (!string.IsNullOrEmpty(TagValue)) + { + writer.WritePropertyName("tag"); + writer.WriteStringValue(TagValue); + } + + if (TargetFieldValue is not null) + { + writer.WritePropertyName("target_field"); + JsonSerializer.Serialize(writer, TargetFieldValue, options); + } + + writer.WriteEndObject(); + } +} + +public sealed partial class IpLocationProcessorDescriptor : SerializableDescriptor +{ + internal IpLocationProcessorDescriptor(Action configure) => configure.Invoke(this); + + public IpLocationProcessorDescriptor() : base() + { + } + + private string? DatabaseFileValue { get; set; } + private string? DescriptionValue { get; set; } + private bool? DownloadDatabaseOnPipelineCreationValue { get; set; } + private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } + private bool? FirstOnlyValue { get; set; } + private string? IfValue { get; set; } + private bool? IgnoreFailureValue { get; set; } + private bool? IgnoreMissingValue { get; set; } + private ICollection? OnFailureValue { get; set; } + private Elastic.Clients.Elasticsearch.Ingest.ProcessorDescriptor OnFailureDescriptor { get; set; } + private Action OnFailureDescriptorAction { get; set; } + private Action[] OnFailureDescriptorActions { get; set; } + private ICollection? PropertiesValue { get; set; } + private string? TagValue { get; set; } + private Elastic.Clients.Elasticsearch.Field? TargetFieldValue { get; set; } + + /// + /// + /// The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + /// + /// + public IpLocationProcessorDescriptor DatabaseFile(string? databaseFile) + { + DatabaseFileValue = databaseFile; + return Self; + } + + /// + /// + /// Description of the processor. + /// Useful for describing the purpose of the processor or its configuration. + /// + /// + public IpLocationProcessorDescriptor Description(string? description) + { + DescriptionValue = description; + return Self; + } + + /// + /// + /// If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. + /// Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index. + /// + /// + public IpLocationProcessorDescriptor DownloadDatabaseOnPipelineCreation(bool? downloadDatabaseOnPipelineCreation = true) + { + DownloadDatabaseOnPipelineCreationValue = downloadDatabaseOnPipelineCreation; + return Self; + } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + public IpLocationProcessorDescriptor Field(Elastic.Clients.Elasticsearch.Field field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + public IpLocationProcessorDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// The field to get the ip address from for the geographical lookup. + /// + /// + public IpLocationProcessorDescriptor Field(Expression> field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// If true, only the first found IP location data will be returned, even if the field contains an array. + /// + /// + public IpLocationProcessorDescriptor FirstOnly(bool? firstOnly = true) + { + FirstOnlyValue = firstOnly; + return Self; + } + + /// + /// + /// Conditionally execute the processor. + /// + /// + public IpLocationProcessorDescriptor If(string? value) + { + IfValue = value; + return Self; + } + + /// + /// + /// Ignore failures for the processor. + /// + /// + public IpLocationProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true) + { + IgnoreFailureValue = ignoreFailure; + return Self; + } + + /// + /// + /// If true and field does not exist, the processor quietly exits without modifying the document. + /// + /// + public IpLocationProcessorDescriptor IgnoreMissing(bool? ignoreMissing = true) + { + IgnoreMissingValue = ignoreMissing; + return Self; + } + + /// + /// + /// Handle failures for the processor. + /// + /// + public IpLocationProcessorDescriptor OnFailure(ICollection? onFailure) + { + OnFailureDescriptor = null; + OnFailureDescriptorAction = null; + OnFailureDescriptorActions = null; + OnFailureValue = onFailure; + return Self; + } + + public IpLocationProcessorDescriptor OnFailure(Elastic.Clients.Elasticsearch.Ingest.ProcessorDescriptor descriptor) + { + OnFailureValue = null; + OnFailureDescriptorAction = null; + OnFailureDescriptorActions = null; + OnFailureDescriptor = descriptor; + return Self; + } + + public IpLocationProcessorDescriptor OnFailure(Action configure) + { + OnFailureValue = null; + OnFailureDescriptor = null; + OnFailureDescriptorActions = null; + OnFailureDescriptorAction = configure; + return Self; + } + + public IpLocationProcessorDescriptor OnFailure(params Action[] configure) + { + OnFailureValue = null; + OnFailureDescriptor = null; + OnFailureDescriptorAction = null; + OnFailureDescriptorActions = configure; + return Self; + } + + /// + /// + /// Controls what properties are added to the target_field based on the IP location lookup. + /// + /// + public IpLocationProcessorDescriptor Properties(ICollection? properties) + { + PropertiesValue = properties; + return Self; + } + + /// + /// + /// Identifier for the processor. + /// Useful for debugging and metrics. + /// + /// + public IpLocationProcessorDescriptor Tag(string? tag) + { + TagValue = tag; + return Self; + } + + /// + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// + public IpLocationProcessorDescriptor 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 IpLocationProcessorDescriptor TargetField(Expression> targetField) + { + TargetFieldValue = targetField; + return Self; + } + + /// + /// + /// The field that will hold the geographical information looked up from the MaxMind database. + /// + /// + public IpLocationProcessorDescriptor TargetField(Expression> targetField) + { + TargetFieldValue = targetField; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(DatabaseFileValue)) + { + writer.WritePropertyName("database_file"); + writer.WriteStringValue(DatabaseFileValue); + } + + if (!string.IsNullOrEmpty(DescriptionValue)) + { + writer.WritePropertyName("description"); + writer.WriteStringValue(DescriptionValue); + } + + if (DownloadDatabaseOnPipelineCreationValue.HasValue) + { + writer.WritePropertyName("download_database_on_pipeline_creation"); + writer.WriteBooleanValue(DownloadDatabaseOnPipelineCreationValue.Value); + } + + writer.WritePropertyName("field"); + JsonSerializer.Serialize(writer, FieldValue, options); + if (FirstOnlyValue.HasValue) + { + writer.WritePropertyName("first_only"); + writer.WriteBooleanValue(FirstOnlyValue.Value); + } + + if (!string.IsNullOrEmpty(IfValue)) + { + writer.WritePropertyName("if"); + writer.WriteStringValue(IfValue); + } + + if (IgnoreFailureValue.HasValue) + { + writer.WritePropertyName("ignore_failure"); + writer.WriteBooleanValue(IgnoreFailureValue.Value); + } + + if (IgnoreMissingValue.HasValue) + { + writer.WritePropertyName("ignore_missing"); + writer.WriteBooleanValue(IgnoreMissingValue.Value); + } + + if (OnFailureDescriptor is not null) + { + writer.WritePropertyName("on_failure"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, OnFailureDescriptor, options); + writer.WriteEndArray(); + } + else if (OnFailureDescriptorAction is not null) + { + writer.WritePropertyName("on_failure"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Ingest.ProcessorDescriptor(OnFailureDescriptorAction), options); + writer.WriteEndArray(); + } + else if (OnFailureDescriptorActions is not null) + { + writer.WritePropertyName("on_failure"); + writer.WriteStartArray(); + foreach (var action in OnFailureDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Ingest.ProcessorDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (OnFailureValue is not null) + { + writer.WritePropertyName("on_failure"); + JsonSerializer.Serialize(writer, OnFailureValue, options); + } + + if (PropertiesValue is not null) + { + writer.WritePropertyName("properties"); + JsonSerializer.Serialize(writer, PropertiesValue, options); + } + + if (!string.IsNullOrEmpty(TagValue)) + { + writer.WritePropertyName("tag"); + writer.WriteStringValue(TagValue); + } + + if (TargetFieldValue is not null) + { + writer.WritePropertyName("target_field"); + JsonSerializer.Serialize(writer, TargetFieldValue, options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Processor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Processor.g.cs index d8402c2281..b7020c13d1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Processor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Processor.g.cs @@ -68,6 +68,7 @@ internal Processor(string variantName, object variant) public static Processor Gsub(Elastic.Clients.Elasticsearch.Ingest.GsubProcessor gsubProcessor) => new Processor("gsub", gsubProcessor); public static Processor HtmlStrip(Elastic.Clients.Elasticsearch.Ingest.HtmlStripProcessor htmlStripProcessor) => new Processor("html_strip", htmlStripProcessor); public static Processor Inference(Elastic.Clients.Elasticsearch.Ingest.InferenceProcessor inferenceProcessor) => new Processor("inference", inferenceProcessor); + public static Processor IpLocation(Elastic.Clients.Elasticsearch.Ingest.IpLocationProcessor ipLocationProcessor) => new Processor("ip_location", ipLocationProcessor); public static Processor Join(Elastic.Clients.Elasticsearch.Ingest.JoinProcessor joinProcessor) => new Processor("join", joinProcessor); public static Processor Json(Elastic.Clients.Elasticsearch.Ingest.JsonProcessor jsonProcessor) => new Processor("json", jsonProcessor); public static Processor Kv(Elastic.Clients.Elasticsearch.Ingest.KeyValueProcessor keyValueProcessor) => new Processor("kv", keyValueProcessor); @@ -283,6 +284,13 @@ public override Processor Read(ref Utf8JsonReader reader, Type typeToConvert, Js continue; } + if (propertyName == "ip_location") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + if (propertyName == "join") { variantValue = JsonSerializer.Deserialize(ref reader, options); @@ -518,6 +526,9 @@ public override void Write(Utf8JsonWriter writer, Processor value, JsonSerialize case "inference": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Ingest.InferenceProcessor)value.Variant, options); break; + case "ip_location": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Ingest.IpLocationProcessor)value.Variant, options); + break; case "join": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Ingest.JoinProcessor)value.Variant, options); break; @@ -666,6 +677,8 @@ private ProcessorDescriptor Set(object variant, string variantName) public ProcessorDescriptor HtmlStrip(Action> configure) => Set(configure, "html_strip"); public ProcessorDescriptor Inference(Elastic.Clients.Elasticsearch.Ingest.InferenceProcessor inferenceProcessor) => Set(inferenceProcessor, "inference"); public ProcessorDescriptor Inference(Action> configure) => Set(configure, "inference"); + public ProcessorDescriptor IpLocation(Elastic.Clients.Elasticsearch.Ingest.IpLocationProcessor ipLocationProcessor) => Set(ipLocationProcessor, "ip_location"); + public ProcessorDescriptor IpLocation(Action> configure) => Set(configure, "ip_location"); public ProcessorDescriptor Join(Elastic.Clients.Elasticsearch.Ingest.JoinProcessor joinProcessor) => Set(joinProcessor, "join"); public ProcessorDescriptor Join(Action> configure) => Set(configure, "join"); public ProcessorDescriptor Json(Elastic.Clients.Elasticsearch.Ingest.JsonProcessor jsonProcessor) => Set(jsonProcessor, "json"); @@ -806,6 +819,8 @@ private ProcessorDescriptor Set(object variant, string variantName) public ProcessorDescriptor HtmlStrip(Action configure) => Set(configure, "html_strip"); public ProcessorDescriptor Inference(Elastic.Clients.Elasticsearch.Ingest.InferenceProcessor inferenceProcessor) => Set(inferenceProcessor, "inference"); public ProcessorDescriptor Inference(Action configure) => Set(configure, "inference"); + public ProcessorDescriptor IpLocation(Elastic.Clients.Elasticsearch.Ingest.IpLocationProcessor ipLocationProcessor) => Set(ipLocationProcessor, "ip_location"); + public ProcessorDescriptor IpLocation(Action configure) => Set(configure, "ip_location"); public ProcessorDescriptor Join(Elastic.Clients.Elasticsearch.Ingest.JoinProcessor joinProcessor) => Set(joinProcessor, "join"); public ProcessorDescriptor Join(Action configure) => Set(configure, "join"); public ProcessorDescriptor Json(Elastic.Clients.Elasticsearch.Ingest.JsonProcessor jsonProcessor) => Set(jsonProcessor, "json"); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Redact.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Redact.g.cs new file mode 100644 index 0000000000..28bfd168d3 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Redact.g.cs @@ -0,0 +1,39 @@ +// 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.Ingest; + +public sealed partial class Redact +{ + /// + /// + /// indicates if document has been redacted + /// + /// + [JsonInclude, JsonPropertyName("_is_redacted")] + public bool IsRedacted { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RedactProcessor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RedactProcessor.g.cs index d5254f4b81..bc07497c73 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RedactProcessor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/RedactProcessor.g.cs @@ -121,6 +121,14 @@ public sealed partial class RedactProcessor [JsonInclude, JsonPropertyName("tag")] public string? Tag { get; set; } + /// + /// + /// If true then ingest metadata _ingest._redact._is_redacted is set to true if the document has been redacted + /// + /// + [JsonInclude, JsonPropertyName("trace_redact")] + public bool? TraceRedact { get; set; } + public static implicit operator Elastic.Clients.Elasticsearch.Ingest.Processor(RedactProcessor redactProcessor) => Elastic.Clients.Elasticsearch.Ingest.Processor.Redact(redactProcessor); } @@ -147,6 +155,7 @@ public RedactProcessorDescriptor() : base() private bool? SkipIfUnlicensedValue { get; set; } private string? SuffixValue { get; set; } private string? TagValue { get; set; } + private bool? TraceRedactValue { get; set; } /// /// @@ -329,6 +338,17 @@ public RedactProcessorDescriptor Tag(string? tag) return Self; } + /// + /// + /// If true then ingest metadata _ingest._redact._is_redacted is set to true if the document has been redacted + /// + /// + public RedactProcessorDescriptor TraceRedact(bool? traceRedact = true) + { + TraceRedactValue = traceRedact; + return Self; + } + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); @@ -421,6 +441,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(TagValue); } + if (TraceRedactValue.HasValue) + { + writer.WritePropertyName("trace_redact"); + writer.WriteBooleanValue(TraceRedactValue.Value); + } + writer.WriteEndObject(); } } @@ -448,6 +474,7 @@ public RedactProcessorDescriptor() : base() private bool? SkipIfUnlicensedValue { get; set; } private string? SuffixValue { get; set; } private string? TagValue { get; set; } + private bool? TraceRedactValue { get; set; } /// /// @@ -630,6 +657,17 @@ public RedactProcessorDescriptor Tag(string? tag) return Self; } + /// + /// + /// If true then ingest metadata _ingest._redact._is_redacted is set to true if the document has been redacted + /// + /// + public RedactProcessorDescriptor TraceRedact(bool? traceRedact = true) + { + TraceRedactValue = traceRedact; + return Self; + } + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); @@ -722,6 +760,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(TagValue); } + if (TraceRedactValue.HasValue) + { + writer.WritePropertyName("trace_redact"); + writer.WriteBooleanValue(TraceRedactValue.Value); + } + writer.WriteEndObject(); } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnRetriever.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnRetriever.g.cs index bd289b0d99..effdb6f24c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnRetriever.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/KnnRetriever.g.cs @@ -54,6 +54,14 @@ public sealed partial class KnnRetriever [JsonInclude, JsonPropertyName("k")] public int k { get; set; } + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + [JsonInclude, JsonPropertyName("min_score")] + public float? MinScore { get; set; } + /// /// /// Number of nearest neighbor candidates to consider per shard. @@ -103,6 +111,7 @@ public KnnRetrieverDescriptor() : base() private Action> FilterDescriptorAction { get; set; } private Action>[] FilterDescriptorActions { get; set; } private int kValue { get; set; } + private float? MinScoreValue { get; set; } private int NumCandidatesValue { get; set; } private ICollection? QueryVectorValue { get; set; } private Elastic.Clients.Elasticsearch.QueryVectorBuilder? QueryVectorBuilderValue { get; set; } @@ -173,6 +182,17 @@ public KnnRetrieverDescriptor k(int k) return Self; } + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public KnnRetrieverDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + /// /// /// Number of nearest neighbor candidates to consider per shard. @@ -271,6 +291,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WritePropertyName("k"); writer.WriteNumberValue(kValue); + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + writer.WritePropertyName("num_candidates"); writer.WriteNumberValue(NumCandidatesValue); if (QueryVectorValue is not null) @@ -319,6 +345,7 @@ public KnnRetrieverDescriptor() : base() private Action FilterDescriptorAction { get; set; } private Action[] FilterDescriptorActions { get; set; } private int kValue { get; set; } + private float? MinScoreValue { get; set; } private int NumCandidatesValue { get; set; } private ICollection? QueryVectorValue { get; set; } private Elastic.Clients.Elasticsearch.QueryVectorBuilder? QueryVectorBuilderValue { get; set; } @@ -389,6 +416,17 @@ public KnnRetrieverDescriptor k(int k) return Self; } + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public KnnRetrieverDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + /// /// /// Number of nearest neighbor candidates to consider per shard. @@ -487,6 +525,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WritePropertyName("k"); writer.WriteNumberValue(kValue); + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + writer.WritePropertyName("num_candidates"); writer.WriteNumberValue(NumCandidatesValue); if (QueryVectorValue is not null) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/GeoShapeProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/GeoShapeProperty.g.cs index 9cf39e57ad..ebe54565c6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/GeoShapeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/GeoShapeProperty.g.cs @@ -32,7 +32,7 @@ namespace Elastic.Clients.Elasticsearch.Mapping; /// The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles /// and polygons. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class GeoShapeProperty : IProperty { @@ -79,7 +79,7 @@ public sealed partial class GeoShapeProperty : IProperty /// The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles /// and polygons. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class GeoShapePropertyDescriptor : SerializableDescriptor>, IBuildableDescriptor { @@ -323,7 +323,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles /// and polygons. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class GeoShapePropertyDescriptor : SerializableDescriptor, IBuildableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ShapeProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ShapeProperty.g.cs index 85c4315328..a2ecda6f0e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ShapeProperty.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/ShapeProperty.g.cs @@ -32,7 +32,7 @@ namespace Elastic.Clients.Elasticsearch.Mapping; /// The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as /// rectangles and polygons. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ShapeProperty : IProperty { @@ -77,7 +77,7 @@ public sealed partial class ShapeProperty : IProperty /// The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as /// rectangles and polygons. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ShapePropertyDescriptor : SerializableDescriptor>, IBuildableDescriptor { @@ -307,7 +307,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as /// rectangles and polygons. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class ShapePropertyDescriptor : SerializableDescriptor, IBuildableDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Like.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Like.g.cs index 7fe667bd3b..d5d33af4a5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Like.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Like.g.cs @@ -34,7 +34,7 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; /// /// Text that we want similar documents for or a lookup to a document's field for the text. /// -/// Learn more about this API in the Elasticsearch documentation. +/// Learn more about this API in the Elasticsearch documentation. /// public sealed partial class Like : Union { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Query.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Query.g.cs index 2413f3deea..35c8ba7590 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Query.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/Query.g.cs @@ -28,9 +28,6 @@ namespace Elastic.Clients.Elasticsearch.QueryDsl; -/// -/// Learn more about this API in the Elasticsearch documentation. -/// [JsonConverter(typeof(QueryConverter))] public sealed partial class Query { @@ -108,8 +105,6 @@ internal Query(string variantName, object variant) public static Query Term(Elastic.Clients.Elasticsearch.QueryDsl.TermQuery termQuery) => new Query("term", termQuery); public static Query Terms(Elastic.Clients.Elasticsearch.QueryDsl.TermsQuery termsQuery) => new Query("terms", termsQuery); public static Query TermsSet(Elastic.Clients.Elasticsearch.QueryDsl.TermsSetQuery termsSetQuery) => new Query("terms_set", termsSetQuery); - public static Query TextExpansion(Elastic.Clients.Elasticsearch.QueryDsl.TextExpansionQuery textExpansionQuery) => new Query("text_expansion", textExpansionQuery); - public static Query WeightedTokens(Elastic.Clients.Elasticsearch.QueryDsl.WeightedTokensQuery weightedTokensQuery) => new Query("weighted_tokens", weightedTokensQuery); public static Query Wildcard(Elastic.Clients.Elasticsearch.QueryDsl.WildcardQuery wildcardQuery) => new Query("wildcard", wildcardQuery); public static Query Wrapper(Elastic.Clients.Elasticsearch.QueryDsl.WrapperQuery wrapperQuery) => new Query("wrapper", wrapperQuery); @@ -529,20 +524,6 @@ public override Query Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSe continue; } - if (propertyName == "text_expansion") - { - variantValue = JsonSerializer.Deserialize(ref reader, options); - variantNameValue = propertyName; - continue; - } - - if (propertyName == "weighted_tokens") - { - variantValue = JsonSerializer.Deserialize(ref reader, options); - variantNameValue = propertyName; - continue; - } - if (propertyName == "wildcard") { variantValue = JsonSerializer.Deserialize(ref reader, options); @@ -734,12 +715,6 @@ public override void Write(Utf8JsonWriter writer, Query value, JsonSerializerOpt case "terms_set": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.QueryDsl.TermsSetQuery)value.Variant, options); break; - case "text_expansion": - JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.QueryDsl.TextExpansionQuery)value.Variant, options); - break; - case "weighted_tokens": - JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.QueryDsl.WeightedTokensQuery)value.Variant, options); - break; case "wildcard": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.QueryDsl.WildcardQuery)value.Variant, options); break; @@ -894,10 +869,6 @@ private QueryDescriptor Set(object variant, string variantName) public QueryDescriptor Terms(Action> configure) => Set(configure, "terms"); public QueryDescriptor TermsSet(Elastic.Clients.Elasticsearch.QueryDsl.TermsSetQuery termsSetQuery) => Set(termsSetQuery, "terms_set"); public QueryDescriptor TermsSet(Action> configure) => Set(configure, "terms_set"); - public QueryDescriptor TextExpansion(Elastic.Clients.Elasticsearch.QueryDsl.TextExpansionQuery textExpansionQuery) => Set(textExpansionQuery, "text_expansion"); - public QueryDescriptor TextExpansion(Action> configure) => Set(configure, "text_expansion"); - public QueryDescriptor WeightedTokens(Elastic.Clients.Elasticsearch.QueryDsl.WeightedTokensQuery weightedTokensQuery) => Set(weightedTokensQuery, "weighted_tokens"); - public QueryDescriptor WeightedTokens(Action> configure) => Set(configure, "weighted_tokens"); public QueryDescriptor Wildcard(Elastic.Clients.Elasticsearch.QueryDsl.WildcardQuery wildcardQuery) => Set(wildcardQuery, "wildcard"); public QueryDescriptor Wildcard(Action> configure) => Set(configure, "wildcard"); public QueryDescriptor Wrapper(Elastic.Clients.Elasticsearch.QueryDsl.WrapperQuery wrapperQuery) => Set(wrapperQuery, "wrapper"); @@ -1064,10 +1035,6 @@ private QueryDescriptor Set(object variant, string variantName) public QueryDescriptor Terms(Action configure) => Set(configure, "terms"); public QueryDescriptor TermsSet(Elastic.Clients.Elasticsearch.QueryDsl.TermsSetQuery termsSetQuery) => Set(termsSetQuery, "terms_set"); public QueryDescriptor TermsSet(Action configure) => Set(configure, "terms_set"); - public QueryDescriptor TextExpansion(Elastic.Clients.Elasticsearch.QueryDsl.TextExpansionQuery textExpansionQuery) => Set(textExpansionQuery, "text_expansion"); - public QueryDescriptor TextExpansion(Action configure) => Set(configure, "text_expansion"); - public QueryDescriptor WeightedTokens(Elastic.Clients.Elasticsearch.QueryDsl.WeightedTokensQuery weightedTokensQuery) => Set(weightedTokensQuery, "weighted_tokens"); - public QueryDescriptor WeightedTokens(Action configure) => Set(configure, "weighted_tokens"); public QueryDescriptor Wildcard(Elastic.Clients.Elasticsearch.QueryDsl.WildcardQuery wildcardQuery) => Set(wildcardQuery, "wildcard"); public QueryDescriptor Wildcard(Action configure) => Set(configure, "wildcard"); public QueryDescriptor Wrapper(Elastic.Clients.Elasticsearch.QueryDsl.WrapperQuery wrapperQuery) => Set(wrapperQuery, "wrapper"); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsQuery.g.cs index d3e4b3079a..a56cf45860 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermsQuery.g.cs @@ -53,7 +53,7 @@ public override TermsQuery Read(ref Utf8JsonReader reader, Type typeToConvert, J variant.Field = property; reader.Read(); - variant.Term = JsonSerializer.Deserialize(ref reader, options); + variant.Terms = JsonSerializer.Deserialize(ref reader, options); } } @@ -63,7 +63,7 @@ public override TermsQuery Read(ref Utf8JsonReader reader, Type typeToConvert, J public override void Write(Utf8JsonWriter writer, TermsQuery value, JsonSerializerOptions options) { writer.WriteStartObject(); - if (value.Field is not null && value.Term is not null) + if (value.Field is not null && value.Terms is not null) { if (!options.TryGetClientSettings(out var settings)) { @@ -72,7 +72,7 @@ public override void Write(Utf8JsonWriter writer, TermsQuery value, JsonSerializ var propertyName = settings.Inferrer.Field(value.Field); writer.WritePropertyName(propertyName); - JsonSerializer.Serialize(writer, value.Term, options); + JsonSerializer.Serialize(writer, value.Terms, options); } if (value.Boost.HasValue) @@ -105,7 +105,7 @@ public sealed partial class TermsQuery public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } public string? QueryName { get; set; } - public Elastic.Clients.Elasticsearch.QueryDsl.TermsQueryField Term { get; set; } + public Elastic.Clients.Elasticsearch.QueryDsl.TermsQueryField Terms { get; set; } public static implicit operator Elastic.Clients.Elasticsearch.QueryDsl.Query(TermsQuery termsQuery) => Elastic.Clients.Elasticsearch.QueryDsl.Query.Terms(termsQuery); public static implicit operator Elastic.Clients.Elasticsearch.Security.ApiKeyQuery(TermsQuery termsQuery) => Elastic.Clients.Elasticsearch.Security.ApiKeyQuery.Terms(termsQuery); @@ -124,7 +124,7 @@ public TermsQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } private string? QueryNameValue { get; set; } - private Elastic.Clients.Elasticsearch.QueryDsl.TermsQueryField TermValue { get; set; } + private Elastic.Clients.Elasticsearch.QueryDsl.TermsQueryField TermsValue { get; set; } /// /// @@ -164,20 +164,20 @@ public TermsQueryDescriptor QueryName(string? queryName) return Self; } - public TermsQueryDescriptor Term(Elastic.Clients.Elasticsearch.QueryDsl.TermsQueryField term) + public TermsQueryDescriptor Terms(Elastic.Clients.Elasticsearch.QueryDsl.TermsQueryField terms) { - TermValue = term; + TermsValue = terms; return Self; } protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); - if (FieldValue is not null && TermValue is not null) + if (FieldValue is not null && TermsValue is not null) { var propertyName = settings.Inferrer.Field(FieldValue); writer.WritePropertyName(propertyName); - JsonSerializer.Serialize(writer, TermValue, options); + JsonSerializer.Serialize(writer, TermsValue, options); } if (BoostValue.HasValue) @@ -207,7 +207,7 @@ public TermsQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } private string? QueryNameValue { get; set; } - private Elastic.Clients.Elasticsearch.QueryDsl.TermsQueryField TermValue { get; set; } + private Elastic.Clients.Elasticsearch.QueryDsl.TermsQueryField TermsValue { get; set; } /// /// @@ -247,20 +247,20 @@ public TermsQueryDescriptor QueryName(string? queryName) return Self; } - public TermsQueryDescriptor Term(Elastic.Clients.Elasticsearch.QueryDsl.TermsQueryField term) + public TermsQueryDescriptor Terms(Elastic.Clients.Elasticsearch.QueryDsl.TermsQueryField terms) { - TermValue = term; + TermsValue = terms; return Self; } protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); - if (FieldValue is not null && TermValue is not null) + if (FieldValue is not null && TermsValue is not null) { var propertyName = settings.Inferrer.Field(FieldValue); writer.WritePropertyName(propertyName); - JsonSerializer.Serialize(writer, TermValue, options); + JsonSerializer.Serialize(writer, TermsValue, options); } if (BoostValue.HasValue) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs deleted file mode 100644 index abe905037f..0000000000 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TextExpansionQuery.g.cs +++ /dev/null @@ -1,461 +0,0 @@ -// 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; - -internal sealed partial class TextExpansionQueryConverter : JsonConverter -{ - public override TextExpansionQuery Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) - { - if (reader.TokenType != JsonTokenType.StartObject) - throw new JsonException("Unexpected JSON detected."); - reader.Read(); - var fieldName = reader.GetString(); - reader.Read(); - var variant = new TextExpansionQuery(fieldName); - while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) - { - if (reader.TokenType == JsonTokenType.PropertyName) - { - var property = reader.GetString(); - if (property == "boost") - { - variant.Boost = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "model_id") - { - variant.ModelId = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "model_text") - { - variant.ModelText = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "pruning_config") - { - variant.PruningConfig = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "_name") - { - variant.QueryName = JsonSerializer.Deserialize(ref reader, options); - continue; - } - } - } - - reader.Read(); - return variant; - } - - public override void Write(Utf8JsonWriter writer, TextExpansionQuery value, JsonSerializerOptions options) - { - if (value.Field is null) - throw new JsonException("Unable to serialize TextExpansionQuery because the `Field` property is not set. Field name queries must include a valid field name."); - if (!options.TryGetClientSettings(out var settings)) - throw new JsonException("Unable to retrieve client settings required to infer field."); - writer.WriteStartObject(); - writer.WritePropertyName(settings.Inferrer.Field(value.Field)); - writer.WriteStartObject(); - if (value.Boost.HasValue) - { - writer.WritePropertyName("boost"); - writer.WriteNumberValue(value.Boost.Value); - } - - writer.WritePropertyName("model_id"); - writer.WriteStringValue(value.ModelId); - writer.WritePropertyName("model_text"); - writer.WriteStringValue(value.ModelText); - if (value.PruningConfig is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, value.PruningConfig, options); - } - - if (!string.IsNullOrEmpty(value.QueryName)) - { - writer.WritePropertyName("_name"); - writer.WriteStringValue(value.QueryName); - } - - writer.WriteEndObject(); - writer.WriteEndObject(); - } -} - -[JsonConverter(typeof(TextExpansionQueryConverter))] -public sealed partial class TextExpansionQuery -{ - public TextExpansionQuery(Elastic.Clients.Elasticsearch.Field field) - { - if (field is null) - throw new ArgumentNullException(nameof(field)); - Field = field; - } - - /// - /// - /// Floating point number used to decrease or increase the relevance scores of the query. - /// Boost values are relative to the default value of 1.0. - /// A boost value between 0 and 1.0 decreases the relevance score. - /// A value greater than 1.0 increases the relevance score. - /// - /// - public float? Boost { get; set; } - public Elastic.Clients.Elasticsearch.Field Field { get; set; } - - /// - /// - /// The text expansion NLP model to use - /// - /// - public string ModelId { get; set; } - - /// - /// - /// The query text - /// - /// - public string ModelText { get; set; } - - /// - /// - /// Token pruning configurations - /// - /// - public Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? PruningConfig { get; set; } - public string? QueryName { get; set; } - - public static implicit operator Elastic.Clients.Elasticsearch.QueryDsl.Query(TextExpansionQuery textExpansionQuery) => Elastic.Clients.Elasticsearch.QueryDsl.Query.TextExpansion(textExpansionQuery); -} - -public sealed partial class TextExpansionQueryDescriptor : SerializableDescriptor> -{ - internal TextExpansionQueryDescriptor(Action> configure) => configure.Invoke(this); - - public TextExpansionQueryDescriptor() : base() - { - } - - private float? BoostValue { get; set; } - private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } - private string ModelIdValue { get; set; } - private string ModelTextValue { get; set; } - private Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? PruningConfigValue { get; set; } - private Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfigDescriptor PruningConfigDescriptor { get; set; } - private Action PruningConfigDescriptorAction { get; set; } - private string? QueryNameValue { get; set; } - - /// - /// - /// Floating point number used to decrease or increase the relevance scores of the query. - /// Boost values are relative to the default value of 1.0. - /// A boost value between 0 and 1.0 decreases the relevance score. - /// A value greater than 1.0 increases the relevance score. - /// - /// - public TextExpansionQueryDescriptor Boost(float? boost) - { - BoostValue = boost; - return Self; - } - - public TextExpansionQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) - { - FieldValue = field; - return Self; - } - - public TextExpansionQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - public TextExpansionQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - /// - /// - /// The text expansion NLP model to use - /// - /// - public TextExpansionQueryDescriptor ModelId(string modelId) - { - ModelIdValue = modelId; - return Self; - } - - /// - /// - /// The query text - /// - /// - public TextExpansionQueryDescriptor ModelText(string modelText) - { - ModelTextValue = modelText; - return Self; - } - - /// - /// - /// Token pruning configurations - /// - /// - public TextExpansionQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? pruningConfig) - { - PruningConfigDescriptor = null; - PruningConfigDescriptorAction = null; - PruningConfigValue = pruningConfig; - return Self; - } - - public TextExpansionQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfigDescriptor descriptor) - { - PruningConfigValue = null; - PruningConfigDescriptorAction = null; - PruningConfigDescriptor = descriptor; - return Self; - } - - public TextExpansionQueryDescriptor PruningConfig(Action configure) - { - PruningConfigValue = null; - PruningConfigDescriptor = null; - PruningConfigDescriptorAction = configure; - return Self; - } - - public TextExpansionQueryDescriptor QueryName(string? queryName) - { - QueryNameValue = queryName; - return Self; - } - - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) - { - if (FieldValue is null) - throw new JsonException("Unable to serialize field name query descriptor with a null field. Ensure you use a suitable descriptor constructor or call the Field method, passing a non-null value for the field argument."); - writer.WriteStartObject(); - writer.WritePropertyName(settings.Inferrer.Field(FieldValue)); - writer.WriteStartObject(); - if (BoostValue.HasValue) - { - writer.WritePropertyName("boost"); - writer.WriteNumberValue(BoostValue.Value); - } - - writer.WritePropertyName("model_id"); - writer.WriteStringValue(ModelIdValue); - writer.WritePropertyName("model_text"); - writer.WriteStringValue(ModelTextValue); - if (PruningConfigDescriptor is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, PruningConfigDescriptor, options); - } - else if (PruningConfigDescriptorAction is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfigDescriptor(PruningConfigDescriptorAction), options); - } - else if (PruningConfigValue is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, PruningConfigValue, options); - } - - if (!string.IsNullOrEmpty(QueryNameValue)) - { - writer.WritePropertyName("_name"); - writer.WriteStringValue(QueryNameValue); - } - - writer.WriteEndObject(); - writer.WriteEndObject(); - } -} - -public sealed partial class TextExpansionQueryDescriptor : SerializableDescriptor -{ - internal TextExpansionQueryDescriptor(Action configure) => configure.Invoke(this); - - public TextExpansionQueryDescriptor() : base() - { - } - - private float? BoostValue { get; set; } - private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } - private string ModelIdValue { get; set; } - private string ModelTextValue { get; set; } - private Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? PruningConfigValue { get; set; } - private Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfigDescriptor PruningConfigDescriptor { get; set; } - private Action PruningConfigDescriptorAction { get; set; } - private string? QueryNameValue { get; set; } - - /// - /// - /// Floating point number used to decrease or increase the relevance scores of the query. - /// Boost values are relative to the default value of 1.0. - /// A boost value between 0 and 1.0 decreases the relevance score. - /// A value greater than 1.0 increases the relevance score. - /// - /// - public TextExpansionQueryDescriptor Boost(float? boost) - { - BoostValue = boost; - return Self; - } - - public TextExpansionQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) - { - FieldValue = field; - return Self; - } - - public TextExpansionQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - public TextExpansionQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - /// - /// - /// The text expansion NLP model to use - /// - /// - public TextExpansionQueryDescriptor ModelId(string modelId) - { - ModelIdValue = modelId; - return Self; - } - - /// - /// - /// The query text - /// - /// - public TextExpansionQueryDescriptor ModelText(string modelText) - { - ModelTextValue = modelText; - return Self; - } - - /// - /// - /// Token pruning configurations - /// - /// - public TextExpansionQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? pruningConfig) - { - PruningConfigDescriptor = null; - PruningConfigDescriptorAction = null; - PruningConfigValue = pruningConfig; - return Self; - } - - public TextExpansionQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfigDescriptor descriptor) - { - PruningConfigValue = null; - PruningConfigDescriptorAction = null; - PruningConfigDescriptor = descriptor; - return Self; - } - - public TextExpansionQueryDescriptor PruningConfig(Action configure) - { - PruningConfigValue = null; - PruningConfigDescriptor = null; - PruningConfigDescriptorAction = configure; - return Self; - } - - public TextExpansionQueryDescriptor QueryName(string? queryName) - { - QueryNameValue = queryName; - return Self; - } - - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) - { - if (FieldValue is null) - throw new JsonException("Unable to serialize field name query descriptor with a null field. Ensure you use a suitable descriptor constructor or call the Field method, passing a non-null value for the field argument."); - writer.WriteStartObject(); - writer.WritePropertyName(settings.Inferrer.Field(FieldValue)); - writer.WriteStartObject(); - if (BoostValue.HasValue) - { - writer.WritePropertyName("boost"); - writer.WriteNumberValue(BoostValue.Value); - } - - writer.WritePropertyName("model_id"); - writer.WriteStringValue(ModelIdValue); - writer.WritePropertyName("model_text"); - writer.WriteStringValue(ModelTextValue); - if (PruningConfigDescriptor is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, PruningConfigDescriptor, options); - } - else if (PruningConfigDescriptorAction is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfigDescriptor(PruningConfigDescriptorAction), options); - } - else if (PruningConfigValue is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, PruningConfigValue, options); - } - - if (!string.IsNullOrEmpty(QueryNameValue)) - { - writer.WritePropertyName("_name"); - writer.WriteStringValue(QueryNameValue); - } - - writer.WriteEndObject(); - writer.WriteEndObject(); - } -} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs deleted file mode 100644 index dccca3386f..0000000000 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/WeightedTokensQuery.g.cs +++ /dev/null @@ -1,418 +0,0 @@ -// 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; - -internal sealed partial class WeightedTokensQueryConverter : JsonConverter -{ - public override WeightedTokensQuery Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) - { - if (reader.TokenType != JsonTokenType.StartObject) - throw new JsonException("Unexpected JSON detected."); - reader.Read(); - var fieldName = reader.GetString(); - reader.Read(); - var variant = new WeightedTokensQuery(fieldName); - while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) - { - if (reader.TokenType == JsonTokenType.PropertyName) - { - var property = reader.GetString(); - if (property == "boost") - { - variant.Boost = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "pruning_config") - { - variant.PruningConfig = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "_name") - { - variant.QueryName = JsonSerializer.Deserialize(ref reader, options); - continue; - } - - if (property == "tokens") - { - variant.Tokens = JsonSerializer.Deserialize>(ref reader, options); - continue; - } - } - } - - reader.Read(); - return variant; - } - - public override void Write(Utf8JsonWriter writer, WeightedTokensQuery value, JsonSerializerOptions options) - { - if (value.Field is null) - throw new JsonException("Unable to serialize WeightedTokensQuery because the `Field` property is not set. Field name queries must include a valid field name."); - if (!options.TryGetClientSettings(out var settings)) - throw new JsonException("Unable to retrieve client settings required to infer field."); - writer.WriteStartObject(); - writer.WritePropertyName(settings.Inferrer.Field(value.Field)); - writer.WriteStartObject(); - if (value.Boost.HasValue) - { - writer.WritePropertyName("boost"); - writer.WriteNumberValue(value.Boost.Value); - } - - if (value.PruningConfig is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, value.PruningConfig, options); - } - - if (!string.IsNullOrEmpty(value.QueryName)) - { - writer.WritePropertyName("_name"); - writer.WriteStringValue(value.QueryName); - } - - writer.WritePropertyName("tokens"); - JsonSerializer.Serialize(writer, value.Tokens, options); - writer.WriteEndObject(); - writer.WriteEndObject(); - } -} - -[JsonConverter(typeof(WeightedTokensQueryConverter))] -public sealed partial class WeightedTokensQuery -{ - public WeightedTokensQuery(Elastic.Clients.Elasticsearch.Field field) - { - if (field is null) - throw new ArgumentNullException(nameof(field)); - Field = field; - } - - /// - /// - /// Floating point number used to decrease or increase the relevance scores of the query. - /// Boost values are relative to the default value of 1.0. - /// A boost value between 0 and 1.0 decreases the relevance score. - /// A value greater than 1.0 increases the relevance score. - /// - /// - public float? Boost { get; set; } - public Elastic.Clients.Elasticsearch.Field Field { get; set; } - - /// - /// - /// Token pruning configurations - /// - /// - public Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? PruningConfig { get; set; } - public string? QueryName { get; set; } - - /// - /// - /// The tokens representing this query - /// - /// - public IDictionary Tokens { get; set; } - - public static implicit operator Elastic.Clients.Elasticsearch.QueryDsl.Query(WeightedTokensQuery weightedTokensQuery) => Elastic.Clients.Elasticsearch.QueryDsl.Query.WeightedTokens(weightedTokensQuery); -} - -public sealed partial class WeightedTokensQueryDescriptor : SerializableDescriptor> -{ - internal WeightedTokensQueryDescriptor(Action> configure) => configure.Invoke(this); - - public WeightedTokensQueryDescriptor() : base() - { - } - - private float? BoostValue { get; set; } - private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } - private Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? PruningConfigValue { get; set; } - private Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfigDescriptor PruningConfigDescriptor { get; set; } - private Action PruningConfigDescriptorAction { get; set; } - private string? QueryNameValue { get; set; } - private IDictionary TokensValue { get; set; } - - /// - /// - /// Floating point number used to decrease or increase the relevance scores of the query. - /// Boost values are relative to the default value of 1.0. - /// A boost value between 0 and 1.0 decreases the relevance score. - /// A value greater than 1.0 increases the relevance score. - /// - /// - public WeightedTokensQueryDescriptor Boost(float? boost) - { - BoostValue = boost; - return Self; - } - - public WeightedTokensQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) - { - FieldValue = field; - return Self; - } - - public WeightedTokensQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - public WeightedTokensQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - /// - /// - /// Token pruning configurations - /// - /// - public WeightedTokensQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? pruningConfig) - { - PruningConfigDescriptor = null; - PruningConfigDescriptorAction = null; - PruningConfigValue = pruningConfig; - return Self; - } - - public WeightedTokensQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfigDescriptor descriptor) - { - PruningConfigValue = null; - PruningConfigDescriptorAction = null; - PruningConfigDescriptor = descriptor; - return Self; - } - - public WeightedTokensQueryDescriptor PruningConfig(Action configure) - { - PruningConfigValue = null; - PruningConfigDescriptor = null; - PruningConfigDescriptorAction = configure; - return Self; - } - - public WeightedTokensQueryDescriptor QueryName(string? queryName) - { - QueryNameValue = queryName; - return Self; - } - - /// - /// - /// The tokens representing this query - /// - /// - public WeightedTokensQueryDescriptor Tokens(Func, FluentDictionary> selector) - { - TokensValue = selector?.Invoke(new FluentDictionary()); - return Self; - } - - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) - { - if (FieldValue is null) - throw new JsonException("Unable to serialize field name query descriptor with a null field. Ensure you use a suitable descriptor constructor or call the Field method, passing a non-null value for the field argument."); - writer.WriteStartObject(); - writer.WritePropertyName(settings.Inferrer.Field(FieldValue)); - writer.WriteStartObject(); - if (BoostValue.HasValue) - { - writer.WritePropertyName("boost"); - writer.WriteNumberValue(BoostValue.Value); - } - - if (PruningConfigDescriptor is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, PruningConfigDescriptor, options); - } - else if (PruningConfigDescriptorAction is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfigDescriptor(PruningConfigDescriptorAction), options); - } - else if (PruningConfigValue is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, PruningConfigValue, options); - } - - if (!string.IsNullOrEmpty(QueryNameValue)) - { - writer.WritePropertyName("_name"); - writer.WriteStringValue(QueryNameValue); - } - - writer.WritePropertyName("tokens"); - JsonSerializer.Serialize(writer, TokensValue, options); - writer.WriteEndObject(); - writer.WriteEndObject(); - } -} - -public sealed partial class WeightedTokensQueryDescriptor : SerializableDescriptor -{ - internal WeightedTokensQueryDescriptor(Action configure) => configure.Invoke(this); - - public WeightedTokensQueryDescriptor() : base() - { - } - - private float? BoostValue { get; set; } - private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } - private Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? PruningConfigValue { get; set; } - private Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfigDescriptor PruningConfigDescriptor { get; set; } - private Action PruningConfigDescriptorAction { get; set; } - private string? QueryNameValue { get; set; } - private IDictionary TokensValue { get; set; } - - /// - /// - /// Floating point number used to decrease or increase the relevance scores of the query. - /// Boost values are relative to the default value of 1.0. - /// A boost value between 0 and 1.0 decreases the relevance score. - /// A value greater than 1.0 increases the relevance score. - /// - /// - public WeightedTokensQueryDescriptor Boost(float? boost) - { - BoostValue = boost; - return Self; - } - - public WeightedTokensQueryDescriptor Field(Elastic.Clients.Elasticsearch.Field field) - { - FieldValue = field; - return Self; - } - - public WeightedTokensQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - public WeightedTokensQueryDescriptor Field(Expression> field) - { - FieldValue = field; - return Self; - } - - /// - /// - /// Token pruning configurations - /// - /// - public WeightedTokensQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfig? pruningConfig) - { - PruningConfigDescriptor = null; - PruningConfigDescriptorAction = null; - PruningConfigValue = pruningConfig; - return Self; - } - - public WeightedTokensQueryDescriptor PruningConfig(Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfigDescriptor descriptor) - { - PruningConfigValue = null; - PruningConfigDescriptorAction = null; - PruningConfigDescriptor = descriptor; - return Self; - } - - public WeightedTokensQueryDescriptor PruningConfig(Action configure) - { - PruningConfigValue = null; - PruningConfigDescriptor = null; - PruningConfigDescriptorAction = configure; - return Self; - } - - public WeightedTokensQueryDescriptor QueryName(string? queryName) - { - QueryNameValue = queryName; - return Self; - } - - /// - /// - /// The tokens representing this query - /// - /// - public WeightedTokensQueryDescriptor Tokens(Func, FluentDictionary> selector) - { - TokensValue = selector?.Invoke(new FluentDictionary()); - return Self; - } - - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) - { - if (FieldValue is null) - throw new JsonException("Unable to serialize field name query descriptor with a null field. Ensure you use a suitable descriptor constructor or call the Field method, passing a non-null value for the field argument."); - writer.WriteStartObject(); - writer.WritePropertyName(settings.Inferrer.Field(FieldValue)); - writer.WriteStartObject(); - if (BoostValue.HasValue) - { - writer.WritePropertyName("boost"); - writer.WriteNumberValue(BoostValue.Value); - } - - if (PruningConfigDescriptor is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, PruningConfigDescriptor, options); - } - else if (PruningConfigDescriptorAction is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.QueryDsl.TokenPruningConfigDescriptor(PruningConfigDescriptorAction), options); - } - else if (PruningConfigValue is not null) - { - writer.WritePropertyName("pruning_config"); - JsonSerializer.Serialize(writer, PruningConfigValue, options); - } - - if (!string.IsNullOrEmpty(QueryNameValue)) - { - writer.WritePropertyName("_name"); - writer.WriteStringValue(QueryNameValue); - } - - writer.WritePropertyName("tokens"); - JsonSerializer.Serialize(writer, TokensValue, options); - writer.WriteEndObject(); - writer.WriteEndObject(); - } -} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryRules/QueryRulesetMatchedRule.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryRules/QueryRulesetMatchedRule.g.cs new file mode 100644 index 0000000000..6fa1ac8699 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryRules/QueryRulesetMatchedRule.g.cs @@ -0,0 +1,47 @@ +// 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.QueryRules; + +public sealed partial class QueryRulesetMatchedRule +{ + /// + /// + /// Rule unique identifier within that ruleset + /// + /// + [JsonInclude, JsonPropertyName("rule_id")] + public string RuleId { get; init; } + + /// + /// + /// Ruleset unique identifier + /// + /// + [JsonInclude, JsonPropertyName("ruleset_id")] + public string RulesetId { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/RRFRetriever.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/RRFRetriever.g.cs index c3a1b401da..62c90d4329 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/RRFRetriever.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/RRFRetriever.g.cs @@ -38,6 +38,14 @@ public sealed partial class RRFRetriever [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] public ICollection? Filter { get; set; } + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + [JsonInclude, JsonPropertyName("min_score")] + public float? MinScore { get; set; } + /// /// /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. @@ -77,6 +85,7 @@ public RRFRetrieverDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor FilterDescriptor { get; set; } private Action> FilterDescriptorAction { get; set; } private Action>[] FilterDescriptorActions { get; set; } + private float? MinScoreValue { get; set; } private int? RankConstantValue { get; set; } private int? RankWindowSizeValue { get; set; } private ICollection RetrieversValue { get; set; } @@ -125,6 +134,17 @@ public RRFRetrieverDescriptor Filter(params Action + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public RRFRetrieverDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + /// /// /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. @@ -220,6 +240,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o SingleOrManySerializationHelper.Serialize(FilterValue, writer, options); } + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + if (RankConstantValue.HasValue) { writer.WritePropertyName("rank_constant"); @@ -279,6 +305,7 @@ public RRFRetrieverDescriptor() : base() private Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor FilterDescriptor { get; set; } private Action FilterDescriptorAction { get; set; } private Action[] FilterDescriptorActions { get; set; } + private float? MinScoreValue { get; set; } private int? RankConstantValue { get; set; } private int? RankWindowSizeValue { get; set; } private ICollection RetrieversValue { get; set; } @@ -327,6 +354,17 @@ public RRFRetrieverDescriptor Filter(params Action + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public RRFRetrieverDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + /// /// /// This value determines how much influence documents in individual result sets per query have over the final ranked result set. @@ -422,6 +460,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o SingleOrManySerializationHelper.Serialize(FilterValue, writer, options); } + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + if (RankConstantValue.HasValue) { writer.WritePropertyName("rank_constant"); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Retriever.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Retriever.g.cs index 797fea39b6..5a79a236a6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Retriever.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Retriever.g.cs @@ -48,7 +48,9 @@ internal Retriever(string variantName, object variant) public static Retriever Knn(Elastic.Clients.Elasticsearch.KnnRetriever knnRetriever) => new Retriever("knn", knnRetriever); public static Retriever Rrf(Elastic.Clients.Elasticsearch.RRFRetriever rRFRetriever) => new Retriever("rrf", rRFRetriever); + public static Retriever Rule(Elastic.Clients.Elasticsearch.RuleRetriever ruleRetriever) => new Retriever("rule", ruleRetriever); public static Retriever Standard(Elastic.Clients.Elasticsearch.StandardRetriever standardRetriever) => new Retriever("standard", standardRetriever); + public static Retriever TextSimilarityReranker(Elastic.Clients.Elasticsearch.TextSimilarityReranker textSimilarityReranker) => new Retriever("text_similarity_reranker", textSimilarityReranker); public bool TryGet([NotNullWhen(true)] out T? result) where T : class { @@ -102,6 +104,13 @@ public override Retriever Read(ref Utf8JsonReader reader, Type typeToConvert, Js continue; } + if (propertyName == "rule") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + if (propertyName == "standard") { variantValue = JsonSerializer.Deserialize(ref reader, options); @@ -109,6 +118,13 @@ public override Retriever Read(ref Utf8JsonReader reader, Type typeToConvert, Js continue; } + if (propertyName == "text_similarity_reranker") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + throw new JsonException($"Unknown property name '{propertyName}' received while deserializing the 'Retriever' from the response."); } @@ -130,9 +146,15 @@ public override void Write(Utf8JsonWriter writer, Retriever value, JsonSerialize case "rrf": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.RRFRetriever)value.Variant, options); break; + case "rule": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.RuleRetriever)value.Variant, options); + break; case "standard": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.StandardRetriever)value.Variant, options); break; + case "text_similarity_reranker": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.TextSimilarityReranker)value.Variant, options); + break; } } @@ -175,8 +197,12 @@ private RetrieverDescriptor Set(object variant, string variantName) public RetrieverDescriptor Knn(Action> configure) => Set(configure, "knn"); public RetrieverDescriptor Rrf(Elastic.Clients.Elasticsearch.RRFRetriever rRFRetriever) => Set(rRFRetriever, "rrf"); public RetrieverDescriptor Rrf(Action> configure) => Set(configure, "rrf"); + public RetrieverDescriptor Rule(Elastic.Clients.Elasticsearch.RuleRetriever ruleRetriever) => Set(ruleRetriever, "rule"); + public RetrieverDescriptor Rule(Action> configure) => Set(configure, "rule"); public RetrieverDescriptor Standard(Elastic.Clients.Elasticsearch.StandardRetriever standardRetriever) => Set(standardRetriever, "standard"); public RetrieverDescriptor Standard(Action> configure) => Set(configure, "standard"); + public RetrieverDescriptor TextSimilarityReranker(Elastic.Clients.Elasticsearch.TextSimilarityReranker textSimilarityReranker) => Set(textSimilarityReranker, "text_similarity_reranker"); + public RetrieverDescriptor TextSimilarityReranker(Action> configure) => Set(configure, "text_similarity_reranker"); protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { @@ -233,8 +259,12 @@ private RetrieverDescriptor Set(object variant, string variantName) public RetrieverDescriptor Knn(Action configure) => Set(configure, "knn"); public RetrieverDescriptor Rrf(Elastic.Clients.Elasticsearch.RRFRetriever rRFRetriever) => Set(rRFRetriever, "rrf"); public RetrieverDescriptor Rrf(Action configure) => Set(configure, "rrf"); + public RetrieverDescriptor Rule(Elastic.Clients.Elasticsearch.RuleRetriever ruleRetriever) => Set(ruleRetriever, "rule"); + public RetrieverDescriptor Rule(Action configure) => Set(configure, "rule"); public RetrieverDescriptor Standard(Elastic.Clients.Elasticsearch.StandardRetriever standardRetriever) => Set(standardRetriever, "standard"); public RetrieverDescriptor Standard(Action configure) => Set(configure, "standard"); + public RetrieverDescriptor TextSimilarityReranker(Elastic.Clients.Elasticsearch.TextSimilarityReranker textSimilarityReranker) => Set(textSimilarityReranker, "text_similarity_reranker"); + public RetrieverDescriptor TextSimilarityReranker(Action configure) => Set(configure, "text_similarity_reranker"); protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/RuleRetriever.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/RuleRetriever.g.cs new file mode 100644 index 0000000000..34346cfb0c --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/RuleRetriever.g.cs @@ -0,0 +1,486 @@ +// 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; + +public sealed partial class RuleRetriever +{ + /// + /// + /// Query to filter the documents that can match. + /// + /// + [JsonInclude, JsonPropertyName("filter")] + [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] + public ICollection? Filter { get; set; } + + /// + /// + /// The match criteria that will determine if a rule in the provided rulesets should be applied. + /// + /// + [JsonInclude, JsonPropertyName("match_criteria")] + public object MatchCriteria { get; set; } + + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + [JsonInclude, JsonPropertyName("min_score")] + public float? MinScore { get; set; } + + /// + /// + /// This value determines the size of the individual result set. + /// + /// + [JsonInclude, JsonPropertyName("rank_window_size")] + public int? RankWindowSize { get; set; } + + /// + /// + /// The retriever whose results rules should be applied to. + /// + /// + [JsonInclude, JsonPropertyName("retriever")] + public Elastic.Clients.Elasticsearch.Retriever Retriever { get; set; } + + /// + /// + /// The ruleset IDs containing the rules this retriever is evaluating against. + /// + /// + [JsonInclude, JsonPropertyName("ruleset_ids")] + public ICollection RulesetIds { get; set; } + + public static implicit operator Elastic.Clients.Elasticsearch.Retriever(RuleRetriever ruleRetriever) => Elastic.Clients.Elasticsearch.Retriever.Rule(ruleRetriever); +} + +public sealed partial class RuleRetrieverDescriptor : SerializableDescriptor> +{ + internal RuleRetrieverDescriptor(Action> configure) => configure.Invoke(this); + + public RuleRetrieverDescriptor() : base() + { + } + + private ICollection? FilterValue { get; set; } + private Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor FilterDescriptor { get; set; } + private Action> FilterDescriptorAction { get; set; } + private Action>[] FilterDescriptorActions { get; set; } + private object MatchCriteriaValue { get; set; } + private float? MinScoreValue { get; set; } + private int? RankWindowSizeValue { get; set; } + private Elastic.Clients.Elasticsearch.Retriever RetrieverValue { get; set; } + private Elastic.Clients.Elasticsearch.RetrieverDescriptor RetrieverDescriptor { get; set; } + private Action> RetrieverDescriptorAction { get; set; } + private ICollection RulesetIdsValue { get; set; } + + /// + /// + /// Query to filter the documents that can match. + /// + /// + public RuleRetrieverDescriptor Filter(ICollection? filter) + { + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterValue = filter; + return Self; + } + + public RuleRetrieverDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor descriptor) + { + FilterValue = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterDescriptor = descriptor; + return Self; + } + + public RuleRetrieverDescriptor Filter(Action> configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorActions = null; + FilterDescriptorAction = configure; + return Self; + } + + public RuleRetrieverDescriptor Filter(params Action>[] configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = configure; + return Self; + } + + /// + /// + /// The match criteria that will determine if a rule in the provided rulesets should be applied. + /// + /// + public RuleRetrieverDescriptor MatchCriteria(object matchCriteria) + { + MatchCriteriaValue = matchCriteria; + return Self; + } + + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public RuleRetrieverDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + + /// + /// + /// This value determines the size of the individual result set. + /// + /// + public RuleRetrieverDescriptor RankWindowSize(int? rankWindowSize) + { + RankWindowSizeValue = rankWindowSize; + return Self; + } + + /// + /// + /// The retriever whose results rules should be applied to. + /// + /// + public RuleRetrieverDescriptor Retriever(Elastic.Clients.Elasticsearch.Retriever retriever) + { + RetrieverDescriptor = null; + RetrieverDescriptorAction = null; + RetrieverValue = retriever; + return Self; + } + + public RuleRetrieverDescriptor Retriever(Elastic.Clients.Elasticsearch.RetrieverDescriptor descriptor) + { + RetrieverValue = null; + RetrieverDescriptorAction = null; + RetrieverDescriptor = descriptor; + return Self; + } + + public RuleRetrieverDescriptor Retriever(Action> configure) + { + RetrieverValue = null; + RetrieverDescriptor = null; + RetrieverDescriptorAction = configure; + return Self; + } + + /// + /// + /// The ruleset IDs containing the rules this retriever is evaluating against. + /// + /// + public RuleRetrieverDescriptor RulesetIds(ICollection rulesetIds) + { + RulesetIdsValue = rulesetIds; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (FilterDescriptor is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, FilterDescriptor, options); + } + else if (FilterDescriptorAction is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor(FilterDescriptorAction), options); + } + else if (FilterDescriptorActions is not null) + { + writer.WritePropertyName("filter"); + if (FilterDescriptorActions.Length != 1) + writer.WriteStartArray(); + foreach (var action in FilterDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor(action), options); + } + + if (FilterDescriptorActions.Length != 1) + writer.WriteEndArray(); + } + else if (FilterValue is not null) + { + writer.WritePropertyName("filter"); + SingleOrManySerializationHelper.Serialize(FilterValue, writer, options); + } + + writer.WritePropertyName("match_criteria"); + JsonSerializer.Serialize(writer, MatchCriteriaValue, options); + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + + if (RankWindowSizeValue.HasValue) + { + writer.WritePropertyName("rank_window_size"); + writer.WriteNumberValue(RankWindowSizeValue.Value); + } + + if (RetrieverDescriptor is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverDescriptor, options); + } + else if (RetrieverDescriptorAction is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.RetrieverDescriptor(RetrieverDescriptorAction), options); + } + else + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverValue, options); + } + + writer.WritePropertyName("ruleset_ids"); + JsonSerializer.Serialize(writer, RulesetIdsValue, options); + writer.WriteEndObject(); + } +} + +public sealed partial class RuleRetrieverDescriptor : SerializableDescriptor +{ + internal RuleRetrieverDescriptor(Action configure) => configure.Invoke(this); + + public RuleRetrieverDescriptor() : base() + { + } + + private ICollection? FilterValue { get; set; } + private Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor FilterDescriptor { get; set; } + private Action FilterDescriptorAction { get; set; } + private Action[] FilterDescriptorActions { get; set; } + private object MatchCriteriaValue { get; set; } + private float? MinScoreValue { get; set; } + private int? RankWindowSizeValue { get; set; } + private Elastic.Clients.Elasticsearch.Retriever RetrieverValue { get; set; } + private Elastic.Clients.Elasticsearch.RetrieverDescriptor RetrieverDescriptor { get; set; } + private Action RetrieverDescriptorAction { get; set; } + private ICollection RulesetIdsValue { get; set; } + + /// + /// + /// Query to filter the documents that can match. + /// + /// + public RuleRetrieverDescriptor Filter(ICollection? filter) + { + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterValue = filter; + return Self; + } + + public RuleRetrieverDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor descriptor) + { + FilterValue = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterDescriptor = descriptor; + return Self; + } + + public RuleRetrieverDescriptor Filter(Action configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorActions = null; + FilterDescriptorAction = configure; + return Self; + } + + public RuleRetrieverDescriptor Filter(params Action[] configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = configure; + return Self; + } + + /// + /// + /// The match criteria that will determine if a rule in the provided rulesets should be applied. + /// + /// + public RuleRetrieverDescriptor MatchCriteria(object matchCriteria) + { + MatchCriteriaValue = matchCriteria; + return Self; + } + + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public RuleRetrieverDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + + /// + /// + /// This value determines the size of the individual result set. + /// + /// + public RuleRetrieverDescriptor RankWindowSize(int? rankWindowSize) + { + RankWindowSizeValue = rankWindowSize; + return Self; + } + + /// + /// + /// The retriever whose results rules should be applied to. + /// + /// + public RuleRetrieverDescriptor Retriever(Elastic.Clients.Elasticsearch.Retriever retriever) + { + RetrieverDescriptor = null; + RetrieverDescriptorAction = null; + RetrieverValue = retriever; + return Self; + } + + public RuleRetrieverDescriptor Retriever(Elastic.Clients.Elasticsearch.RetrieverDescriptor descriptor) + { + RetrieverValue = null; + RetrieverDescriptorAction = null; + RetrieverDescriptor = descriptor; + return Self; + } + + public RuleRetrieverDescriptor Retriever(Action configure) + { + RetrieverValue = null; + RetrieverDescriptor = null; + RetrieverDescriptorAction = configure; + return Self; + } + + /// + /// + /// The ruleset IDs containing the rules this retriever is evaluating against. + /// + /// + public RuleRetrieverDescriptor RulesetIds(ICollection rulesetIds) + { + RulesetIdsValue = rulesetIds; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (FilterDescriptor is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, FilterDescriptor, options); + } + else if (FilterDescriptorAction is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor(FilterDescriptorAction), options); + } + else if (FilterDescriptorActions is not null) + { + writer.WritePropertyName("filter"); + if (FilterDescriptorActions.Length != 1) + writer.WriteStartArray(); + foreach (var action in FilterDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor(action), options); + } + + if (FilterDescriptorActions.Length != 1) + writer.WriteEndArray(); + } + else if (FilterValue is not null) + { + writer.WritePropertyName("filter"); + SingleOrManySerializationHelper.Serialize(FilterValue, writer, options); + } + + writer.WritePropertyName("match_criteria"); + JsonSerializer.Serialize(writer, MatchCriteriaValue, options); + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + + if (RankWindowSizeValue.HasValue) + { + writer.WritePropertyName("rank_window_size"); + writer.WriteNumberValue(RankWindowSizeValue.Value); + } + + if (RetrieverDescriptor is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverDescriptor, options); + } + else if (RetrieverDescriptorAction is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.RetrieverDescriptor(RetrieverDescriptorAction), options); + } + else + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverValue, options); + } + + writer.WritePropertyName("ruleset_ids"); + JsonSerializer.Serialize(writer, RulesetIdsValue, options); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplication.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplication.g.cs index 645430c37b..7dc4df34f8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplication.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplication.g.cs @@ -35,7 +35,7 @@ public sealed partial class SearchApplication /// /// [JsonInclude, JsonPropertyName("analytics_collection_name")] - public Elastic.Clients.Elasticsearch.Name? AnalyticsCollectionName { get; set; } + public string? AnalyticsCollectionName { get; init; } /// /// @@ -43,15 +43,15 @@ public sealed partial class SearchApplication /// /// [JsonInclude, JsonPropertyName("indices")] - public ICollection Indices { get; set; } + public IReadOnlyCollection Indices { get; init; } /// /// - /// Search Application name. + /// Search Application name /// /// [JsonInclude, JsonPropertyName("name")] - public Elastic.Clients.Elasticsearch.Name Name { get; set; } + public string Name { get; init; } /// /// @@ -59,7 +59,7 @@ public sealed partial class SearchApplication /// /// [JsonInclude, JsonPropertyName("template")] - public Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplate? Template { get; set; } + public Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplate? Template { get; init; } /// /// @@ -67,129 +67,5 @@ public sealed partial class SearchApplication /// /// [JsonInclude, JsonPropertyName("updated_at_millis")] - public long UpdatedAtMillis { get; set; } -} - -public sealed partial class SearchApplicationDescriptor : SerializableDescriptor -{ - internal SearchApplicationDescriptor(Action configure) => configure.Invoke(this); - - public SearchApplicationDescriptor() : base() - { - } - - private Elastic.Clients.Elasticsearch.Name? AnalyticsCollectionNameValue { get; set; } - private ICollection IndicesValue { get; set; } - private Elastic.Clients.Elasticsearch.Name NameValue { get; set; } - private Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplate? TemplateValue { get; set; } - private Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplateDescriptor TemplateDescriptor { get; set; } - private Action TemplateDescriptorAction { get; set; } - private long UpdatedAtMillisValue { get; set; } - - /// - /// - /// Analytics collection associated to the Search Application. - /// - /// - public SearchApplicationDescriptor AnalyticsCollectionName(Elastic.Clients.Elasticsearch.Name? analyticsCollectionName) - { - AnalyticsCollectionNameValue = analyticsCollectionName; - return Self; - } - - /// - /// - /// Indices that are part of the Search Application. - /// - /// - public SearchApplicationDescriptor Indices(ICollection indices) - { - IndicesValue = indices; - return Self; - } - - /// - /// - /// Search Application name. - /// - /// - public SearchApplicationDescriptor Name(Elastic.Clients.Elasticsearch.Name name) - { - NameValue = name; - return Self; - } - - /// - /// - /// Search template to use on search operations. - /// - /// - public SearchApplicationDescriptor Template(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplate? template) - { - TemplateDescriptor = null; - TemplateDescriptorAction = null; - TemplateValue = template; - return Self; - } - - public SearchApplicationDescriptor Template(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplateDescriptor descriptor) - { - TemplateValue = null; - TemplateDescriptorAction = null; - TemplateDescriptor = descriptor; - return Self; - } - - public SearchApplicationDescriptor Template(Action configure) - { - TemplateValue = null; - TemplateDescriptor = null; - TemplateDescriptorAction = configure; - return Self; - } - - /// - /// - /// Last time the Search Application was updated. - /// - /// - public SearchApplicationDescriptor UpdatedAtMillis(long updatedAtMillis) - { - UpdatedAtMillisValue = updatedAtMillis; - return Self; - } - - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) - { - writer.WriteStartObject(); - if (AnalyticsCollectionNameValue is not null) - { - writer.WritePropertyName("analytics_collection_name"); - JsonSerializer.Serialize(writer, AnalyticsCollectionNameValue, options); - } - - writer.WritePropertyName("indices"); - JsonSerializer.Serialize(writer, IndicesValue, options); - writer.WritePropertyName("name"); - JsonSerializer.Serialize(writer, NameValue, options); - if (TemplateDescriptor is not null) - { - writer.WritePropertyName("template"); - JsonSerializer.Serialize(writer, TemplateDescriptor, options); - } - else if (TemplateDescriptorAction is not null) - { - writer.WritePropertyName("template"); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplateDescriptor(TemplateDescriptorAction), options); - } - else if (TemplateValue is not null) - { - writer.WritePropertyName("template"); - JsonSerializer.Serialize(writer, TemplateValue, options); - } - - writer.WritePropertyName("updated_at_millis"); - writer.WriteNumberValue(UpdatedAtMillisValue); - writer.WriteEndObject(); - } + public long UpdatedAtMillis { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationParameters.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationParameters.g.cs new file mode 100644 index 0000000000..923ead8239 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationParameters.g.cs @@ -0,0 +1,151 @@ +// 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.SearchApplication; + +public sealed partial class SearchApplicationParameters +{ + /// + /// + /// Analytics collection associated to the Search Application. + /// + /// + [JsonInclude, JsonPropertyName("analytics_collection_name")] + public Elastic.Clients.Elasticsearch.Name? AnalyticsCollectionName { get; set; } + + /// + /// + /// Indices that are part of the Search Application. + /// + /// + [JsonInclude, JsonPropertyName("indices")] + public ICollection Indices { get; set; } + + /// + /// + /// Search template to use on search operations. + /// + /// + [JsonInclude, JsonPropertyName("template")] + public Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplate? Template { get; set; } +} + +public sealed partial class SearchApplicationParametersDescriptor : SerializableDescriptor +{ + internal SearchApplicationParametersDescriptor(Action configure) => configure.Invoke(this); + + public SearchApplicationParametersDescriptor() : base() + { + } + + private Elastic.Clients.Elasticsearch.Name? AnalyticsCollectionNameValue { get; set; } + private ICollection IndicesValue { get; set; } + private Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplate? TemplateValue { get; set; } + private Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplateDescriptor TemplateDescriptor { get; set; } + private Action TemplateDescriptorAction { get; set; } + + /// + /// + /// Analytics collection associated to the Search Application. + /// + /// + public SearchApplicationParametersDescriptor AnalyticsCollectionName(Elastic.Clients.Elasticsearch.Name? analyticsCollectionName) + { + AnalyticsCollectionNameValue = analyticsCollectionName; + return Self; + } + + /// + /// + /// Indices that are part of the Search Application. + /// + /// + public SearchApplicationParametersDescriptor Indices(ICollection indices) + { + IndicesValue = indices; + return Self; + } + + /// + /// + /// Search template to use on search operations. + /// + /// + public SearchApplicationParametersDescriptor Template(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplate? template) + { + TemplateDescriptor = null; + TemplateDescriptorAction = null; + TemplateValue = template; + return Self; + } + + public SearchApplicationParametersDescriptor Template(Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplateDescriptor descriptor) + { + TemplateValue = null; + TemplateDescriptorAction = null; + TemplateDescriptor = descriptor; + return Self; + } + + public SearchApplicationParametersDescriptor Template(Action configure) + { + TemplateValue = null; + TemplateDescriptor = null; + TemplateDescriptorAction = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (AnalyticsCollectionNameValue is not null) + { + writer.WritePropertyName("analytics_collection_name"); + JsonSerializer.Serialize(writer, AnalyticsCollectionNameValue, options); + } + + writer.WritePropertyName("indices"); + JsonSerializer.Serialize(writer, IndicesValue, options); + if (TemplateDescriptor is not null) + { + writer.WritePropertyName("template"); + JsonSerializer.Serialize(writer, TemplateDescriptor, options); + } + else if (TemplateDescriptorAction is not null) + { + writer.WritePropertyName("template"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.SearchApplication.SearchApplicationTemplateDescriptor(TemplateDescriptorAction), options); + } + else if (TemplateValue is not null) + { + writer.WritePropertyName("template"); + JsonSerializer.Serialize(writer, TemplateValue, options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/Access.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/Access.g.cs new file mode 100644 index 0000000000..96dc9da83d --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/Access.g.cs @@ -0,0 +1,383 @@ +// 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.Security; + +public sealed partial class Access +{ + /// + /// + /// A list of indices permission entries for cross-cluster replication. + /// + /// + [JsonInclude, JsonPropertyName("replication")] + public ICollection? Replication { get; set; } + + /// + /// + /// A list of indices permission entries for cross-cluster search. + /// + /// + [JsonInclude, JsonPropertyName("search")] + public ICollection? Search { get; set; } +} + +public sealed partial class AccessDescriptor : SerializableDescriptor> +{ + internal AccessDescriptor(Action> configure) => configure.Invoke(this); + + public AccessDescriptor() : base() + { + } + + private ICollection? ReplicationValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.ReplicationAccessDescriptor ReplicationDescriptor { get; set; } + private Action ReplicationDescriptorAction { get; set; } + private Action[] ReplicationDescriptorActions { get; set; } + private ICollection? SearchValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.SearchAccessDescriptor SearchDescriptor { get; set; } + private Action> SearchDescriptorAction { get; set; } + private Action>[] SearchDescriptorActions { get; set; } + + /// + /// + /// A list of indices permission entries for cross-cluster replication. + /// + /// + public AccessDescriptor Replication(ICollection? replication) + { + ReplicationDescriptor = null; + ReplicationDescriptorAction = null; + ReplicationDescriptorActions = null; + ReplicationValue = replication; + return Self; + } + + public AccessDescriptor Replication(Elastic.Clients.Elasticsearch.Security.ReplicationAccessDescriptor descriptor) + { + ReplicationValue = null; + ReplicationDescriptorAction = null; + ReplicationDescriptorActions = null; + ReplicationDescriptor = descriptor; + return Self; + } + + public AccessDescriptor Replication(Action configure) + { + ReplicationValue = null; + ReplicationDescriptor = null; + ReplicationDescriptorActions = null; + ReplicationDescriptorAction = configure; + return Self; + } + + public AccessDescriptor Replication(params Action[] configure) + { + ReplicationValue = null; + ReplicationDescriptor = null; + ReplicationDescriptorAction = null; + ReplicationDescriptorActions = configure; + return Self; + } + + /// + /// + /// A list of indices permission entries for cross-cluster search. + /// + /// + public AccessDescriptor Search(ICollection? search) + { + SearchDescriptor = null; + SearchDescriptorAction = null; + SearchDescriptorActions = null; + SearchValue = search; + return Self; + } + + public AccessDescriptor Search(Elastic.Clients.Elasticsearch.Security.SearchAccessDescriptor descriptor) + { + SearchValue = null; + SearchDescriptorAction = null; + SearchDescriptorActions = null; + SearchDescriptor = descriptor; + return Self; + } + + public AccessDescriptor Search(Action> configure) + { + SearchValue = null; + SearchDescriptor = null; + SearchDescriptorActions = null; + SearchDescriptorAction = configure; + return Self; + } + + public AccessDescriptor Search(params Action>[] configure) + { + SearchValue = null; + SearchDescriptor = null; + SearchDescriptorAction = null; + SearchDescriptorActions = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (ReplicationDescriptor is not null) + { + writer.WritePropertyName("replication"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, ReplicationDescriptor, options); + writer.WriteEndArray(); + } + else if (ReplicationDescriptorAction is not null) + { + writer.WritePropertyName("replication"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.ReplicationAccessDescriptor(ReplicationDescriptorAction), options); + writer.WriteEndArray(); + } + else if (ReplicationDescriptorActions is not null) + { + writer.WritePropertyName("replication"); + writer.WriteStartArray(); + foreach (var action in ReplicationDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.ReplicationAccessDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (ReplicationValue is not null) + { + writer.WritePropertyName("replication"); + JsonSerializer.Serialize(writer, ReplicationValue, options); + } + + if (SearchDescriptor is not null) + { + writer.WritePropertyName("search"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, SearchDescriptor, options); + writer.WriteEndArray(); + } + else if (SearchDescriptorAction is not null) + { + writer.WritePropertyName("search"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.SearchAccessDescriptor(SearchDescriptorAction), options); + writer.WriteEndArray(); + } + else if (SearchDescriptorActions is not null) + { + writer.WritePropertyName("search"); + writer.WriteStartArray(); + foreach (var action in SearchDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.SearchAccessDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (SearchValue is not null) + { + writer.WritePropertyName("search"); + JsonSerializer.Serialize(writer, SearchValue, options); + } + + writer.WriteEndObject(); + } +} + +public sealed partial class AccessDescriptor : SerializableDescriptor +{ + internal AccessDescriptor(Action configure) => configure.Invoke(this); + + public AccessDescriptor() : base() + { + } + + private ICollection? ReplicationValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.ReplicationAccessDescriptor ReplicationDescriptor { get; set; } + private Action ReplicationDescriptorAction { get; set; } + private Action[] ReplicationDescriptorActions { get; set; } + private ICollection? SearchValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.SearchAccessDescriptor SearchDescriptor { get; set; } + private Action SearchDescriptorAction { get; set; } + private Action[] SearchDescriptorActions { get; set; } + + /// + /// + /// A list of indices permission entries for cross-cluster replication. + /// + /// + public AccessDescriptor Replication(ICollection? replication) + { + ReplicationDescriptor = null; + ReplicationDescriptorAction = null; + ReplicationDescriptorActions = null; + ReplicationValue = replication; + return Self; + } + + public AccessDescriptor Replication(Elastic.Clients.Elasticsearch.Security.ReplicationAccessDescriptor descriptor) + { + ReplicationValue = null; + ReplicationDescriptorAction = null; + ReplicationDescriptorActions = null; + ReplicationDescriptor = descriptor; + return Self; + } + + public AccessDescriptor Replication(Action configure) + { + ReplicationValue = null; + ReplicationDescriptor = null; + ReplicationDescriptorActions = null; + ReplicationDescriptorAction = configure; + return Self; + } + + public AccessDescriptor Replication(params Action[] configure) + { + ReplicationValue = null; + ReplicationDescriptor = null; + ReplicationDescriptorAction = null; + ReplicationDescriptorActions = configure; + return Self; + } + + /// + /// + /// A list of indices permission entries for cross-cluster search. + /// + /// + public AccessDescriptor Search(ICollection? search) + { + SearchDescriptor = null; + SearchDescriptorAction = null; + SearchDescriptorActions = null; + SearchValue = search; + return Self; + } + + public AccessDescriptor Search(Elastic.Clients.Elasticsearch.Security.SearchAccessDescriptor descriptor) + { + SearchValue = null; + SearchDescriptorAction = null; + SearchDescriptorActions = null; + SearchDescriptor = descriptor; + return Self; + } + + public AccessDescriptor Search(Action configure) + { + SearchValue = null; + SearchDescriptor = null; + SearchDescriptorActions = null; + SearchDescriptorAction = configure; + return Self; + } + + public AccessDescriptor Search(params Action[] configure) + { + SearchValue = null; + SearchDescriptor = null; + SearchDescriptorAction = null; + SearchDescriptorActions = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (ReplicationDescriptor is not null) + { + writer.WritePropertyName("replication"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, ReplicationDescriptor, options); + writer.WriteEndArray(); + } + else if (ReplicationDescriptorAction is not null) + { + writer.WritePropertyName("replication"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.ReplicationAccessDescriptor(ReplicationDescriptorAction), options); + writer.WriteEndArray(); + } + else if (ReplicationDescriptorActions is not null) + { + writer.WritePropertyName("replication"); + writer.WriteStartArray(); + foreach (var action in ReplicationDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.ReplicationAccessDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (ReplicationValue is not null) + { + writer.WritePropertyName("replication"); + JsonSerializer.Serialize(writer, ReplicationValue, options); + } + + if (SearchDescriptor is not null) + { + writer.WritePropertyName("search"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, SearchDescriptor, options); + writer.WriteEndArray(); + } + else if (SearchDescriptorAction is not null) + { + writer.WritePropertyName("search"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.SearchAccessDescriptor(SearchDescriptorAction), options); + writer.WriteEndArray(); + } + else if (SearchDescriptorActions is not null) + { + writer.WritePropertyName("search"); + writer.WriteStartArray(); + foreach (var action in SearchDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.SearchAccessDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (SearchValue is not null) + { + writer.WritePropertyName("search"); + JsonSerializer.Serialize(writer, SearchValue, options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/IndicesPrivileges.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/IndicesPrivileges.g.cs index 3f6062507e..3be8e4dec8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/IndicesPrivileges.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/IndicesPrivileges.g.cs @@ -51,6 +51,7 @@ public sealed partial class IndicesPrivileges /// /// [JsonInclude, JsonPropertyName("names")] + [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.IndexName))] public ICollection Names { get; set; } /// @@ -185,7 +186,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } writer.WritePropertyName("names"); - JsonSerializer.Serialize(writer, NamesValue, options); + SingleOrManySerializationHelper.Serialize(NamesValue, writer, options); writer.WritePropertyName("privileges"); JsonSerializer.Serialize(writer, PrivilegesValue, options); if (QueryValue is not null) @@ -313,7 +314,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } writer.WritePropertyName("names"); - JsonSerializer.Serialize(writer, NamesValue, options); + SingleOrManySerializationHelper.Serialize(NamesValue, writer, options); writer.WritePropertyName("privileges"); JsonSerializer.Serialize(writer, PrivilegesValue, options); if (QueryValue is not null) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/QueryRole.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/QueryRole.g.cs index 53b1d944db..e137275de9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/QueryRole.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/QueryRole.g.cs @@ -40,6 +40,9 @@ public override QueryRole Read(ref Utf8JsonReader reader, Type typeToConvert, Js IReadOnlyCollection? indices = default; IReadOnlyDictionary? metadata = default; string name = default; + IReadOnlyCollection? remoteCluster = default; + IReadOnlyCollection? remoteIndices = default; + Elastic.Clients.Elasticsearch.Security.Restriction? restriction = default; IReadOnlyCollection? runAs = default; IReadOnlyCollection? sort = default; IReadOnlyDictionary? transientMetadata = default; @@ -90,6 +93,24 @@ public override QueryRole Read(ref Utf8JsonReader reader, Type typeToConvert, Js continue; } + if (property == "remote_cluster") + { + remoteCluster = JsonSerializer.Deserialize?>(ref reader, options); + continue; + } + + if (property == "remote_indices") + { + remoteIndices = JsonSerializer.Deserialize?>(ref reader, options); + continue; + } + + if (property == "restriction") + { + restriction = JsonSerializer.Deserialize(ref reader, options); + continue; + } + if (property == "run_as") { runAs = JsonSerializer.Deserialize?>(ref reader, options); @@ -110,7 +131,7 @@ public override QueryRole Read(ref Utf8JsonReader reader, Type typeToConvert, Js } } - return new QueryRole { Applications = applications, Cluster = cluster, Description = description, Global = global, Indices = indices, Metadata = metadata, Name = name, RunAs = runAs, Sort = sort, TransientMetadata = transientMetadata }; + return new QueryRole { Applications = applications, Cluster = cluster, Description = description, Global = global, Indices = indices, Metadata = metadata, Name = name, RemoteCluster = remoteCluster, RemoteIndices = remoteIndices, Restriction = restriction, RunAs = runAs, Sort = sort, TransientMetadata = transientMetadata }; } public override void Write(Utf8JsonWriter writer, QueryRole value, JsonSerializerOptions options) @@ -171,6 +192,27 @@ public sealed partial class QueryRole /// public string Name { get; init; } + /// + /// + /// A list of cluster permissions for remote clusters. Note - this is limited a subset of the cluster permissions. + /// + /// + public IReadOnlyCollection? RemoteCluster { get; init; } + + /// + /// + /// A list of indices permissions for remote clusters. + /// + /// + public IReadOnlyCollection? RemoteIndices { get; init; } + + /// + /// + /// Restriction for when the role descriptor is allowed to be effective. + /// + /// + public Elastic.Clients.Elasticsearch.Security.Restriction? Restriction { get; init; } + /// /// /// A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected. diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RemoteClusterPrivileges.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RemoteClusterPrivileges.g.cs new file mode 100644 index 0000000000..0cdfc809bc --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RemoteClusterPrivileges.g.cs @@ -0,0 +1,101 @@ +// 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.Security; + +/// +/// +/// The subset of cluster level privileges that can be defined for remote clusters. +/// +/// +public sealed partial class RemoteClusterPrivileges +{ + /// + /// + /// A list of cluster aliases to which the permissions in this entry apply. + /// + /// + [JsonInclude, JsonPropertyName("clusters")] + public Elastic.Clients.Elasticsearch.Names Clusters { get; set; } + + /// + /// + /// The cluster level privileges that owners of the role have on the remote cluster. + /// + /// + [JsonInclude, JsonPropertyName("privileges")] + public ICollection Privileges { get; set; } +} + +/// +/// +/// The subset of cluster level privileges that can be defined for remote clusters. +/// +/// +public sealed partial class RemoteClusterPrivilegesDescriptor : SerializableDescriptor +{ + internal RemoteClusterPrivilegesDescriptor(Action configure) => configure.Invoke(this); + + public RemoteClusterPrivilegesDescriptor() : base() + { + } + + private Elastic.Clients.Elasticsearch.Names ClustersValue { get; set; } + private ICollection PrivilegesValue { get; set; } + + /// + /// + /// A list of cluster aliases to which the permissions in this entry apply. + /// + /// + public RemoteClusterPrivilegesDescriptor Clusters(Elastic.Clients.Elasticsearch.Names clusters) + { + ClustersValue = clusters; + return Self; + } + + /// + /// + /// The cluster level privileges that owners of the role have on the remote cluster. + /// + /// + public RemoteClusterPrivilegesDescriptor Privileges(ICollection privileges) + { + PrivilegesValue = privileges; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("clusters"); + JsonSerializer.Serialize(writer, ClustersValue, options); + writer.WritePropertyName("privileges"); + JsonSerializer.Serialize(writer, PrivilegesValue, options); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RemoteIndicesPrivileges.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RemoteIndicesPrivileges.g.cs index 068928f43c..61c9a3199b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RemoteIndicesPrivileges.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RemoteIndicesPrivileges.g.cs @@ -27,6 +27,11 @@ namespace Elastic.Clients.Elasticsearch.Security; +/// +/// +/// The subset of index level privileges that can be defined for remote clusters. +/// +/// public sealed partial class RemoteIndicesPrivileges { /// @@ -59,6 +64,7 @@ public sealed partial class RemoteIndicesPrivileges /// /// [JsonInclude, JsonPropertyName("names")] + [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.IndexName))] public ICollection Names { get; set; } /// @@ -78,6 +84,11 @@ public sealed partial class RemoteIndicesPrivileges public object? Query { get; set; } } +/// +/// +/// The subset of index level privileges that can be defined for remote clusters. +/// +/// public sealed partial class RemoteIndicesPrivilegesDescriptor : SerializableDescriptor> { internal RemoteIndicesPrivilegesDescriptor(Action> configure) => configure.Invoke(this); @@ -207,7 +218,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } writer.WritePropertyName("names"); - JsonSerializer.Serialize(writer, NamesValue, options); + SingleOrManySerializationHelper.Serialize(NamesValue, writer, options); writer.WritePropertyName("privileges"); JsonSerializer.Serialize(writer, PrivilegesValue, options); if (QueryValue is not null) @@ -220,6 +231,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } } +/// +/// +/// The subset of index level privileges that can be defined for remote clusters. +/// +/// public sealed partial class RemoteIndicesPrivilegesDescriptor : SerializableDescriptor { internal RemoteIndicesPrivilegesDescriptor(Action configure) => configure.Invoke(this); @@ -349,7 +365,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o } writer.WritePropertyName("names"); - JsonSerializer.Serialize(writer, NamesValue, options); + SingleOrManySerializationHelper.Serialize(NamesValue, writer, options); writer.WritePropertyName("privileges"); JsonSerializer.Serialize(writer, PrivilegesValue, options); if (QueryValue is not null) diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/ReplicationAccess.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/ReplicationAccess.g.cs new file mode 100644 index 0000000000..6a19a68c4c --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/ReplicationAccess.g.cs @@ -0,0 +1,96 @@ +// 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.Security; + +public sealed partial class ReplicationAccess +{ + /// + /// + /// This needs to be set to true if the patterns in the names field should cover system indices. + /// + /// + [JsonInclude, JsonPropertyName("allow_restricted_indices")] + public bool? AllowRestrictedIndices { get; set; } + + /// + /// + /// A list of indices (or index name patterns) to which the permissions in this entry apply. + /// + /// + [JsonInclude, JsonPropertyName("names")] + [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.IndexName))] + public ICollection Names { get; set; } +} + +public sealed partial class ReplicationAccessDescriptor : SerializableDescriptor +{ + internal ReplicationAccessDescriptor(Action configure) => configure.Invoke(this); + + public ReplicationAccessDescriptor() : base() + { + } + + private bool? AllowRestrictedIndicesValue { get; set; } + private ICollection NamesValue { get; set; } + + /// + /// + /// This needs to be set to true if the patterns in the names field should cover system indices. + /// + /// + public ReplicationAccessDescriptor AllowRestrictedIndices(bool? allowRestrictedIndices = true) + { + AllowRestrictedIndicesValue = allowRestrictedIndices; + return Self; + } + + /// + /// + /// A list of indices (or index name patterns) to which the permissions in this entry apply. + /// + /// + public ReplicationAccessDescriptor Names(ICollection names) + { + NamesValue = names; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (AllowRestrictedIndicesValue.HasValue) + { + writer.WritePropertyName("allow_restricted_indices"); + writer.WriteBooleanValue(AllowRestrictedIndicesValue.Value); + } + + writer.WritePropertyName("names"); + SingleOrManySerializationHelper.Serialize(NamesValue, writer, options); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/Restriction.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/Restriction.g.cs new file mode 100644 index 0000000000..0f48846bd9 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/Restriction.g.cs @@ -0,0 +1,59 @@ +// 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.Security; + +public sealed partial class Restriction +{ + [JsonInclude, JsonPropertyName("workflows")] + public ICollection Workflows { get; set; } +} + +public sealed partial class RestrictionDescriptor : SerializableDescriptor +{ + internal RestrictionDescriptor(Action configure) => configure.Invoke(this); + + public RestrictionDescriptor() : base() + { + } + + private ICollection WorkflowsValue { get; set; } + + public RestrictionDescriptor Workflows(ICollection workflows) + { + WorkflowsValue = workflows; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("workflows"); + JsonSerializer.Serialize(writer, WorkflowsValue, options); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/Role.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/Role.g.cs index 052fb4203d..feecdc34be 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/Role.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/Role.g.cs @@ -32,13 +32,17 @@ public sealed partial class Role [JsonInclude, JsonPropertyName("applications")] public IReadOnlyCollection Applications { get; init; } [JsonInclude, JsonPropertyName("cluster")] - public IReadOnlyCollection Cluster { get; init; } + public IReadOnlyCollection Cluster { get; init; } [JsonInclude, JsonPropertyName("global")] public IReadOnlyDictionary>>>? Global { get; init; } [JsonInclude, JsonPropertyName("indices")] public IReadOnlyCollection Indices { get; init; } [JsonInclude, JsonPropertyName("metadata")] public IReadOnlyDictionary Metadata { get; init; } + [JsonInclude, JsonPropertyName("remote_cluster")] + public IReadOnlyCollection? RemoteCluster { get; init; } + [JsonInclude, JsonPropertyName("remote_indices")] + public IReadOnlyCollection? RemoteIndices { get; init; } [JsonInclude, JsonPropertyName("role_templates")] public IReadOnlyCollection? RoleTemplates { get; init; } [JsonInclude, JsonPropertyName("run_as")] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RoleDescriptor.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RoleDescriptor.g.cs index 1091a7fbe9..3eaf8158d4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RoleDescriptor.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RoleDescriptor.g.cs @@ -75,6 +75,24 @@ public override RoleDescriptor Read(ref Utf8JsonReader reader, Type typeToConver continue; } + if (property == "remote_cluster") + { + variant.RemoteCluster = JsonSerializer.Deserialize?>(ref reader, options); + continue; + } + + if (property == "remote_indices") + { + variant.RemoteIndices = JsonSerializer.Deserialize?>(ref reader, options); + continue; + } + + if (property == "restriction") + { + variant.Restriction = JsonSerializer.Deserialize(ref reader, options); + continue; + } + if (property == "run_as") { variant.RunAs = JsonSerializer.Deserialize?>(ref reader, options); @@ -131,6 +149,24 @@ public override void Write(Utf8JsonWriter writer, RoleDescriptor value, JsonSeri JsonSerializer.Serialize(writer, value.Metadata, options); } + if (value.RemoteCluster is not null) + { + writer.WritePropertyName("remote_cluster"); + JsonSerializer.Serialize(writer, value.RemoteCluster, options); + } + + if (value.RemoteIndices is not null) + { + writer.WritePropertyName("remote_indices"); + JsonSerializer.Serialize(writer, value.RemoteIndices, options); + } + + if (value.Restriction is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, value.Restriction, options); + } + if (value.RunAs is not null) { writer.WritePropertyName("run_as"); @@ -192,6 +228,27 @@ public sealed partial class RoleDescriptor /// public IDictionary? Metadata { get; set; } + /// + /// + /// A list of cluster permissions for remote clusters. Note - this is limited a subset of the cluster permissions. + /// + /// + public ICollection? RemoteCluster { get; set; } + + /// + /// + /// A list of indices permissions for remote clusters. + /// + /// + public ICollection? RemoteIndices { get; set; } + + /// + /// + /// Restriction for when the role descriptor is allowed to be effective. + /// + /// + public Elastic.Clients.Elasticsearch.Security.Restriction? Restriction { get; set; } + /// /// /// A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected. @@ -224,6 +281,17 @@ public RoleDescriptorDescriptor() : base() private Action> IndicesDescriptorAction { get; set; } private Action>[] IndicesDescriptorActions { get; set; } private IDictionary? MetadataValue { get; set; } + private ICollection? RemoteClusterValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor RemoteClusterDescriptor { get; set; } + private Action RemoteClusterDescriptorAction { get; set; } + private Action[] RemoteClusterDescriptorActions { get; set; } + private ICollection? RemoteIndicesValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.RemoteIndicesPrivilegesDescriptor RemoteIndicesDescriptor { get; set; } + private Action> RemoteIndicesDescriptorAction { get; set; } + private Action>[] RemoteIndicesDescriptorActions { get; set; } + private Elastic.Clients.Elasticsearch.Security.Restriction? RestrictionValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.RestrictionDescriptor RestrictionDescriptor { get; set; } + private Action RestrictionDescriptorAction { get; set; } private ICollection? RunAsValue { get; set; } private IDictionary? TransientMetadataValue { get; set; } @@ -383,6 +451,117 @@ public RoleDescriptorDescriptor Metadata(Func + /// + /// A list of cluster permissions for remote clusters. Note - this is limited a subset of the cluster permissions. + /// + /// + public RoleDescriptorDescriptor RemoteCluster(ICollection? remoteCluster) + { + RemoteClusterDescriptor = null; + RemoteClusterDescriptorAction = null; + RemoteClusterDescriptorActions = null; + RemoteClusterValue = remoteCluster; + return Self; + } + + public RoleDescriptorDescriptor RemoteCluster(Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor descriptor) + { + RemoteClusterValue = null; + RemoteClusterDescriptorAction = null; + RemoteClusterDescriptorActions = null; + RemoteClusterDescriptor = descriptor; + return Self; + } + + public RoleDescriptorDescriptor RemoteCluster(Action configure) + { + RemoteClusterValue = null; + RemoteClusterDescriptor = null; + RemoteClusterDescriptorActions = null; + RemoteClusterDescriptorAction = configure; + return Self; + } + + public RoleDescriptorDescriptor RemoteCluster(params Action[] configure) + { + RemoteClusterValue = null; + RemoteClusterDescriptor = null; + RemoteClusterDescriptorAction = null; + RemoteClusterDescriptorActions = configure; + return Self; + } + + /// + /// + /// A list of indices permissions for remote clusters. + /// + /// + public RoleDescriptorDescriptor RemoteIndices(ICollection? remoteIndices) + { + RemoteIndicesDescriptor = null; + RemoteIndicesDescriptorAction = null; + RemoteIndicesDescriptorActions = null; + RemoteIndicesValue = remoteIndices; + return Self; + } + + public RoleDescriptorDescriptor RemoteIndices(Elastic.Clients.Elasticsearch.Security.RemoteIndicesPrivilegesDescriptor descriptor) + { + RemoteIndicesValue = null; + RemoteIndicesDescriptorAction = null; + RemoteIndicesDescriptorActions = null; + RemoteIndicesDescriptor = descriptor; + return Self; + } + + public RoleDescriptorDescriptor RemoteIndices(Action> configure) + { + RemoteIndicesValue = null; + RemoteIndicesDescriptor = null; + RemoteIndicesDescriptorActions = null; + RemoteIndicesDescriptorAction = configure; + return Self; + } + + public RoleDescriptorDescriptor RemoteIndices(params Action>[] configure) + { + RemoteIndicesValue = null; + RemoteIndicesDescriptor = null; + RemoteIndicesDescriptorAction = null; + RemoteIndicesDescriptorActions = configure; + return Self; + } + + /// + /// + /// Restriction for when the role descriptor is allowed to be effective. + /// + /// + public RoleDescriptorDescriptor Restriction(Elastic.Clients.Elasticsearch.Security.Restriction? restriction) + { + RestrictionDescriptor = null; + RestrictionDescriptorAction = null; + RestrictionValue = restriction; + return Self; + } + + public RoleDescriptorDescriptor Restriction(Elastic.Clients.Elasticsearch.Security.RestrictionDescriptor descriptor) + { + RestrictionValue = null; + RestrictionDescriptorAction = null; + RestrictionDescriptor = descriptor; + return Self; + } + + public RoleDescriptorDescriptor Restriction(Action configure) + { + RestrictionValue = null; + RestrictionDescriptor = null; + RestrictionDescriptorAction = configure; + return Self; + } + /// /// /// A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected. @@ -512,6 +691,84 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, MetadataValue, options); } + if (RemoteClusterDescriptor is not null) + { + writer.WritePropertyName("remote_cluster"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, RemoteClusterDescriptor, options); + writer.WriteEndArray(); + } + else if (RemoteClusterDescriptorAction is not null) + { + writer.WritePropertyName("remote_cluster"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor(RemoteClusterDescriptorAction), options); + writer.WriteEndArray(); + } + else if (RemoteClusterDescriptorActions is not null) + { + writer.WritePropertyName("remote_cluster"); + writer.WriteStartArray(); + foreach (var action in RemoteClusterDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (RemoteClusterValue is not null) + { + writer.WritePropertyName("remote_cluster"); + JsonSerializer.Serialize(writer, RemoteClusterValue, options); + } + + if (RemoteIndicesDescriptor is not null) + { + writer.WritePropertyName("remote_indices"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, RemoteIndicesDescriptor, options); + writer.WriteEndArray(); + } + else if (RemoteIndicesDescriptorAction is not null) + { + writer.WritePropertyName("remote_indices"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RemoteIndicesPrivilegesDescriptor(RemoteIndicesDescriptorAction), options); + writer.WriteEndArray(); + } + else if (RemoteIndicesDescriptorActions is not null) + { + writer.WritePropertyName("remote_indices"); + writer.WriteStartArray(); + foreach (var action in RemoteIndicesDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RemoteIndicesPrivilegesDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (RemoteIndicesValue is not null) + { + writer.WritePropertyName("remote_indices"); + JsonSerializer.Serialize(writer, RemoteIndicesValue, options); + } + + if (RestrictionDescriptor is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, RestrictionDescriptor, options); + } + else if (RestrictionDescriptorAction is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RestrictionDescriptor(RestrictionDescriptorAction), options); + } + else if (RestrictionValue is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, RestrictionValue, options); + } + if (RunAsValue is not null) { writer.WritePropertyName("run_as"); @@ -551,6 +808,17 @@ public RoleDescriptorDescriptor() : base() private Action IndicesDescriptorAction { get; set; } private Action[] IndicesDescriptorActions { get; set; } private IDictionary? MetadataValue { get; set; } + private ICollection? RemoteClusterValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor RemoteClusterDescriptor { get; set; } + private Action RemoteClusterDescriptorAction { get; set; } + private Action[] RemoteClusterDescriptorActions { get; set; } + private ICollection? RemoteIndicesValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.RemoteIndicesPrivilegesDescriptor RemoteIndicesDescriptor { get; set; } + private Action RemoteIndicesDescriptorAction { get; set; } + private Action[] RemoteIndicesDescriptorActions { get; set; } + private Elastic.Clients.Elasticsearch.Security.Restriction? RestrictionValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.RestrictionDescriptor RestrictionDescriptor { get; set; } + private Action RestrictionDescriptorAction { get; set; } private ICollection? RunAsValue { get; set; } private IDictionary? TransientMetadataValue { get; set; } @@ -710,6 +978,117 @@ public RoleDescriptorDescriptor Metadata(Func, return Self; } + /// + /// + /// A list of cluster permissions for remote clusters. Note - this is limited a subset of the cluster permissions. + /// + /// + public RoleDescriptorDescriptor RemoteCluster(ICollection? remoteCluster) + { + RemoteClusterDescriptor = null; + RemoteClusterDescriptorAction = null; + RemoteClusterDescriptorActions = null; + RemoteClusterValue = remoteCluster; + return Self; + } + + public RoleDescriptorDescriptor RemoteCluster(Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor descriptor) + { + RemoteClusterValue = null; + RemoteClusterDescriptorAction = null; + RemoteClusterDescriptorActions = null; + RemoteClusterDescriptor = descriptor; + return Self; + } + + public RoleDescriptorDescriptor RemoteCluster(Action configure) + { + RemoteClusterValue = null; + RemoteClusterDescriptor = null; + RemoteClusterDescriptorActions = null; + RemoteClusterDescriptorAction = configure; + return Self; + } + + public RoleDescriptorDescriptor RemoteCluster(params Action[] configure) + { + RemoteClusterValue = null; + RemoteClusterDescriptor = null; + RemoteClusterDescriptorAction = null; + RemoteClusterDescriptorActions = configure; + return Self; + } + + /// + /// + /// A list of indices permissions for remote clusters. + /// + /// + public RoleDescriptorDescriptor RemoteIndices(ICollection? remoteIndices) + { + RemoteIndicesDescriptor = null; + RemoteIndicesDescriptorAction = null; + RemoteIndicesDescriptorActions = null; + RemoteIndicesValue = remoteIndices; + return Self; + } + + public RoleDescriptorDescriptor RemoteIndices(Elastic.Clients.Elasticsearch.Security.RemoteIndicesPrivilegesDescriptor descriptor) + { + RemoteIndicesValue = null; + RemoteIndicesDescriptorAction = null; + RemoteIndicesDescriptorActions = null; + RemoteIndicesDescriptor = descriptor; + return Self; + } + + public RoleDescriptorDescriptor RemoteIndices(Action configure) + { + RemoteIndicesValue = null; + RemoteIndicesDescriptor = null; + RemoteIndicesDescriptorActions = null; + RemoteIndicesDescriptorAction = configure; + return Self; + } + + public RoleDescriptorDescriptor RemoteIndices(params Action[] configure) + { + RemoteIndicesValue = null; + RemoteIndicesDescriptor = null; + RemoteIndicesDescriptorAction = null; + RemoteIndicesDescriptorActions = configure; + return Self; + } + + /// + /// + /// Restriction for when the role descriptor is allowed to be effective. + /// + /// + public RoleDescriptorDescriptor Restriction(Elastic.Clients.Elasticsearch.Security.Restriction? restriction) + { + RestrictionDescriptor = null; + RestrictionDescriptorAction = null; + RestrictionValue = restriction; + return Self; + } + + public RoleDescriptorDescriptor Restriction(Elastic.Clients.Elasticsearch.Security.RestrictionDescriptor descriptor) + { + RestrictionValue = null; + RestrictionDescriptorAction = null; + RestrictionDescriptor = descriptor; + return Self; + } + + public RoleDescriptorDescriptor Restriction(Action configure) + { + RestrictionValue = null; + RestrictionDescriptor = null; + RestrictionDescriptorAction = configure; + return Self; + } + /// /// /// A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected. @@ -839,6 +1218,84 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, MetadataValue, options); } + if (RemoteClusterDescriptor is not null) + { + writer.WritePropertyName("remote_cluster"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, RemoteClusterDescriptor, options); + writer.WriteEndArray(); + } + else if (RemoteClusterDescriptorAction is not null) + { + writer.WritePropertyName("remote_cluster"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor(RemoteClusterDescriptorAction), options); + writer.WriteEndArray(); + } + else if (RemoteClusterDescriptorActions is not null) + { + writer.WritePropertyName("remote_cluster"); + writer.WriteStartArray(); + foreach (var action in RemoteClusterDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RemoteClusterPrivilegesDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (RemoteClusterValue is not null) + { + writer.WritePropertyName("remote_cluster"); + JsonSerializer.Serialize(writer, RemoteClusterValue, options); + } + + if (RemoteIndicesDescriptor is not null) + { + writer.WritePropertyName("remote_indices"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, RemoteIndicesDescriptor, options); + writer.WriteEndArray(); + } + else if (RemoteIndicesDescriptorAction is not null) + { + writer.WritePropertyName("remote_indices"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RemoteIndicesPrivilegesDescriptor(RemoteIndicesDescriptorAction), options); + writer.WriteEndArray(); + } + else if (RemoteIndicesDescriptorActions is not null) + { + writer.WritePropertyName("remote_indices"); + writer.WriteStartArray(); + foreach (var action in RemoteIndicesDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RemoteIndicesPrivilegesDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (RemoteIndicesValue is not null) + { + writer.WritePropertyName("remote_indices"); + JsonSerializer.Serialize(writer, RemoteIndicesValue, options); + } + + if (RestrictionDescriptor is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, RestrictionDescriptor, options); + } + else if (RestrictionDescriptorAction is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.RestrictionDescriptor(RestrictionDescriptorAction), options); + } + else if (RestrictionValue is not null) + { + writer.WritePropertyName("restriction"); + JsonSerializer.Serialize(writer, RestrictionValue, options); + } + if (RunAsValue is not null) { writer.WritePropertyName("run_as"); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RoleDescriptorRead.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RoleDescriptorRead.g.cs index 6df0ea3d1d..0cbba91ee6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RoleDescriptorRead.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/RoleDescriptorRead.g.cs @@ -39,6 +39,9 @@ public override RoleDescriptorRead Read(ref Utf8JsonReader reader, Type typeToCo IReadOnlyCollection? global = default; IReadOnlyCollection indices = default; IReadOnlyDictionary? metadata = default; + IReadOnlyCollection? remoteCluster = default; + IReadOnlyCollection? remoteIndices = default; + Elastic.Clients.Elasticsearch.Security.Restriction? restriction = default; IReadOnlyCollection? runAs = default; IReadOnlyDictionary? transientMetadata = default; while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) @@ -82,6 +85,24 @@ public override RoleDescriptorRead Read(ref Utf8JsonReader reader, Type typeToCo continue; } + if (property == "remote_cluster") + { + remoteCluster = JsonSerializer.Deserialize?>(ref reader, options); + continue; + } + + if (property == "remote_indices") + { + remoteIndices = JsonSerializer.Deserialize?>(ref reader, options); + continue; + } + + if (property == "restriction") + { + restriction = JsonSerializer.Deserialize(ref reader, options); + continue; + } + if (property == "run_as") { runAs = JsonSerializer.Deserialize?>(ref reader, options); @@ -96,7 +117,7 @@ public override RoleDescriptorRead Read(ref Utf8JsonReader reader, Type typeToCo } } - return new RoleDescriptorRead { Applications = applications, Cluster = cluster, Description = description, Global = global, Indices = indices, Metadata = metadata, RunAs = runAs, TransientMetadata = transientMetadata }; + return new RoleDescriptorRead { Applications = applications, Cluster = cluster, Description = description, Global = global, Indices = indices, Metadata = metadata, RemoteCluster = remoteCluster, RemoteIndices = remoteIndices, Restriction = restriction, RunAs = runAs, TransientMetadata = transientMetadata }; } public override void Write(Utf8JsonWriter writer, RoleDescriptorRead value, JsonSerializerOptions options) @@ -150,6 +171,27 @@ public sealed partial class RoleDescriptorRead /// public IReadOnlyDictionary? Metadata { get; init; } + /// + /// + /// A list of cluster permissions for remote clusters. Note - this is limited a subset of the cluster permissions. + /// + /// + public IReadOnlyCollection? RemoteCluster { get; init; } + + /// + /// + /// A list of indices permissions for remote clusters. + /// + /// + public IReadOnlyCollection? RemoteIndices { get; init; } + + /// + /// + /// Restriction for when the role descriptor is allowed to be effective. + /// + /// + public Elastic.Clients.Elasticsearch.Security.Restriction? Restriction { get; init; } + /// /// /// A list of users that the API keys can impersonate. diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/SearchAccess.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/SearchAccess.g.cs new file mode 100644 index 0000000000..04a4ac7ddc --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/SearchAccess.g.cs @@ -0,0 +1,292 @@ +// 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.Security; + +public sealed partial class SearchAccess +{ + /// + /// + /// Set to true if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the names list, Elasticsearch checks privileges against these indices regardless of the value set for allow_restricted_indices. + /// + /// + [JsonInclude, JsonPropertyName("allow_restricted_indices")] + public bool? AllowRestrictedIndices { get; set; } + + /// + /// + /// The document fields that the owners of the role have read access to. + /// + /// + [JsonInclude, JsonPropertyName("field_security")] + public Elastic.Clients.Elasticsearch.Security.FieldSecurity? FieldSecurity { get; set; } + + /// + /// + /// A list of indices (or index name patterns) to which the permissions in this entry apply. + /// + /// + [JsonInclude, JsonPropertyName("names")] + [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.IndexName))] + public ICollection Names { get; set; } + + /// + /// + /// A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. + /// + /// + [JsonInclude, JsonPropertyName("query")] + public object? Query { get; set; } +} + +public sealed partial class SearchAccessDescriptor : SerializableDescriptor> +{ + internal SearchAccessDescriptor(Action> configure) => configure.Invoke(this); + + public SearchAccessDescriptor() : base() + { + } + + private bool? AllowRestrictedIndicesValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.FieldSecurity? FieldSecurityValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.FieldSecurityDescriptor FieldSecurityDescriptor { get; set; } + private Action> FieldSecurityDescriptorAction { get; set; } + private ICollection NamesValue { get; set; } + private object? QueryValue { get; set; } + + /// + /// + /// Set to true if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the names list, Elasticsearch checks privileges against these indices regardless of the value set for allow_restricted_indices. + /// + /// + public SearchAccessDescriptor AllowRestrictedIndices(bool? allowRestrictedIndices = true) + { + AllowRestrictedIndicesValue = allowRestrictedIndices; + return Self; + } + + /// + /// + /// The document fields that the owners of the role have read access to. + /// + /// + public SearchAccessDescriptor FieldSecurity(Elastic.Clients.Elasticsearch.Security.FieldSecurity? fieldSecurity) + { + FieldSecurityDescriptor = null; + FieldSecurityDescriptorAction = null; + FieldSecurityValue = fieldSecurity; + return Self; + } + + public SearchAccessDescriptor FieldSecurity(Elastic.Clients.Elasticsearch.Security.FieldSecurityDescriptor descriptor) + { + FieldSecurityValue = null; + FieldSecurityDescriptorAction = null; + FieldSecurityDescriptor = descriptor; + return Self; + } + + public SearchAccessDescriptor FieldSecurity(Action> configure) + { + FieldSecurityValue = null; + FieldSecurityDescriptor = null; + FieldSecurityDescriptorAction = configure; + return Self; + } + + /// + /// + /// A list of indices (or index name patterns) to which the permissions in this entry apply. + /// + /// + public SearchAccessDescriptor Names(ICollection names) + { + NamesValue = names; + return Self; + } + + /// + /// + /// A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. + /// + /// + public SearchAccessDescriptor Query(object? query) + { + QueryValue = query; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (AllowRestrictedIndicesValue.HasValue) + { + writer.WritePropertyName("allow_restricted_indices"); + writer.WriteBooleanValue(AllowRestrictedIndicesValue.Value); + } + + if (FieldSecurityDescriptor is not null) + { + writer.WritePropertyName("field_security"); + JsonSerializer.Serialize(writer, FieldSecurityDescriptor, options); + } + else if (FieldSecurityDescriptorAction is not null) + { + writer.WritePropertyName("field_security"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.FieldSecurityDescriptor(FieldSecurityDescriptorAction), options); + } + else if (FieldSecurityValue is not null) + { + writer.WritePropertyName("field_security"); + JsonSerializer.Serialize(writer, FieldSecurityValue, options); + } + + writer.WritePropertyName("names"); + SingleOrManySerializationHelper.Serialize(NamesValue, writer, options); + if (QueryValue is not null) + { + writer.WritePropertyName("query"); + JsonSerializer.Serialize(writer, QueryValue, options); + } + + writer.WriteEndObject(); + } +} + +public sealed partial class SearchAccessDescriptor : SerializableDescriptor +{ + internal SearchAccessDescriptor(Action configure) => configure.Invoke(this); + + public SearchAccessDescriptor() : base() + { + } + + private bool? AllowRestrictedIndicesValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.FieldSecurity? FieldSecurityValue { get; set; } + private Elastic.Clients.Elasticsearch.Security.FieldSecurityDescriptor FieldSecurityDescriptor { get; set; } + private Action FieldSecurityDescriptorAction { get; set; } + private ICollection NamesValue { get; set; } + private object? QueryValue { get; set; } + + /// + /// + /// Set to true if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the names list, Elasticsearch checks privileges against these indices regardless of the value set for allow_restricted_indices. + /// + /// + public SearchAccessDescriptor AllowRestrictedIndices(bool? allowRestrictedIndices = true) + { + AllowRestrictedIndicesValue = allowRestrictedIndices; + return Self; + } + + /// + /// + /// The document fields that the owners of the role have read access to. + /// + /// + public SearchAccessDescriptor FieldSecurity(Elastic.Clients.Elasticsearch.Security.FieldSecurity? fieldSecurity) + { + FieldSecurityDescriptor = null; + FieldSecurityDescriptorAction = null; + FieldSecurityValue = fieldSecurity; + return Self; + } + + public SearchAccessDescriptor FieldSecurity(Elastic.Clients.Elasticsearch.Security.FieldSecurityDescriptor descriptor) + { + FieldSecurityValue = null; + FieldSecurityDescriptorAction = null; + FieldSecurityDescriptor = descriptor; + return Self; + } + + public SearchAccessDescriptor FieldSecurity(Action configure) + { + FieldSecurityValue = null; + FieldSecurityDescriptor = null; + FieldSecurityDescriptorAction = configure; + return Self; + } + + /// + /// + /// A list of indices (or index name patterns) to which the permissions in this entry apply. + /// + /// + public SearchAccessDescriptor Names(ICollection names) + { + NamesValue = names; + return Self; + } + + /// + /// + /// A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. + /// + /// + public SearchAccessDescriptor Query(object? query) + { + QueryValue = query; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (AllowRestrictedIndicesValue.HasValue) + { + writer.WritePropertyName("allow_restricted_indices"); + writer.WriteBooleanValue(AllowRestrictedIndicesValue.Value); + } + + if (FieldSecurityDescriptor is not null) + { + writer.WritePropertyName("field_security"); + JsonSerializer.Serialize(writer, FieldSecurityDescriptor, options); + } + else if (FieldSecurityDescriptorAction is not null) + { + writer.WritePropertyName("field_security"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Security.FieldSecurityDescriptor(FieldSecurityDescriptorAction), options); + } + else if (FieldSecurityValue is not null) + { + writer.WritePropertyName("field_security"); + JsonSerializer.Serialize(writer, FieldSecurityValue, options); + } + + writer.WritePropertyName("names"); + SingleOrManySerializationHelper.Serialize(NamesValue, writer, options); + if (QueryValue is not null) + { + writer.WritePropertyName("query"); + JsonSerializer.Serialize(writer, QueryValue, options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/UserIndicesPrivileges.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/UserIndicesPrivileges.g.cs index 00564aac31..5bacdaccaa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/UserIndicesPrivileges.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/UserIndicesPrivileges.g.cs @@ -51,6 +51,7 @@ public sealed partial class UserIndicesPrivileges /// /// [JsonInclude, JsonPropertyName("names")] + [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection Names { get; init; } /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TextSimilarityReranker.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TextSimilarityReranker.g.cs new file mode 100644 index 0000000000..95ea884348 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TextSimilarityReranker.g.cs @@ -0,0 +1,546 @@ +// 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; + +public sealed partial class TextSimilarityReranker +{ + /// + /// + /// The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text + /// + /// + [JsonInclude, JsonPropertyName("field")] + public string? Field { get; set; } + + /// + /// + /// Query to filter the documents that can match. + /// + /// + [JsonInclude, JsonPropertyName("filter")] + [SingleOrManyCollectionConverter(typeof(Elastic.Clients.Elasticsearch.QueryDsl.Query))] + public ICollection? Filter { get; set; } + + /// + /// + /// Unique identifier of the inference endpoint created using the inference API. + /// + /// + [JsonInclude, JsonPropertyName("inference_id")] + public string? InferenceId { get; set; } + + /// + /// + /// The text snippet used as the basis for similarity comparison + /// + /// + [JsonInclude, JsonPropertyName("inference_text")] + public string? InferenceText { get; set; } + + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + [JsonInclude, JsonPropertyName("min_score")] + public float? MinScore { get; set; } + + /// + /// + /// This value determines how many documents we will consider from the nested retriever. + /// + /// + [JsonInclude, JsonPropertyName("rank_window_size")] + public int? RankWindowSize { get; set; } + + /// + /// + /// The nested retriever which will produce the first-level results, that will later be used for reranking. + /// + /// + [JsonInclude, JsonPropertyName("retriever")] + public Elastic.Clients.Elasticsearch.Retriever Retriever { get; set; } + + public static implicit operator Elastic.Clients.Elasticsearch.Retriever(TextSimilarityReranker textSimilarityReranker) => Elastic.Clients.Elasticsearch.Retriever.TextSimilarityReranker(textSimilarityReranker); +} + +public sealed partial class TextSimilarityRerankerDescriptor : SerializableDescriptor> +{ + internal TextSimilarityRerankerDescriptor(Action> configure) => configure.Invoke(this); + + public TextSimilarityRerankerDescriptor() : base() + { + } + + private string? FieldValue { get; set; } + private ICollection? FilterValue { get; set; } + private Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor FilterDescriptor { get; set; } + private Action> FilterDescriptorAction { get; set; } + private Action>[] FilterDescriptorActions { get; set; } + private string? InferenceIdValue { get; set; } + private string? InferenceTextValue { get; set; } + private float? MinScoreValue { get; set; } + private int? RankWindowSizeValue { get; set; } + private Elastic.Clients.Elasticsearch.Retriever RetrieverValue { get; set; } + private Elastic.Clients.Elasticsearch.RetrieverDescriptor RetrieverDescriptor { get; set; } + private Action> RetrieverDescriptorAction { get; set; } + + /// + /// + /// The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text + /// + /// + public TextSimilarityRerankerDescriptor Field(string? field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// Query to filter the documents that can match. + /// + /// + public TextSimilarityRerankerDescriptor Filter(ICollection? filter) + { + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterValue = filter; + return Self; + } + + public TextSimilarityRerankerDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor descriptor) + { + FilterValue = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterDescriptor = descriptor; + return Self; + } + + public TextSimilarityRerankerDescriptor Filter(Action> configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorActions = null; + FilterDescriptorAction = configure; + return Self; + } + + public TextSimilarityRerankerDescriptor Filter(params Action>[] configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = configure; + return Self; + } + + /// + /// + /// Unique identifier of the inference endpoint created using the inference API. + /// + /// + public TextSimilarityRerankerDescriptor InferenceId(string? inferenceId) + { + InferenceIdValue = inferenceId; + return Self; + } + + /// + /// + /// The text snippet used as the basis for similarity comparison + /// + /// + public TextSimilarityRerankerDescriptor InferenceText(string? inferenceText) + { + InferenceTextValue = inferenceText; + return Self; + } + + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public TextSimilarityRerankerDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + + /// + /// + /// This value determines how many documents we will consider from the nested retriever. + /// + /// + public TextSimilarityRerankerDescriptor RankWindowSize(int? rankWindowSize) + { + RankWindowSizeValue = rankWindowSize; + return Self; + } + + /// + /// + /// The nested retriever which will produce the first-level results, that will later be used for reranking. + /// + /// + public TextSimilarityRerankerDescriptor Retriever(Elastic.Clients.Elasticsearch.Retriever retriever) + { + RetrieverDescriptor = null; + RetrieverDescriptorAction = null; + RetrieverValue = retriever; + return Self; + } + + public TextSimilarityRerankerDescriptor Retriever(Elastic.Clients.Elasticsearch.RetrieverDescriptor descriptor) + { + RetrieverValue = null; + RetrieverDescriptorAction = null; + RetrieverDescriptor = descriptor; + return Self; + } + + public TextSimilarityRerankerDescriptor Retriever(Action> configure) + { + RetrieverValue = null; + RetrieverDescriptor = null; + RetrieverDescriptorAction = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(FieldValue)) + { + writer.WritePropertyName("field"); + writer.WriteStringValue(FieldValue); + } + + if (FilterDescriptor is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, FilterDescriptor, options); + } + else if (FilterDescriptorAction is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor(FilterDescriptorAction), options); + } + else if (FilterDescriptorActions is not null) + { + writer.WritePropertyName("filter"); + if (FilterDescriptorActions.Length != 1) + writer.WriteStartArray(); + foreach (var action in FilterDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor(action), options); + } + + if (FilterDescriptorActions.Length != 1) + writer.WriteEndArray(); + } + else if (FilterValue is not null) + { + writer.WritePropertyName("filter"); + SingleOrManySerializationHelper.Serialize(FilterValue, writer, options); + } + + if (!string.IsNullOrEmpty(InferenceIdValue)) + { + writer.WritePropertyName("inference_id"); + writer.WriteStringValue(InferenceIdValue); + } + + if (!string.IsNullOrEmpty(InferenceTextValue)) + { + writer.WritePropertyName("inference_text"); + writer.WriteStringValue(InferenceTextValue); + } + + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + + if (RankWindowSizeValue.HasValue) + { + writer.WritePropertyName("rank_window_size"); + writer.WriteNumberValue(RankWindowSizeValue.Value); + } + + if (RetrieverDescriptor is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverDescriptor, options); + } + else if (RetrieverDescriptorAction is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.RetrieverDescriptor(RetrieverDescriptorAction), options); + } + else + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverValue, options); + } + + writer.WriteEndObject(); + } +} + +public sealed partial class TextSimilarityRerankerDescriptor : SerializableDescriptor +{ + internal TextSimilarityRerankerDescriptor(Action configure) => configure.Invoke(this); + + public TextSimilarityRerankerDescriptor() : base() + { + } + + private string? FieldValue { get; set; } + private ICollection? FilterValue { get; set; } + private Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor FilterDescriptor { get; set; } + private Action FilterDescriptorAction { get; set; } + private Action[] FilterDescriptorActions { get; set; } + private string? InferenceIdValue { get; set; } + private string? InferenceTextValue { get; set; } + private float? MinScoreValue { get; set; } + private int? RankWindowSizeValue { get; set; } + private Elastic.Clients.Elasticsearch.Retriever RetrieverValue { get; set; } + private Elastic.Clients.Elasticsearch.RetrieverDescriptor RetrieverDescriptor { get; set; } + private Action RetrieverDescriptorAction { get; set; } + + /// + /// + /// The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text + /// + /// + public TextSimilarityRerankerDescriptor Field(string? field) + { + FieldValue = field; + return Self; + } + + /// + /// + /// Query to filter the documents that can match. + /// + /// + public TextSimilarityRerankerDescriptor Filter(ICollection? filter) + { + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterValue = filter; + return Self; + } + + public TextSimilarityRerankerDescriptor Filter(Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor descriptor) + { + FilterValue = null; + FilterDescriptorAction = null; + FilterDescriptorActions = null; + FilterDescriptor = descriptor; + return Self; + } + + public TextSimilarityRerankerDescriptor Filter(Action configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorActions = null; + FilterDescriptorAction = configure; + return Self; + } + + public TextSimilarityRerankerDescriptor Filter(params Action[] configure) + { + FilterValue = null; + FilterDescriptor = null; + FilterDescriptorAction = null; + FilterDescriptorActions = configure; + return Self; + } + + /// + /// + /// Unique identifier of the inference endpoint created using the inference API. + /// + /// + public TextSimilarityRerankerDescriptor InferenceId(string? inferenceId) + { + InferenceIdValue = inferenceId; + return Self; + } + + /// + /// + /// The text snippet used as the basis for similarity comparison + /// + /// + public TextSimilarityRerankerDescriptor InferenceText(string? inferenceText) + { + InferenceTextValue = inferenceText; + return Self; + } + + /// + /// + /// Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. + /// + /// + public TextSimilarityRerankerDescriptor MinScore(float? minScore) + { + MinScoreValue = minScore; + return Self; + } + + /// + /// + /// This value determines how many documents we will consider from the nested retriever. + /// + /// + public TextSimilarityRerankerDescriptor RankWindowSize(int? rankWindowSize) + { + RankWindowSizeValue = rankWindowSize; + return Self; + } + + /// + /// + /// The nested retriever which will produce the first-level results, that will later be used for reranking. + /// + /// + public TextSimilarityRerankerDescriptor Retriever(Elastic.Clients.Elasticsearch.Retriever retriever) + { + RetrieverDescriptor = null; + RetrieverDescriptorAction = null; + RetrieverValue = retriever; + return Self; + } + + public TextSimilarityRerankerDescriptor Retriever(Elastic.Clients.Elasticsearch.RetrieverDescriptor descriptor) + { + RetrieverValue = null; + RetrieverDescriptorAction = null; + RetrieverDescriptor = descriptor; + return Self; + } + + public TextSimilarityRerankerDescriptor Retriever(Action configure) + { + RetrieverValue = null; + RetrieverDescriptor = null; + RetrieverDescriptorAction = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(FieldValue)) + { + writer.WritePropertyName("field"); + writer.WriteStringValue(FieldValue); + } + + if (FilterDescriptor is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, FilterDescriptor, options); + } + else if (FilterDescriptorAction is not null) + { + writer.WritePropertyName("filter"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor(FilterDescriptorAction), options); + } + else if (FilterDescriptorActions is not null) + { + writer.WritePropertyName("filter"); + if (FilterDescriptorActions.Length != 1) + writer.WriteStartArray(); + foreach (var action in FilterDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.QueryDsl.QueryDescriptor(action), options); + } + + if (FilterDescriptorActions.Length != 1) + writer.WriteEndArray(); + } + else if (FilterValue is not null) + { + writer.WritePropertyName("filter"); + SingleOrManySerializationHelper.Serialize(FilterValue, writer, options); + } + + if (!string.IsNullOrEmpty(InferenceIdValue)) + { + writer.WritePropertyName("inference_id"); + writer.WriteStringValue(InferenceIdValue); + } + + if (!string.IsNullOrEmpty(InferenceTextValue)) + { + writer.WritePropertyName("inference_text"); + writer.WriteStringValue(InferenceTextValue); + } + + if (MinScoreValue.HasValue) + { + writer.WritePropertyName("min_score"); + writer.WriteNumberValue(MinScoreValue.Value); + } + + if (RankWindowSizeValue.HasValue) + { + writer.WritePropertyName("rank_window_size"); + writer.WriteNumberValue(RankWindowSizeValue.Value); + } + + if (RetrieverDescriptor is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverDescriptor, options); + } + else if (RetrieverDescriptorAction is not null) + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.RetrieverDescriptor(RetrieverDescriptorAction), options); + } + else + { + writer.WritePropertyName("retriever"); + JsonSerializer.Serialize(writer, RetrieverValue, options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Xpack/Features.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Xpack/Features.g.cs index ce73c0c79b..8648694b68 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Xpack/Features.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Xpack/Features.g.cs @@ -55,6 +55,8 @@ public sealed partial class Features public Elastic.Clients.Elasticsearch.Xpack.Feature Graph { get; init; } [JsonInclude, JsonPropertyName("ilm")] public Elastic.Clients.Elasticsearch.Xpack.Feature Ilm { get; init; } + [JsonInclude, JsonPropertyName("logsdb")] + public Elastic.Clients.Elasticsearch.Xpack.Feature Logsdb { get; init; } [JsonInclude, JsonPropertyName("logstash")] public Elastic.Clients.Elasticsearch.Xpack.Feature Logstash { get; init; } [JsonInclude, JsonPropertyName("ml")]