diff --git a/.github/workflows/docfx.yml b/.github/workflows/docfx.yml new file mode 100644 index 00000000000..5603bfc4577 --- /dev/null +++ b/.github/workflows/docfx.yml @@ -0,0 +1,74 @@ +name: 'CD' + +on: + workflow_call: + inputs: + target_branch: + description: 'The target branch to which the documentation should be pushed to.' + type: 'string' + required: true + name: + description: 'The name to use for the documentation folder (defaults to the name of the current ref)' + type: 'string' + required: false + default: ${{ github.ref_name }} + +concurrency: + group: 'docfx' + cancel-in-progress: false + +env: + # Configuration + GLOBAL_JSON_FILE: 'global.json' + CACHE_PATTERNS: '["**/*.[cf]sproj*", "**/*.Build.props"]' + # .NET SDK related environment variables + DOTNET_NOLOGO: 1 + DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1 + DOTNET_CLI_TELEMETRY_OPTOUT: 1 + DOTNET_GENERATE_ASPNET_CERTIFICATE: 0 + +jobs: + docfx: + name: 'DocFx' + runs-on: 'ubuntu-latest' + steps: + - name: 'Checkout' + uses: 'actions/checkout@v4' + + - name: '.NET Setup' + uses: 'actions/setup-dotnet@v4' + with: + global-json-file: '${{ github.workspace }}/${{ env.GLOBAL_JSON_FILE }}' + + - name: 'DocFX Setup' + run: |- + dotnet tool update -g docfx + + # TODO: Remove 'stack' + - name: '.NET Cache Packages' + uses: 'actions/cache@v4' + with: + path: '~/.nuget/packages' + key: '${{ runner.os }}-nuget-stack-${{ hashFiles(fromJson(env.CACHE_PATTERNS)) }}' + restore-keys: '${{ runner.os }}-nuget-stack-' + + - name: 'DocFx Build' + working-directory: 'docfx' + run: |- + docfx docfx.json + mv ./_site ./../.. + + - name: 'Checkout' + uses: 'actions/checkout@v4' + with: + ref: ${{ inputs.target_branch }} + + - name: 'Commit' + run: |- + rm -r "./${{ inputs.name }}" || true + mv ../_site "./${{ inputs.name }}" + git config --global user.name '${{ github.actor }}' + git config --global user.email '${{ github.actor }}@users.noreply.github.com' + git add -A + git commit -am "Add ${{ inputs.name }}" + git push diff --git a/.github/workflows/docfx_manual.yml b/.github/workflows/docfx_manual.yml new file mode 100644 index 00000000000..42179cc4d72 --- /dev/null +++ b/.github/workflows/docfx_manual.yml @@ -0,0 +1,12 @@ +name: 'DocFx' + +on: + workflow_dispatch: + +jobs: + docfx: + name: 'DocFx' + uses: ./.github/workflows/docfx.yml + with: + target_branch: 'refdoc' + secrets: 'inherit' diff --git a/.github/workflows/release_stack.yml b/.github/workflows/release_stack.yml index ab1835054d6..a282c232ab6 100644 --- a/.github/workflows/release_stack.yml +++ b/.github/workflows/release_stack.yml @@ -16,3 +16,12 @@ jobs: release_tag: ${{ github.event.release.tag_name }} release_body: ${{ github.event.release.body }} secrets: 'inherit' + + docfx: + name: 'DocFx' + if: ${{ !startsWith(github.event.release.tag_name, 'serverless-') }} + uses: ./.github/workflows/docfx.yml + with: + name: ${{ github.event.release.tag_name }} + target_branch: 'refdoc' + secrets: 'inherit' diff --git a/README.md b/README.md index baba08d5f07..067f7fdceb5 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,8 @@ Please refer to [the full documentation on elastic.co](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/index.html) for comprehensive information on installation, configuration and usage. +The API reference documentation is available [here](https://elastic.github.io/elasticsearch-net). + ## Versions ### Elasticsearch 8.x Clusters diff --git a/benchmarks/Benchmarks/Benchmarks.csproj b/benchmarks/Benchmarks/Benchmarks.csproj index c0d9345a5d7..00e4ad09fd9 100644 --- a/benchmarks/Benchmarks/Benchmarks.csproj +++ b/benchmarks/Benchmarks/Benchmarks.csproj @@ -2,7 +2,7 @@ Exe - net6.0 + net8.0 enable enable True diff --git a/benchmarks/Profiling/Profiling.csproj b/benchmarks/Profiling/Profiling.csproj index 876544fa764..e591f4ab2c7 100644 --- a/benchmarks/Profiling/Profiling.csproj +++ b/benchmarks/Profiling/Profiling.csproj @@ -2,7 +2,7 @@ Exe - net6.0 + net8.0 enable diff --git a/docfx/.gitignore b/docfx/.gitignore new file mode 100644 index 00000000000..0f17bd3852a --- /dev/null +++ b/docfx/.gitignore @@ -0,0 +1,2 @@ +_site +api diff --git a/docfx.json b/docfx/docfx.json similarity index 84% rename from docfx.json rename to docfx/docfx.json index 3b0069106e2..dc98c5280f9 100644 --- a/docfx.json +++ b/docfx/docfx.json @@ -3,9 +3,9 @@ { "src": [ { - "src": "./src/Elastic.Clients.Elasticsearch", + "src": "../src", "files": [ - "**/*.csproj" + "**/Elastic.Clients.Elasticsearch.csproj" ] } ], @@ -38,6 +38,7 @@ "globalMetadata": { "_appName": "Elasticsearch.NET", "_appTitle": "Elasticsearch.NET", + "_appLogoPath": "images/logo.svg", "_enableSearch": true, "_disableContribution": true, "pdf": false diff --git a/docfx/images/logo.svg b/docfx/images/logo.svg new file mode 100644 index 00000000000..be8c924e331 --- /dev/null +++ b/docfx/images/logo.svg @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/docfx/index.md b/docfx/index.md new file mode 100644 index 00000000000..cb05b109570 --- /dev/null +++ b/docfx/index.md @@ -0,0 +1,9 @@ +--- +_layout: landing +--- + +# Elasticsearch .NET API + +This is the home of the Elasticsearch .NET Client API Reference Documentation. + +Please click on `API` in the top menu to get to the API overview. diff --git a/docfx/toc.yml b/docfx/toc.yml new file mode 100644 index 00000000000..a2a2fa2bc1f --- /dev/null +++ b/docfx/toc.yml @@ -0,0 +1,2 @@ +- name: API + href: api/ \ No newline at end of file diff --git a/docs/index.asciidoc b/docs/index.asciidoc index c70fe7f73a5..70d8bbadada 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -6,7 +6,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :doc-tests-src: {docdir}/../tests/Tests/Documentation :net-client: Elasticsearch .NET Client -:latest-version: 8.1.0 +:latest-version: 8.15.8 include::intro.asciidoc[] diff --git a/docs/migration-guide.asciidoc b/docs/migration-guide.asciidoc index 21f78589c19..1d3ae76032c 100644 --- a/docs/migration-guide.asciidoc +++ b/docs/migration-guide.asciidoc @@ -292,13 +292,43 @@ As a last resort, the low-level client `Elastic.Transport` can be used to create [source,csharp] ---- +public class MyRequestParameters : RequestParameters +{ + public bool Pretty + { + get => Q("pretty"); + init => Q("pretty", value); + } +} + +// ... + var body = """ - { - "name": "my-api-key", - "expiration": "1d", - "...": "..." - } - """; - -var response = await client.Transport.RequestAsync(HttpMethod.POST, "/_security/api_key", PostData.String(body)); + { + "name": "my-api-key", + "expiration": "1d", + "...": "..." + } + """; + +MyRequestParameters requestParameters = new() +{ + Pretty = true +}; + +var pathAndQuery = requestParameters.CreatePathWithQueryStrings("/_security/api_key", + client.ElasticsearchClientSettings); +var endpointPath = new EndpointPath(Elastic.Transport.HttpMethod.POST, pathAndQuery); + +// Or, if the path does not contain query parameters: +// new EndpointPath(Elastic.Transport.HttpMethod.POST, "my_path") + +var response = await client.Transport + .RequestAsync( + endpointPath, + PostData.String(body), + null, + null, + cancellationToken: default) + .ConfigureAwait(false); ---- \ No newline at end of file diff --git a/docs/usage/aggregations.asciidoc b/docs/usage/aggregations.asciidoc new file mode 100644 index 00000000000..1f159763aaa --- /dev/null +++ b/docs/usage/aggregations.asciidoc @@ -0,0 +1,131 @@ +[[aggregations]] +== Aggregation examples + +This page demonstrates how to use aggregations. + +[discrete] +=== Top-level aggreggation + +[discrete] +==== Fluent API + +[source,csharp] +---- +var response = await client + .SearchAsync(search => search + .Index("persons") + .Query(query => query + .MatchAll(_ => {}) + ) + .Aggregations(aggregations => aggregations + .Add("agg_name", aggregation => aggregation + .Max(max => max + .Field(x => x.Age) + ) + ) + ) + .Size(10) + ); +---- + +[discrete] +==== Object initializer API + +[source,csharp] +---- +var response = await client.SearchAsync(new SearchRequest("persons") +{ + Query = Query.MatchAll(new MatchAllQuery()), + Aggregations = new Dictionary + { + { "agg_name", Aggregation.Max(new MaxAggregation + { + Field = Infer.Field(x => x.Age) + })} + }, + Size = 10 +}); +---- + +[discrete] +==== Consume the response + +[source,csharp] +---- +var max = response.Aggregations!.GetMax("agg_name")!; +Console.WriteLine(max.Value); +---- + +[discrete] +=== Sub-aggregation + +[discrete] +==== Fluent API + +[source,csharp] +---- +var response = await client + .SearchAsync(search => search + .Index("persons") + .Query(query => query + .MatchAll(_ => {}) + ) + .Aggregations(aggregations => aggregations + .Add("firstnames", aggregation => aggregation + .Terms(terms => terms + .Field(x => x.FirstName) + ) + .Aggregations(aggregations => aggregations + .Add("avg_age", aggregation => aggregation + .Max(avg => avg + .Field(x => x.Age) + ) + ) + ) + ) + ) + .Size(10) + ); +---- + +[discrete] +==== Object initializer API + +[source,csharp] +---- +var topLevelAggregation = Aggregation.Terms(new TermsAggregation +{ + Field = Infer.Field(x => x.FirstName) +}); + +topLevelAggregation.Aggregations = new Dictionary +{ + { "avg_age", new MaxAggregation + { + Field = Infer.Field(x => x.Age) + }} +}; + +var response = await client.SearchAsync(new SearchRequest("persons") +{ + Query = Query.MatchAll(new MatchAllQuery()), + Aggregations = new Dictionary + { + { "firstnames", topLevelAggregation} + }, + Size = 10 +}); +---- + +[discrete] +==== Consume the response + +[source,csharp] +---- +var firstnames = response.Aggregations!.GetStringTerms("firstnames")!; +foreach (var bucket in firstnames.Buckets) +{ + var avg = bucket.Aggregations.GetAverage("avg_age")!; + Console.WriteLine($"The average age for persons named '{bucket.Key}' is {avg}"); +} +---- diff --git a/docs/usage/index.asciidoc b/docs/usage/index.asciidoc index 06bc4250ddd..f4ae4474730 100644 --- a/docs/usage/index.asciidoc +++ b/docs/usage/index.asciidoc @@ -6,12 +6,20 @@ The sections below provide tutorials on the most frequently used and some less o For a full reference, see the {ref}/[Elasticsearch documentation] and in particular the {ref}/rest-apis.html[REST APIs] section. The {net-client} follows closely the JSON structures described there. +A .NET API reference documentation for the Elasticsearch client package is available https://elastic.github.io/elasticsearch-net[here]. + If you're new to {es}, make sure also to read {ref}/getting-started.html[Elasticsearch's quick start] that provides a good introduction. * <> * <> +* <> NOTE: This is still a work in progress, more sections will be added in the near future. -include::recommendations.asciidoc[] +include::aggregations.asciidoc[] +include::esql.asciidoc[] include::examples.asciidoc[] +include::mappings.asciidoc[] +include::query.asciidoc[] +include::recommendations.asciidoc[] +include::transport.asciidoc[] diff --git a/docs/usage/mappings.asciidoc b/docs/usage/mappings.asciidoc new file mode 100644 index 00000000000..13d62f63147 --- /dev/null +++ b/docs/usage/mappings.asciidoc @@ -0,0 +1,34 @@ +[[mappings]] +== Custom mapping examples + +This page demonstrates how to configure custom mappings on an index. + +[discrete] +=== Configure mappings during index creation + +[source,csharp] +---- +await client.Indices.CreateAsync(index => index + .Index("index") + .Mappings(mappings => mappings + .Properties(properties => properties + .IntegerNumber(x => x.Age!) + .Keyword(x => x.FirstName!, keyword => keyword.Index(false)) + ) + ) +); +---- + +[discrete] +=== Configure mappings after index creation + +[source,csharp] +---- +await client.Indices.PutMappingAsync(mappings => mappings + .Indices("index") + .Properties(properties => properties + .IntegerNumber(x => x.Age!) + .Keyword(x => x.FirstName!, keyword => keyword.Index(false)) + ) +); +---- diff --git a/docs/usage/query.asciidoc b/docs/usage/query.asciidoc new file mode 100644 index 00000000000..b365825cdbd --- /dev/null +++ b/docs/usage/query.asciidoc @@ -0,0 +1,50 @@ +[[query]] +== Query examples + +This page demonstrates how to perform a search request. + +[discrete] +=== Fluent API + +[source,csharp] +---- +var response = await client + .SearchAsync(search => search + .Index("persons") + .Query(query => query + .Term(term => term + .Field(x => x.FirstName) + .Value("Florian") + ) + ) + .Size(10) + ); +---- + +[discrete] +=== Object initializer API + +[source,csharp] +---- +var response = await client + .SearchAsync(new SearchRequest("persons") + { + Query = Query.Term(new TermQuery(Infer.Field(x => x.FirstName)) + { + Value = "Florian" + }), + Size = 10 + }); +---- + + +[discrete] +=== Consume the response + +[source,csharp] +---- +foreach (var person in response.Documents) +{ + Console.WriteLine(person.FirstName); +} +---- diff --git a/docs/usage/transport.asciidoc b/docs/usage/transport.asciidoc new file mode 100644 index 00000000000..3e15fbd0b90 --- /dev/null +++ b/docs/usage/transport.asciidoc @@ -0,0 +1,47 @@ +[[transport]] +== Transport example + +This page demonstrates how to use the low level transport to send requests. + +[source,csharp] +---- +public class MyRequestParameters : RequestParameters +{ + public bool Pretty + { + get => Q("pretty"); + init => Q("pretty", value); + } +} + +// ... + +var body = """ + { + "name": "my-api-key", + "expiration": "1d", + "...": "..." + } + """; + +MyRequestParameters requestParameters = new() +{ + Pretty = true +}; + +var pathAndQuery = requestParameters.CreatePathWithQueryStrings("/_security/api_key", + client.ElasticsearchClientSettings); +var endpointPath = new EndpointPath(Elastic.Transport.HttpMethod.POST, pathAndQuery); + +// Or, if the path does not contain query parameters: +// new EndpointPath(Elastic.Transport.HttpMethod.POST, "my_path") + +var response = await client.Transport + .RequestAsync( + endpointPath, + PostData.String(body), + null, + null, + cancellationToken: default) + .ConfigureAwait(false); +---- diff --git a/src/Elastic.Clients.Elasticsearch.JsonNetSerializer/Elastic.Clients.Elasticsearch.JsonNetSerializer.csproj b/src/Elastic.Clients.Elasticsearch.JsonNetSerializer/Elastic.Clients.Elasticsearch.JsonNetSerializer.csproj index 15603cdefd1..5dcb5ab51b3 100644 --- a/src/Elastic.Clients.Elasticsearch.JsonNetSerializer/Elastic.Clients.Elasticsearch.JsonNetSerializer.csproj +++ b/src/Elastic.Clients.Elasticsearch.JsonNetSerializer/Elastic.Clients.Elasticsearch.JsonNetSerializer.csproj @@ -10,7 +10,7 @@ true true - netstandard2.0;net462;netstandard2.1;net6.0;net8.0 + netstandard2.0;net462;netstandard2.1;net8.0 diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/Core/ElasticsearchClientProductRegistration.cs b/src/Elastic.Clients.Elasticsearch.Serverless/Core/ElasticsearchClientProductRegistration.cs index 225f124c7c1..cfe03c51617 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/Core/ElasticsearchClientProductRegistration.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/Core/ElasticsearchClientProductRegistration.cs @@ -25,14 +25,14 @@ public ElasticsearchClientProductRegistration(Type markerType) : base(markerType public override string ServiceIdentifier => "esv"; - public override string DefaultMimeType => null; // Prevent base 'ElasticsearchProductRegistration' from sending the compatibility header + public override string? DefaultContentType => null; // Prevent base 'ElasticsearchProductRegistration' from sending the compatibility header public override MetaHeaderProvider MetaHeaderProvider => _metaHeaderProvider; /// /// Elastic.Clients.Elasticsearch handles 404 in its , we do not want the low level client throwing /// exceptions - /// when is enabled for 404's. The client is in charge of + /// when is enabled for 404's. The client is in charge of /// composing paths /// so a 404 never signals a wrong URL but a missing entity. /// @@ -77,7 +77,7 @@ public class ApiVersionMetaHeaderProducer : MetaHeaderProducer public override string HeaderName => "Elastic-Api-Version"; - public override string ProduceHeaderValue(RequestData requestData) => _apiVersion; + public override string ProduceHeaderValue(BoundConfiguration boundConfiguration, bool isAsync) => _apiVersion; public ApiVersionMetaHeaderProducer(VersionInfo version) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/Elastic.Clients.Elasticsearch.Serverless.csproj b/src/Elastic.Clients.Elasticsearch.Serverless/Elastic.Clients.Elasticsearch.Serverless.csproj index 4e00bb4e38c..8ba54c7ca36 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/Elastic.Clients.Elasticsearch.Serverless.csproj +++ b/src/Elastic.Clients.Elasticsearch.Serverless/Elastic.Clients.Elasticsearch.Serverless.csproj @@ -15,13 +15,13 @@ true true - netstandard2.0;net462;netstandard2.1;net6.0;net8.0 + netstandard2.0;net462;netstandard2.1;net8.0 true true annotations - + 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 a95353e6107..3513b8150f9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ApiUrlLookup.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/ApiUrlLookup.g.cs @@ -88,13 +88,20 @@ 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 IngestDeleteIpLocationDatabase = new ApiUrls(new[] { "_ingest/ip_location/database/{id}" }); internal static ApiUrls IngestDeletePipeline = new ApiUrls(new[] { "_ingest/pipeline/{id}" }); internal static ApiUrls IngestGeoIpStats = new ApiUrls(new[] { "_ingest/geoip/stats" }); internal static ApiUrls IngestGetGeoipDatabase = new ApiUrls(new[] { "_ingest/geoip/database", "_ingest/geoip/database/{id}" }); + internal static ApiUrls IngestGetIpLocationDatabase = new ApiUrls(new[] { "_ingest/ip_location/database", "_ingest/ip_location/database/{id}" }); internal static ApiUrls IngestGetPipeline = new ApiUrls(new[] { "_ingest/pipeline", "_ingest/pipeline/{id}" }); internal static ApiUrls IngestProcessorGrok = new ApiUrls(new[] { "_ingest/processor/grok" }); internal static ApiUrls IngestPutGeoipDatabase = new ApiUrls(new[] { "_ingest/geoip/database/{id}" }); + internal static ApiUrls IngestPutIpLocationDatabase = new ApiUrls(new[] { "_ingest/ip_location/database/{id}" }); internal static ApiUrls IngestPutPipeline = new ApiUrls(new[] { "_ingest/pipeline/{id}" }); internal static ApiUrls IngestSimulate = new ApiUrls(new[] { "_ingest/pipeline/_simulate", "_ingest/pipeline/{id}/_simulate" }); internal static ApiUrls LicenseManagementGet = new ApiUrls(new[] { "_license" }); @@ -218,6 +225,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 c87bdfffbbe..23a2a730ace 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 @@ -32,12 +32,21 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch; public sealed partial class AsyncSearchStatusRequestParameters : RequestParameters { + /// + /// + /// Specifies how long the async search needs to be available. + /// Ongoing async searches and any saved search results are deleted after this period. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } } /// /// -/// 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. /// /// @@ -54,12 +63,23 @@ public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) internal override bool SupportsBody => false; internal override string OperationName => "async_search.status"; + + /// + /// + /// Specifies how long the async search needs to be available. + /// Ongoing async searches and any saved search results are deleted after this period. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } } /// /// -/// 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. /// /// @@ -79,6 +99,8 @@ public AsyncSearchStatusRequestDescriptor(Elastic.Clients.Elasticsearch.Serverle internal override string OperationName => "async_search.status"; + public AsyncSearchStatusRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Serverless.Duration? keepAlive) => Qs("keep_alive", keepAlive); + public AsyncSearchStatusRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) { RouteValues.Required("id", id); @@ -92,8 +114,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. /// /// @@ -113,6 +137,8 @@ public AsyncSearchStatusRequestDescriptor(Elastic.Clients.Elasticsearch.Serverle internal override string OperationName => "async_search.status"; + public AsyncSearchStatusRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Serverless.Duration? keepAlive) => Qs("keep_alive", keepAlive); + public AsyncSearchStatusRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) { RouteValues.Required("id", id); 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 5f52d5657f5..3d0db2d1b6f 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 eb6996e3141..773597370a7 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 201bd4cacd2..da346fb535f 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 @@ -110,14 +110,6 @@ public sealed partial class SubmitAsyncSearchRequestParameters : RequestParamete /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - /// - /// - /// Specifies how long the async search needs to be available. - /// Ongoing async searches and any saved search results are deleted after this period. - /// - /// - public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } - /// /// /// If true, results are stored for later retrieval when the search completes within the wait_for_completion_timeout. @@ -138,7 +130,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); } /// /// @@ -149,24 +140,23 @@ public sealed partial class SubmitAsyncSearchRequestParameters : RequestParamete /// /// - /// The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. + /// Query in the Lucene query string syntax /// /// - public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } + public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// /// - /// Query in the Lucene query string syntax + /// Specify if request cache should be used for this request or not, defaults to true /// /// - public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } + public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// /// - /// Specify if request cache should be used for this request or not, defaults to true + /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response /// /// - public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// @@ -175,7 +165,6 @@ public sealed partial class SubmitAsyncSearchRequestParameters : RequestParamete /// /// public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } - public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// /// @@ -652,10 +641,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. /// /// @@ -767,15 +762,6 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - /// - /// - /// Specifies how long the async search needs to be available. - /// Ongoing async searches and any saved search results are deleted after this period. - /// - /// - [JsonIgnore] - public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } - /// /// /// If true, results are stored for later retrieval when the search completes within the wait_for_completion_timeout. @@ -799,8 +785,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); } /// /// @@ -812,28 +796,26 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices /// /// - /// The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. + /// Query in the Lucene query string syntax /// /// [JsonIgnore] - public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } + public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// /// - /// Query in the Lucene query string syntax + /// Specify if request cache should be used for this request or not, defaults to true /// /// [JsonIgnore] - public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } + public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// /// - /// Specify if request cache should be used for this request or not, defaults to true + /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response /// /// [JsonIgnore] - public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } - [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// @@ -843,8 +825,6 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Serverless.Routing? Routing { get => Q("routing"); set => Q("routing", value); } - [JsonIgnore] - public Elastic.Clients.Elasticsearch.Serverless.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// /// @@ -1145,10 +1125,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. /// /// @@ -1183,18 +1169,14 @@ public SubmitAsyncSearchRequestDescriptor() public SubmitAsyncSearchRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public SubmitAsyncSearchRequestDescriptor IgnoreThrottled(bool? ignoreThrottled = true) => Qs("ignore_throttled", ignoreThrottled); public SubmitAsyncSearchRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public SubmitAsyncSearchRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Serverless.Duration? keepAlive) => Qs("keep_alive", keepAlive); 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); public SubmitAsyncSearchRequestDescriptor RequestCache(bool? requestCache = true) => Qs("request_cache", requestCache); public SubmitAsyncSearchRequestDescriptor RestTotalHitsAsInt(bool? restTotalHitsAsInt = true) => Qs("rest_total_hits_as_int", restTotalHitsAsInt); public SubmitAsyncSearchRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) => Qs("routing", routing); - public SubmitAsyncSearchRequestDescriptor Scroll(Elastic.Clients.Elasticsearch.Serverless.Duration? scroll) => Qs("scroll", scroll); public SubmitAsyncSearchRequestDescriptor SearchType(Elastic.Clients.Elasticsearch.Serverless.SearchType? searchType) => Qs("search_type", searchType); public SubmitAsyncSearchRequestDescriptor SourceExcludes(Elastic.Clients.Elasticsearch.Serverless.Fields? sourceExcludes) => Qs("_source_excludes", sourceExcludes); public SubmitAsyncSearchRequestDescriptor SourceIncludes(Elastic.Clients.Elasticsearch.Serverless.Fields? sourceIncludes) => Qs("_source_includes", sourceIncludes); @@ -2264,10 +2246,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. /// /// @@ -2302,18 +2290,14 @@ public SubmitAsyncSearchRequestDescriptor() public SubmitAsyncSearchRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public SubmitAsyncSearchRequestDescriptor IgnoreThrottled(bool? ignoreThrottled = true) => Qs("ignore_throttled", ignoreThrottled); public SubmitAsyncSearchRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public SubmitAsyncSearchRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Serverless.Duration? keepAlive) => Qs("keep_alive", keepAlive); 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); public SubmitAsyncSearchRequestDescriptor RequestCache(bool? requestCache = true) => Qs("request_cache", requestCache); public SubmitAsyncSearchRequestDescriptor RestTotalHitsAsInt(bool? restTotalHitsAsInt = true) => Qs("rest_total_hits_as_int", restTotalHitsAsInt); public SubmitAsyncSearchRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) => Qs("routing", routing); - public SubmitAsyncSearchRequestDescriptor Scroll(Elastic.Clients.Elasticsearch.Serverless.Duration? scroll) => Qs("scroll", scroll); public SubmitAsyncSearchRequestDescriptor SearchType(Elastic.Clients.Elasticsearch.Serverless.SearchType? searchType) => Qs("search_type", searchType); public SubmitAsyncSearchRequestDescriptor SourceExcludes(Elastic.Clients.Elasticsearch.Serverless.Fields? sourceExcludes) => Qs("_source_excludes", sourceExcludes); public SubmitAsyncSearchRequestDescriptor SourceIncludes(Elastic.Clients.Elasticsearch.Serverless.Fields? sourceIncludes) => Qs("_source_includes", sourceIncludes); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/BulkRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/BulkRequest.g.cs index 889eec89881..911de7c5c91 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/BulkRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/BulkRequest.g.cs @@ -32,6 +32,13 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class BulkRequestParameters : RequestParameters { + /// + /// + /// If true, the response will include the ingest pipelines that were executed for each index or create. + /// + /// + public bool? ListExecutedPipelines { get => Q("list_executed_pipelines"); set => Q("list_executed_pipelines", value); } + /// /// /// ID of the pipeline to use to preprocess incoming documents. @@ -56,6 +63,13 @@ public sealed partial class BulkRequestParameters : RequestParameters /// public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } + /// + /// + /// If true, the request's actions must target a data stream (existing or to-be-created). + /// + /// + public bool? RequireDataStream { get => Q("require_data_stream"); set => Q("require_data_stream", value); } + /// /// /// Custom value used to route operations to a specific shard. @@ -125,6 +139,14 @@ public BulkRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) : internal override string OperationName => "bulk"; + /// + /// + /// If true, the response will include the ingest pipelines that were executed for each index or create. + /// + /// + [JsonIgnore] + public bool? ListExecutedPipelines { get => Q("list_executed_pipelines"); set => Q("list_executed_pipelines", value); } + /// /// /// ID of the pipeline to use to preprocess incoming documents. @@ -152,6 +174,14 @@ public BulkRequest(Elastic.Clients.Elasticsearch.Serverless.IndexName? index) : [JsonIgnore] public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } + /// + /// + /// If true, the request's actions must target a data stream (existing or to-be-created). + /// + /// + [JsonIgnore] + public bool? RequireDataStream { get => Q("require_data_stream"); set => Q("require_data_stream", value); } + /// /// /// Custom value used to route operations to a specific shard. @@ -229,9 +259,11 @@ public BulkRequestDescriptor() : this(typeof(TDocument)) internal override string OperationName => "bulk"; + public BulkRequestDescriptor ListExecutedPipelines(bool? listExecutedPipelines = true) => Qs("list_executed_pipelines", listExecutedPipelines); public BulkRequestDescriptor Pipeline(string? pipeline) => Qs("pipeline", pipeline); public BulkRequestDescriptor Refresh(Elastic.Clients.Elasticsearch.Serverless.Refresh? refresh) => Qs("refresh", refresh); public BulkRequestDescriptor RequireAlias(bool? requireAlias = true) => Qs("require_alias", requireAlias); + public BulkRequestDescriptor RequireDataStream(bool? requireDataStream = true) => Qs("require_data_stream", requireDataStream); public BulkRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) => Qs("routing", routing); public BulkRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? source) => Qs("_source", source); public BulkRequestDescriptor SourceExcludes(Elastic.Clients.Elasticsearch.Serverless.Fields? sourceExcludes) => Qs("_source_excludes", sourceExcludes); @@ -279,9 +311,11 @@ public BulkRequestDescriptor() internal override string OperationName => "bulk"; + public BulkRequestDescriptor ListExecutedPipelines(bool? listExecutedPipelines = true) => Qs("list_executed_pipelines", listExecutedPipelines); public BulkRequestDescriptor Pipeline(string? pipeline) => Qs("pipeline", pipeline); public BulkRequestDescriptor Refresh(Elastic.Clients.Elasticsearch.Serverless.Refresh? refresh) => Qs("refresh", refresh); public BulkRequestDescriptor RequireAlias(bool? requireAlias = true) => Qs("require_alias", requireAlias); + public BulkRequestDescriptor RequireDataStream(bool? requireDataStream = true) => Qs("require_data_stream", requireDataStream); public BulkRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Serverless.Routing? routing) => Qs("routing", routing); public BulkRequestDescriptor Source(Elastic.Clients.Elasticsearch.Serverless.Core.Search.SourceConfigParam? source) => Qs("_source", source); public BulkRequestDescriptor SourceExcludes(Elastic.Clients.Elasticsearch.Serverless.Fields? sourceExcludes) => Qs("_source_excludes", sourceExcludes); 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 5ef6d921fee..d0dec945da3 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 fce101f4962..843be08f62d 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/Cluster/AllocationExplainRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/AllocationExplainRequest.g.cs index 7dbc3bec9aa..986ef49cab9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/AllocationExplainRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/AllocationExplainRequest.g.cs @@ -49,7 +49,11 @@ public sealed partial class AllocationExplainRequestParameters : RequestParamete /// /// -/// Provides explanations for shard allocations in the cluster. +/// Explain the shard allocations. +/// Get explanations for shard allocations in the cluster. +/// For unassigned shards, it provides an explanation for why the shard is unassigned. +/// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. +/// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// /// public sealed partial class AllocationExplainRequest : PlainRequest @@ -113,7 +117,11 @@ public sealed partial class AllocationExplainRequest : PlainRequest /// -/// Provides explanations for shard allocations in the cluster. +/// Explain the shard allocations. +/// Get explanations for shard allocations in the cluster. +/// For unassigned shards, it provides an explanation for why the shard is unassigned. +/// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. +/// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// /// public sealed partial class AllocationExplainRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterStatsRequest.g.cs index 13e796ad368..adcc13f8058 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/ClusterStatsRequest.g.cs @@ -51,8 +51,8 @@ public sealed partial class ClusterStatsRequestParameters : RequestParameters /// /// -/// 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). +/// Get cluster statistics. +/// Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// /// public sealed partial class ClusterStatsRequest : PlainRequest @@ -94,8 +94,8 @@ public ClusterStatsRequest(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nod /// /// -/// 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). +/// Get cluster statistics. +/// Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// /// public sealed partial class ClusterStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs index f1fea9585c1..18138758000 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs @@ -65,7 +65,7 @@ public sealed partial class GetClusterSettingsRequestParameters : RequestParamet /// /// -/// Returns cluster-wide settings. +/// Get cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// /// @@ -116,7 +116,7 @@ public sealed partial class GetClusterSettingsRequest : PlainRequest /// -/// Returns cluster-wide settings. +/// Get cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/HealthRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/HealthRequest.g.cs index 147223cde7a..935701c3aa5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/HealthRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/HealthRequest.g.cs @@ -112,8 +112,18 @@ public sealed partial class HealthRequestParameters : RequestParameters /// /// -/// 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. +/// Get the cluster health status. +/// 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. Green means that all shards are allocated. +/// The index level status is controlled by the worst shard status. +/// +/// +/// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. +/// The cluster status is controlled by the worst index status. /// /// public sealed partial class HealthRequest : PlainRequest @@ -225,8 +235,18 @@ public HealthRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) /// /// -/// 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. +/// Get the cluster health status. +/// 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. Green means that all shards are allocated. +/// The index level status is controlled by the worst shard status. +/// +/// +/// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. +/// The cluster status is controlled by the worst index status. /// /// public sealed partial class HealthRequestDescriptor : RequestDescriptor, HealthRequestParameters> @@ -274,8 +294,18 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. -/// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// Get the cluster health status. +/// 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. Green means that all shards are allocated. +/// The index level status is controlled by the worst shard status. +/// +/// +/// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. +/// The cluster status is controlled by the worst index status. /// /// public sealed partial class HealthRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PendingTasksRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PendingTasksRequest.g.cs index 1e2e00c2840..0d272d928cc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PendingTasksRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Cluster/PendingTasksRequest.g.cs @@ -51,9 +51,12 @@ public sealed partial class PendingTasksRequestParameters : RequestParameters /// /// -/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. +/// Get the pending cluster tasks. +/// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. +/// +/// /// NOTE: This API returns a list of any pending updates to the cluster state. -/// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. +/// 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. /// /// @@ -88,9 +91,12 @@ public sealed partial class PendingTasksRequest : PlainRequest /// -/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. +/// Get the pending cluster tasks. +/// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. +/// +/// /// NOTE: This API returns a list of any pending updates to the cluster state. -/// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. +/// 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. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/CountRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/CountRequest.g.cs index 2fb04c094d4..5e91835c79f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/CountRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/CountRequest.g.cs @@ -143,7 +143,8 @@ public sealed partial class CountRequestParameters : RequestParameters /// /// -/// Returns number of documents matching a query. +/// Count search results. +/// Get the number of documents matching a query. /// /// public partial class CountRequest : PlainRequest @@ -297,7 +298,8 @@ public CountRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) : /// /// -/// Returns number of documents matching a query. +/// Count search results. +/// Get the number of documents matching a query. /// /// public sealed partial class CountRequestDescriptor : RequestDescriptor, CountRequestParameters> @@ -399,7 +401,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns number of documents matching a query. +/// Count search results. +/// Get the number of documents matching a query. /// /// public sealed partial class CountRequestDescriptor : 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 e56fc10d40d..4b332640fe0 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/Enrich/ExecutePolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs index bfcd84f9629..e99a7fa485a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs @@ -42,7 +42,8 @@ public sealed partial class ExecutePolicyRequestParameters : RequestParameters /// /// -/// Creates the enrich index for an existing enrich policy. +/// Run an enrich policy. +/// Create the enrich index for an existing enrich policy. /// /// public sealed partial class ExecutePolicyRequest : PlainRequest @@ -70,7 +71,8 @@ public ExecutePolicyRequest(Elastic.Clients.Elasticsearch.Serverless.Name name) /// /// -/// Creates the enrich index for an existing enrich policy. +/// Run an enrich policy. +/// Create the enrich index for an existing enrich policy. /// /// public sealed partial class ExecutePolicyRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlDeleteRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlDeleteRequest.g.cs index 26bafe47bd1..1559fb99b38 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlDeleteRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlDeleteRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class EqlDeleteRequestParameters : RequestParameters /// /// -/// Deletes an async EQL search or a stored synchronous EQL search. +/// Delete an async EQL search. +/// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// @@ -57,7 +58,8 @@ public EqlDeleteRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base(r /// /// -/// Deletes an async EQL search or a stored synchronous EQL search. +/// Delete an async EQL search. +/// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// @@ -90,7 +92,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes an async EQL search or a stored synchronous EQL search. +/// Delete an async EQL search. +/// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetRequest.g.cs index c9192b2f318..20655ebd2ea 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetRequest.g.cs @@ -51,7 +51,8 @@ public sealed partial class EqlGetRequestParameters : RequestParameters /// /// -/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// Get async EQL search results. +/// Get the current status and available results for an async EQL search or a stored synchronous EQL search. /// /// public sealed partial class EqlGetRequest : PlainRequest @@ -89,7 +90,8 @@ public EqlGetRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base(r => /// /// -/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// Get async EQL search results. +/// Get the current status and available results for an async EQL search or a stored synchronous EQL search. /// /// public sealed partial class EqlGetRequestDescriptor : RequestDescriptor, EqlGetRequestParameters> @@ -124,7 +126,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// Get async EQL search results. +/// Get the current status and available results for an async EQL search or a stored synchronous EQL search. /// /// public sealed partial class EqlGetRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetResponse.g.cs index da48b383e07..19dc034e90b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlGetResponse.g.cs @@ -60,6 +60,14 @@ public sealed partial class EqlGetResponse : ElasticsearchResponse [JsonInclude, JsonPropertyName("is_running")] public bool? IsRunning { get; init; } + /// + /// + /// Contains information about shard failures (if any), in case allow_partial_search_results=true + /// + /// + [JsonInclude, JsonPropertyName("shard_failures")] + public IReadOnlyCollection? ShardFailures { get; init; } + /// /// /// If true, the request timed out before completion. 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 f01dfc28fc2..41ebfb7e630 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 @@ -45,7 +45,9 @@ public sealed partial class EqlSearchRequestParameters : RequestParameters /// /// -/// Returns results matching a query expressed in Event Query Language (EQL) +/// Get EQL search results. +/// Returns search results for an Event Query Language (EQL) query. +/// EQL assumes each document in a data stream or index corresponds to an event. /// /// public sealed partial class EqlSearchRequest : PlainRequest @@ -74,6 +76,10 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } + [JsonInclude, JsonPropertyName("allow_partial_search_results")] + public bool? AllowPartialSearchResults { get; set; } + [JsonInclude, JsonPropertyName("allow_partial_sequence_results")] + public bool? AllowPartialSequenceResults { get; set; } [JsonInclude, JsonPropertyName("case_sensitive")] public bool? CaseSensitive { get; set; } @@ -115,6 +121,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. @@ -156,7 +172,9 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices /// /// -/// Returns results matching a query expressed in Event Query Language (EQL) +/// Get EQL search results. +/// Returns search results for an Event Query Language (EQL) query. +/// EQL assumes each document in a data stream or index corresponds to an event. /// /// public sealed partial class EqlSearchRequestDescriptor : RequestDescriptor, EqlSearchRequestParameters> @@ -189,6 +207,8 @@ public EqlSearchRequestDescriptor Indices(Elastic.Clients.Elasticsear return Self; } + private bool? AllowPartialSearchResultsValue { get; set; } + private bool? AllowPartialSequenceResultsValue { get; set; } private bool? CaseSensitiveValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Field? EventCategoryFieldValue { get; set; } private int? FetchSizeValue { get; set; } @@ -202,6 +222,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; } @@ -210,6 +231,18 @@ public EqlSearchRequestDescriptor Indices(Elastic.Clients.Elasticsear private Elastic.Clients.Elasticsearch.Serverless.Field? TimestampFieldValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeoutValue { get; set; } + public EqlSearchRequestDescriptor AllowPartialSearchResults(bool? allowPartialSearchResults = true) + { + AllowPartialSearchResultsValue = allowPartialSearchResults; + return Self; + } + + public EqlSearchRequestDescriptor AllowPartialSequenceResults(bool? allowPartialSequenceResults = true) + { + AllowPartialSequenceResultsValue = allowPartialSequenceResults; + return Self; + } + public EqlSearchRequestDescriptor CaseSensitive(bool? caseSensitive = true) { CaseSensitiveValue = caseSensitive; @@ -354,6 +387,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. @@ -463,6 +509,18 @@ public EqlSearchRequestDescriptor WaitForCompletionTimeout(Elastic.Cl protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); + if (AllowPartialSearchResultsValue.HasValue) + { + writer.WritePropertyName("allow_partial_search_results"); + writer.WriteBooleanValue(AllowPartialSearchResultsValue.Value); + } + + if (AllowPartialSequenceResultsValue.HasValue) + { + writer.WritePropertyName("allow_partial_sequence_results"); + writer.WriteBooleanValue(AllowPartialSequenceResultsValue.Value); + } + if (CaseSensitiveValue.HasValue) { writer.WritePropertyName("case_sensitive"); @@ -551,6 +609,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) @@ -595,7 +659,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns results matching a query expressed in Event Query Language (EQL) +/// Get EQL search results. +/// Returns search results for an Event Query Language (EQL) query. +/// EQL assumes each document in a data stream or index corresponds to an event. /// /// public sealed partial class EqlSearchRequestDescriptor : RequestDescriptor @@ -624,6 +690,8 @@ public EqlSearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverle return Self; } + private bool? AllowPartialSearchResultsValue { get; set; } + private bool? AllowPartialSequenceResultsValue { get; set; } private bool? CaseSensitiveValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Field? EventCategoryFieldValue { get; set; } private int? FetchSizeValue { get; set; } @@ -637,6 +705,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; } @@ -645,6 +714,18 @@ public EqlSearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverle private Elastic.Clients.Elasticsearch.Serverless.Field? TimestampFieldValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeoutValue { get; set; } + public EqlSearchRequestDescriptor AllowPartialSearchResults(bool? allowPartialSearchResults = true) + { + AllowPartialSearchResultsValue = allowPartialSearchResults; + return Self; + } + + public EqlSearchRequestDescriptor AllowPartialSequenceResults(bool? allowPartialSequenceResults = true) + { + AllowPartialSequenceResultsValue = allowPartialSequenceResults; + return Self; + } + public EqlSearchRequestDescriptor CaseSensitive(bool? caseSensitive = true) { CaseSensitiveValue = caseSensitive; @@ -789,6 +870,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. @@ -898,6 +992,18 @@ public EqlSearchRequestDescriptor WaitForCompletionTimeout(Elastic.Clients.Elast protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); + if (AllowPartialSearchResultsValue.HasValue) + { + writer.WritePropertyName("allow_partial_search_results"); + writer.WriteBooleanValue(AllowPartialSearchResultsValue.Value); + } + + if (AllowPartialSequenceResultsValue.HasValue) + { + writer.WritePropertyName("allow_partial_sequence_results"); + writer.WriteBooleanValue(AllowPartialSequenceResultsValue.Value); + } + if (CaseSensitiveValue.HasValue) { writer.WritePropertyName("case_sensitive"); @@ -986,6 +1092,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/Eql/EqlSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchResponse.g.cs index 17919854cf6..c33426f84df 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/EqlSearchResponse.g.cs @@ -60,6 +60,14 @@ public sealed partial class EqlSearchResponse : ElasticsearchResponse [JsonInclude, JsonPropertyName("is_running")] public bool? IsRunning { get; init; } + /// + /// + /// Contains information about shard failures (if any), in case allow_partial_search_results=true + /// + /// + [JsonInclude, JsonPropertyName("shard_failures")] + public IReadOnlyCollection? ShardFailures { get; init; } + /// /// /// If true, the request timed out before completion. diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/GetEqlStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/GetEqlStatusRequest.g.cs index 4c8761fbd1c..495702bebde 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/GetEqlStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Eql/GetEqlStatusRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetEqlStatusRequestParameters : RequestParameters /// /// -/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// Get the async EQL status. +/// Get the current status for an async EQL search or a stored synchronous EQL search without returning results. /// /// public sealed partial class GetEqlStatusRequest : PlainRequest @@ -56,7 +57,8 @@ public GetEqlStatusRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : bas /// /// -/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// Get the async EQL status. +/// Get the current status for an async EQL search or a stored synchronous EQL search without returning results. /// /// public sealed partial class GetEqlStatusRequestDescriptor : RequestDescriptor, GetEqlStatusRequestParameters> @@ -88,7 +90,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// Get the async EQL status. +/// Get the current status for an async EQL search or a stored synchronous EQL search without returning results. /// /// public sealed partial class GetEqlStatusRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Esql/EsqlQueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Esql/EsqlQueryRequest.g.cs index 0d7346ea8b4..e5a692c6955 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Esql/EsqlQueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Esql/EsqlQueryRequest.g.cs @@ -57,7 +57,8 @@ public sealed partial class EsqlQueryRequestParameters : RequestParameters /// /// -/// Executes an ES|QL request +/// Run an ES|QL query. +/// Get search results for an ES|QL (Elasticsearch query language) query. /// /// public sealed partial class EsqlQueryRequest : PlainRequest @@ -143,7 +144,8 @@ public sealed partial class EsqlQueryRequest : PlainRequest /// -/// Executes an ES|QL request +/// Run an ES|QL query. +/// Get search results for an ES|QL (Elasticsearch query language) query. /// /// public sealed partial class EsqlQueryRequestDescriptor : RequestDescriptor, EsqlQueryRequestParameters> @@ -308,7 +310,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Executes an ES|QL request +/// Run an ES|QL query. +/// Get search results for an ES|QL (Elasticsearch query language) query. /// /// public sealed partial class EsqlQueryRequestDescriptor : RequestDescriptor 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 da4e00b2404..c947c938007 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/Graph/ExploreRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Graph/ExploreRequest.g.cs index 98a5e46eb17..56469ab3fe3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Graph/ExploreRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Graph/ExploreRequest.g.cs @@ -51,7 +51,12 @@ public sealed partial class ExploreRequestParameters : RequestParameters /// /// -/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// Explore graph analytics. +/// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. +/// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. +/// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. +/// Subsequent requests enable you to spider out from one more vertices of interest. +/// You can exclude vertices that have already been returned. /// /// public sealed partial class ExploreRequest : PlainRequest @@ -121,7 +126,12 @@ public ExploreRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indices) /// /// -/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// Explore graph analytics. +/// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. +/// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. +/// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. +/// Subsequent requests enable you to spider out from one more vertices of interest. +/// You can exclude vertices that have already been returned. /// /// public sealed partial class ExploreRequestDescriptor : RequestDescriptor, ExploreRequestParameters> @@ -383,7 +393,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// Explore graph analytics. +/// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. +/// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. +/// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. +/// Subsequent requests enable you to spider out from one more vertices of interest. +/// You can exclude vertices that have already been returned. /// /// public sealed partial class ExploreRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/HealthReportRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/HealthReportRequest.g.cs index 95f49997489..6f6a38f567a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/HealthReportRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/HealthReportRequest.g.cs @@ -56,7 +56,29 @@ public sealed partial class HealthReportRequestParameters : RequestParameters /// /// -/// Returns the health of the cluster. +/// Get the cluster health. +/// Get a report with the health status of an Elasticsearch cluster. +/// The report contains a list of indicators that compose Elasticsearch functionality. +/// +/// +/// Each indicator has a health status of: green, unknown, yellow or red. +/// The indicator will provide an explanation and metadata describing the reason for its current health status. +/// +/// +/// The cluster’s status is controlled by the worst indicator status. +/// +/// +/// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. +/// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. +/// +/// +/// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. +/// The root cause and remediation steps are encapsulated in a diagnosis. +/// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. +/// +/// +/// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. +/// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// public sealed partial class HealthReportRequest : PlainRequest @@ -104,7 +126,29 @@ public HealthReportRequest(IReadOnlyCollection? feature) : base(r => r.O /// /// -/// Returns the health of the cluster. +/// Get the cluster health. +/// Get a report with the health status of an Elasticsearch cluster. +/// The report contains a list of indicators that compose Elasticsearch functionality. +/// +/// +/// Each indicator has a health status of: green, unknown, yellow or red. +/// The indicator will provide an explanation and metadata describing the reason for its current health status. +/// +/// +/// The cluster’s status is controlled by the worst indicator status. +/// +/// +/// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. +/// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. +/// +/// +/// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. +/// The root cause and remediation steps are encapsulated in a diagnosis. +/// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. +/// +/// +/// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. +/// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// public sealed partial class HealthReportRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/AnalyzeIndexRequest.g.cs index 19c041d5f48..81d71987457 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/ClearCacheRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs index b775af01f88..80013f19d4e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs @@ -89,8 +89,9 @@ public sealed partial class ClearCacheRequestParameters : RequestParameters /// /// -/// Clears the caches of one or more indices. -/// For data streams, the API clears the caches of the stream’s backing indices. +/// Clear the cache. +/// Clear the cache of one or more indices. +/// For data streams, the API clears the caches of the stream's backing indices. /// /// public sealed partial class ClearCacheRequest : PlainRequest @@ -175,8 +176,9 @@ public ClearCacheRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indic /// /// -/// Clears the caches of one or more indices. -/// For data streams, the API clears the caches of the stream’s backing indices. +/// Clear the cache. +/// Clear the cache of one or more indices. +/// For data streams, the API clears the caches of the stream's backing indices. /// /// public sealed partial class ClearCacheRequestDescriptor : RequestDescriptor, ClearCacheRequestParameters> @@ -220,8 +222,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Clears the caches of one or more indices. -/// For data streams, the API clears the caches of the stream’s backing indices. +/// Clear the cache. +/// Clear the cache of one or more indices. +/// For data streams, the API clears the caches of the stream's backing indices. /// /// public sealed partial class ClearCacheRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs index fea6ec149ae..4f8c0fcc4d2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs @@ -84,7 +84,28 @@ public sealed partial class CloseIndexRequestParameters : RequestParameters /// /// -/// Closes an index. +/// Close an index. +/// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. +/// It is not possible to index documents or to search for documents in a closed index. +/// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. +/// +/// +/// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. +/// The shards will then go through the normal recovery process. +/// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. +/// +/// +/// You can open and close multiple indices. +/// An error is thrown if the request explicitly refers to a missing index. +/// This behaviour can be turned off using the ignore_unavailable=true parameter. +/// +/// +/// By default, you must explicitly name the indices you are opening or closing. +/// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. +/// +/// +/// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. +/// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// /// public sealed partial class CloseIndexRequest : PlainRequest @@ -159,7 +180,28 @@ public CloseIndexRequest(Elastic.Clients.Elasticsearch.Serverless.Indices indice /// /// -/// Closes an index. +/// Close an index. +/// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. +/// It is not possible to index documents or to search for documents in a closed index. +/// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. +/// +/// +/// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. +/// The shards will then go through the normal recovery process. +/// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. +/// +/// +/// You can open and close multiple indices. +/// An error is thrown if the request explicitly refers to a missing index. +/// This behaviour can be turned off using the ignore_unavailable=true parameter. +/// +/// +/// By default, you must explicitly name the indices you are opening or closing. +/// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. +/// +/// +/// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. +/// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// /// public sealed partial class CloseIndexRequestDescriptor : RequestDescriptor, CloseIndexRequestParameters> @@ -202,7 +244,28 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Closes an index. +/// Close an index. +/// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. +/// It is not possible to index documents or to search for documents in a closed index. +/// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. +/// +/// +/// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. +/// The shards will then go through the normal recovery process. +/// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. +/// +/// +/// You can open and close multiple indices. +/// An error is thrown if the request explicitly refers to a missing index. +/// This behaviour can be turned off using the ignore_unavailable=true parameter. +/// +/// +/// By default, you must explicitly name the indices you are opening or closing. +/// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. +/// +/// +/// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. +/// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// /// public sealed partial class CloseIndexRequestDescriptor : 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 9f27881dc8f..8eb2b3e9c0e 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 @@ -59,10 +59,11 @@ public sealed partial class ExistsAliasRequestParameters : RequestParameters /// /// - /// If true, the request retrieves information from the local node only. + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. /// /// - public bool? Local { get => Q("local"); set => Q("local", value); } + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// @@ -119,11 +120,12 @@ public ExistsAliasRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indi /// /// - /// If true, the request retrieves information from the local node only. + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. /// /// [JsonIgnore] - public bool? Local { get => Q("local"); set => Q("local", value); } + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// @@ -155,7 +157,7 @@ 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 MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public ExistsAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -203,7 +205,7 @@ 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 MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public ExistsAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs index 661999ee9f7..f6c50a64295 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs @@ -42,7 +42,8 @@ public sealed partial class ExistsIndexTemplateRequestParameters : RequestParame /// /// -/// Returns information about whether a particular index template exists. +/// Check index templates. +/// Check whether index templates exist. /// /// public sealed partial class ExistsIndexTemplateRequest : PlainRequest @@ -70,7 +71,8 @@ public ExistsIndexTemplateRequest(Elastic.Clients.Elasticsearch.Serverless.Name /// /// -/// Returns information about whether a particular index template exists. +/// Check index templates. +/// Check whether index templates exist. /// /// public sealed partial class ExistsIndexTemplateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs index e0b93bd6566..c9e18ea9330 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs @@ -50,7 +50,7 @@ public sealed partial class ExplainDataLifecycleRequestParameters : RequestParam /// /// /// Get the status for a data stream lifecycle. -/// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// public sealed partial class ExplainDataLifecycleRequest : PlainRequest @@ -87,7 +87,7 @@ public ExplainDataLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.Indi /// /// /// Get the status for a data stream lifecycle. -/// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// public sealed partial class ExplainDataLifecycleRequestDescriptor : RequestDescriptor, ExplainDataLifecycleRequestParameters> @@ -127,7 +127,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// /// Get the status for a data stream lifecycle. -/// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// public sealed partial class ExplainDataLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/FlushRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/FlushRequest.g.cs index 14a44b06337..7b5eebb2719 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/FlushRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/FlushRequest.g.cs @@ -75,7 +75,19 @@ public sealed partial class FlushRequestParameters : RequestParameters /// /// -/// Flushes one or more data streams or indices. +/// Flush data streams or indices. +/// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. +/// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. +/// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. +/// +/// +/// After each operation has been flushed it is permanently stored in the Lucene index. +/// This may mean that there is no need to maintain an additional copy of it in the transaction log. +/// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. +/// +/// +/// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. +/// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// /// public sealed partial class FlushRequest : PlainRequest @@ -144,7 +156,19 @@ public FlushRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) : /// /// -/// Flushes one or more data streams or indices. +/// Flush data streams or indices. +/// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. +/// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. +/// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. +/// +/// +/// After each operation has been flushed it is permanently stored in the Lucene index. +/// This may mean that there is no need to maintain an additional copy of it in the transaction log. +/// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. +/// +/// +/// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. +/// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// /// public sealed partial class FlushRequestDescriptor : RequestDescriptor, FlushRequestParameters> @@ -186,7 +210,19 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Flushes one or more data streams or indices. +/// Flush data streams or indices. +/// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. +/// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. +/// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. +/// +/// +/// After each operation has been flushed it is permanently stored in the Lucene index. +/// This may mean that there is no need to maintain an additional copy of it in the transaction log. +/// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. +/// +/// +/// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. +/// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// /// public sealed partial class FlushRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs index 4a1a1515bfa..059b8f1fe40 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs @@ -84,7 +84,21 @@ public sealed partial class ForcemergeRequestParameters : RequestParameters /// /// -/// Performs the force merge operation on one or more indices. +/// Force a merge. +/// Perform the force merge operation on the shards of one or more indices. +/// For data streams, the API forces a merge on the shards of the stream's backing indices. +/// +/// +/// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. +/// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. +/// +/// +/// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). +/// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". +/// These soft-deleted documents are automatically cleaned up during regular segment merges. +/// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. +/// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. +/// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// public sealed partial class ForcemergeRequest : PlainRequest @@ -164,7 +178,21 @@ public ForcemergeRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indic /// /// -/// Performs the force merge operation on one or more indices. +/// Force a merge. +/// Perform the force merge operation on the shards of one or more indices. +/// For data streams, the API forces a merge on the shards of the stream's backing indices. +/// +/// +/// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. +/// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. +/// +/// +/// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). +/// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". +/// These soft-deleted documents are automatically cleaned up during regular segment merges. +/// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. +/// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. +/// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// public sealed partial class ForcemergeRequestDescriptor : RequestDescriptor, ForcemergeRequestParameters> @@ -208,7 +236,21 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Performs the force merge operation on one or more indices. +/// Force a merge. +/// Perform the force merge operation on the shards of one or more indices. +/// For data streams, the API forces a merge on the shards of the stream's backing indices. +/// +/// +/// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. +/// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. +/// +/// +/// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). +/// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". +/// These soft-deleted documents are automatically cleaned up during regular segment merges. +/// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. +/// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. +/// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// public sealed partial class ForcemergeRequestDescriptor : RequestDescriptor 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 53820d6bb2a..3c367b7acb3 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 @@ -59,10 +59,11 @@ public sealed partial class GetAliasRequestParameters : RequestParameters /// /// - /// If true, the request retrieves information from the local node only. + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. /// /// - public bool? Local { get => Q("local"); set => Q("local", value); } + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// @@ -127,11 +128,12 @@ public GetAliasRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices /// /// - /// If true, the request retrieves information from the local node only. + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. /// /// [JsonIgnore] - public bool? Local { get => Q("local"); set => Q("local", value); } + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// @@ -163,7 +165,7 @@ 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 MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public GetAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { @@ -211,7 +213,7 @@ 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 MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public GetAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Serverless.Indices? indices) { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs index accee52904d..99464aa8b9a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs @@ -100,8 +100,20 @@ public sealed partial class IndicesStatsRequestParameters : RequestParameters /// /// -/// Returns statistics for one or more indices. -/// For data streams, the API retrieves statistics for the stream’s backing indices. +/// Get index statistics. +/// For data streams, the API retrieves statistics for the stream's backing indices. +/// +/// +/// By default, the returned statistics are index-level with primaries and total aggregations. +/// primaries are the values for only the primary shards. +/// total are the accumulated values for both primary and replica shards. +/// +/// +/// To get shard-level statistics, set the level parameter to shards. +/// +/// +/// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. +/// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// public sealed partial class IndicesStatsRequest : PlainRequest @@ -207,8 +219,20 @@ public IndicesStatsRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? ind /// /// -/// Returns statistics for one or more indices. -/// For data streams, the API retrieves statistics for the stream’s backing indices. +/// Get index statistics. +/// For data streams, the API retrieves statistics for the stream's backing indices. +/// +/// +/// By default, the returned statistics are index-level with primaries and total aggregations. +/// primaries are the values for only the primary shards. +/// total are the accumulated values for both primary and replica shards. +/// +/// +/// To get shard-level statistics, set the level parameter to shards. +/// +/// +/// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. +/// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// public sealed partial class IndicesStatsRequestDescriptor : RequestDescriptor, IndicesStatsRequestParameters> @@ -260,8 +284,20 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns statistics for one or more indices. -/// For data streams, the API retrieves statistics for the stream’s backing indices. +/// Get index statistics. +/// For data streams, the API retrieves statistics for the stream's backing indices. +/// +/// +/// By default, the returned statistics are index-level with primaries and total aggregations. +/// primaries are the values for only the primary shards. +/// total are the accumulated values for both primary and replica shards. +/// +/// +/// To get shard-level statistics, set the level parameter to shards. +/// +/// +/// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. +/// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// public sealed partial class IndicesStatsRequestDescriptor : RequestDescriptor 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 3c979b58a57..39f545869db 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/RecoveryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RecoveryRequest.g.cs index e1995519ba4..cfd93778ad2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RecoveryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/RecoveryRequest.g.cs @@ -49,8 +49,56 @@ public sealed partial class RecoveryRequestParameters : RequestParameters /// /// -/// Returns information about ongoing and completed shard recoveries for one or more indices. -/// For data streams, the API returns information for the stream’s backing indices. +/// Get index recovery information. +/// Get information about ongoing and completed shard recoveries for one or more indices. +/// For data streams, the API returns information for the stream's backing indices. +/// +/// +/// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. +/// When a shard recovery completes, the recovered shard is available for search and indexing. +/// +/// +/// Recovery automatically occurs during the following processes: +/// +/// +/// +/// +/// When creating an index for the first time. +/// +/// +/// +/// +/// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. +/// +/// +/// +/// +/// Creation of new replica shard copies from the primary. +/// +/// +/// +/// +/// Relocation of a shard copy to a different node in the same cluster. +/// +/// +/// +/// +/// A snapshot restore operation. +/// +/// +/// +/// +/// A clone, shrink, or split operation. +/// +/// +/// +/// +/// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. +/// +/// +/// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. +/// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. +/// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// public sealed partial class RecoveryRequest : PlainRequest @@ -90,8 +138,56 @@ public RecoveryRequest(Elastic.Clients.Elasticsearch.Serverless.Indices? indices /// /// -/// Returns information about ongoing and completed shard recoveries for one or more indices. -/// For data streams, the API returns information for the stream’s backing indices. +/// Get index recovery information. +/// Get information about ongoing and completed shard recoveries for one or more indices. +/// For data streams, the API returns information for the stream's backing indices. +/// +/// +/// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. +/// When a shard recovery completes, the recovered shard is available for search and indexing. +/// +/// +/// Recovery automatically occurs during the following processes: +/// +/// +/// +/// +/// When creating an index for the first time. +/// +/// +/// +/// +/// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. +/// +/// +/// +/// +/// Creation of new replica shard copies from the primary. +/// +/// +/// +/// +/// Relocation of a shard copy to a different node in the same cluster. +/// +/// +/// +/// +/// A snapshot restore operation. +/// +/// +/// +/// +/// A clone, shrink, or split operation. +/// +/// +/// +/// +/// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. +/// +/// +/// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. +/// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. +/// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// public sealed partial class RecoveryRequestDescriptor : RequestDescriptor, RecoveryRequestParameters> @@ -130,8 +226,56 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns information about ongoing and completed shard recoveries for one or more indices. -/// For data streams, the API returns information for the stream’s backing indices. +/// Get index recovery information. +/// Get information about ongoing and completed shard recoveries for one or more indices. +/// For data streams, the API returns information for the stream's backing indices. +/// +/// +/// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. +/// When a shard recovery completes, the recovered shard is available for search and indexing. +/// +/// +/// Recovery automatically occurs during the following processes: +/// +/// +/// +/// +/// When creating an index for the first time. +/// +/// +/// +/// +/// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. +/// +/// +/// +/// +/// Creation of new replica shard copies from the primary. +/// +/// +/// +/// +/// Relocation of a shard copy to a different node in the same cluster. +/// +/// +/// +/// +/// A snapshot restore operation. +/// +/// +/// +/// +/// A clone, shrink, or split operation. +/// +/// +/// +/// +/// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. +/// +/// +/// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. +/// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. +/// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// public sealed partial class RecoveryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs index 93fefd387c2..eeb834c823a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs @@ -61,7 +61,8 @@ public sealed partial class ResolveIndexRequestParameters : RequestParameters /// /// -/// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. +/// Resolve indices. +/// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// @@ -111,7 +112,8 @@ public ResolveIndexRequest(Elastic.Clients.Elasticsearch.Serverless.Names name) /// /// -/// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. +/// Resolve indices. +/// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// 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 0960e65ef67..7df19f21d9d 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,19 +56,13 @@ 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); } } /// /// -/// Returns low-level information about the Lucene segments in index shards. -/// For data streams, the API returns information about the stream’s backing indices. +/// Get index segments. +/// Get low-level information about the Lucene segments in index shards. +/// For data streams, the API returns information about the stream's backing indices. /// /// public sealed partial class SegmentsRequest : PlainRequest @@ -116,20 +110,13 @@ 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); } } /// /// -/// Returns low-level information about the Lucene segments in index shards. -/// For data streams, the API returns information about the stream’s backing indices. +/// Get index segments. +/// Get low-level information about the Lucene segments in index shards. +/// For data streams, the API returns information about the stream's backing indices. /// /// public sealed partial class SegmentsRequestDescriptor : RequestDescriptor, SegmentsRequestParameters> @@ -155,7 +142,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) { @@ -170,8 +156,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns low-level information about the Lucene segments in index shards. -/// For data streams, the API returns information about the stream’s backing indices. +/// Get index segments. +/// Get low-level information about the Lucene segments in index shards. +/// For data streams, the API returns information about the stream's backing indices. /// /// public sealed partial class SegmentsRequestDescriptor : RequestDescriptor @@ -197,7 +184,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 00000000000..b2db5f61ffa --- /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 00000000000..87912c59bf7 --- /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 00000000000..f18bb03711f --- /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 00000000000..eadcef93ac5 --- /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 00000000000..6e94c6b33af --- /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 00000000000..0e2891aecf9 --- /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 00000000000..eadac2de1ea --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Inference/PutInferenceRequest.g.cs @@ -0,0 +1,152 @@ +// 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. +/// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. +/// After creating the endpoint, wait for the model deployment to complete before using it. +/// To verify the deployment status, use the get trained model statistics API. +/// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". +/// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. +/// +/// +/// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. +/// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. +/// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. +/// +/// +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. +/// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. +/// After creating the endpoint, wait for the model deployment to complete before using it. +/// To verify the deployment status, use the get trained model statistics API. +/// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". +/// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. +/// +/// +/// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. +/// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. +/// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. +/// +/// +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 00000000000..88c831242f4 --- /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/Ingest/DeleteGeoipDatabaseRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeleteGeoipDatabaseRequest.g.cs index 4f5534ed14b..6825d0efc96 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeleteGeoipDatabaseRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeleteGeoipDatabaseRequest.g.cs @@ -50,7 +50,8 @@ public sealed partial class DeleteGeoipDatabaseRequestParameters : RequestParame /// /// -/// Deletes a geoip database configuration. +/// Delete GeoIP database configurations. +/// Delete one or more IP geolocation database configurations. /// /// public sealed partial class DeleteGeoipDatabaseRequest : PlainRequest @@ -87,7 +88,8 @@ public DeleteGeoipDatabaseRequest(Elastic.Clients.Elasticsearch.Serverless.Ids i /// /// -/// Deletes a geoip database configuration. +/// Delete GeoIP database configurations. +/// Delete one or more IP geolocation database configurations. /// /// public sealed partial class DeleteGeoipDatabaseRequestDescriptor : RequestDescriptor, DeleteGeoipDatabaseRequestParameters> @@ -122,7 +124,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes a geoip database configuration. +/// Delete GeoIP database configurations. +/// Delete one or more IP geolocation database configurations. /// /// public sealed partial class DeleteGeoipDatabaseRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeleteIpLocationDatabaseRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeleteIpLocationDatabaseRequest.g.cs new file mode 100644 index 00000000000..4ef93c572ac --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeleteIpLocationDatabaseRequest.g.cs @@ -0,0 +1,162 @@ +// 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.Ingest; + +public sealed partial class DeleteIpLocationDatabaseRequestParameters : RequestParameters +{ + /// + /// + /// The period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// The period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } +} + +/// +/// +/// Delete IP geolocation database configurations. +/// +/// +public sealed partial class DeleteIpLocationDatabaseRequest : PlainRequest +{ + public DeleteIpLocationDatabaseRequest(Elastic.Clients.Elasticsearch.Serverless.Ids id) : base(r => r.Required("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestDeleteIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE; + + internal override bool SupportsBody => false; + + internal override string OperationName => "ingest.delete_ip_location_database"; + + /// + /// + /// The period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// The period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } +} + +/// +/// +/// Delete IP geolocation database configurations. +/// +/// +public sealed partial class DeleteIpLocationDatabaseRequestDescriptor : RequestDescriptor, DeleteIpLocationDatabaseRequestParameters> +{ + internal DeleteIpLocationDatabaseRequestDescriptor(Action> configure) => configure.Invoke(this); + + public DeleteIpLocationDatabaseRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Ids id) : base(r => r.Required("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestDeleteIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE; + + internal override bool SupportsBody => false; + + internal override string OperationName => "ingest.delete_ip_location_database"; + + public DeleteIpLocationDatabaseRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public DeleteIpLocationDatabaseRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) => Qs("timeout", timeout); + + public DeleteIpLocationDatabaseRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Ids id) + { + RouteValues.Required("id", id); + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + } +} + +/// +/// +/// Delete IP geolocation database configurations. +/// +/// +public sealed partial class DeleteIpLocationDatabaseRequestDescriptor : RequestDescriptor +{ + internal DeleteIpLocationDatabaseRequestDescriptor(Action configure) => configure.Invoke(this); + + public DeleteIpLocationDatabaseRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Ids id) : base(r => r.Required("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestDeleteIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE; + + internal override bool SupportsBody => false; + + internal override string OperationName => "ingest.delete_ip_location_database"; + + public DeleteIpLocationDatabaseRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public DeleteIpLocationDatabaseRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) => Qs("timeout", timeout); + + public DeleteIpLocationDatabaseRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Ids id) + { + RouteValues.Required("id", id); + 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/Ingest/DeleteIpLocationDatabaseResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeleteIpLocationDatabaseResponse.g.cs new file mode 100644 index 00000000000..faadfbc99b4 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeleteIpLocationDatabaseResponse.g.cs @@ -0,0 +1,38 @@ +// 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.Ingest; + +public sealed partial class DeleteIpLocationDatabaseResponse : ElasticsearchResponse +{ + /// + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// + [JsonInclude, JsonPropertyName("acknowledged")] + public bool Acknowledged { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeletePipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeletePipelineRequest.g.cs index 8f5ab4ef007..7ca30807a48 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeletePipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/DeletePipelineRequest.g.cs @@ -51,7 +51,8 @@ public sealed partial class DeletePipelineRequestParameters : RequestParameters /// /// -/// Deletes one or more existing ingest pipeline. +/// Delete pipelines. +/// Delete one or more ingest pipelines. /// /// public sealed partial class DeletePipelineRequest : PlainRequest @@ -89,7 +90,8 @@ public DeletePipelineRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : b /// /// -/// Deletes one or more existing ingest pipeline. +/// Delete pipelines. +/// Delete one or more ingest pipelines. /// /// public sealed partial class DeletePipelineRequestDescriptor : RequestDescriptor, DeletePipelineRequestParameters> @@ -124,7 +126,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes one or more existing ingest pipeline. +/// Delete pipelines. +/// Delete one or more ingest pipelines. /// /// public sealed partial class DeletePipelineRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs index e8c2ad23910..6c5d918bd4c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GeoIpStatsRequestParameters : RequestParameters /// /// -/// Gets download statistics for GeoIP2 databases used with the geoip processor. +/// Get GeoIP statistics. +/// Get download statistics for GeoIP2 databases that are used with the GeoIP processor. /// /// public sealed partial class GeoIpStatsRequest : PlainRequest @@ -52,7 +53,8 @@ public sealed partial class GeoIpStatsRequest : PlainRequest /// -/// Gets download statistics for GeoIP2 databases used with the geoip processor. +/// Get GeoIP statistics. +/// Get download statistics for GeoIP2 databases that are used with the GeoIP processor. /// /// public sealed partial class GeoIpStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetGeoipDatabaseRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetGeoipDatabaseRequest.g.cs index fad567b53e1..86dbc98c407 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetGeoipDatabaseRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetGeoipDatabaseRequest.g.cs @@ -43,7 +43,8 @@ public sealed partial class GetGeoipDatabaseRequestParameters : RequestParameter /// /// -/// Returns information about one or more geoip database configurations. +/// Get GeoIP database configurations. +/// Get information about one or more IP geolocation database configurations. /// /// public sealed partial class GetGeoipDatabaseRequest : PlainRequest @@ -76,7 +77,8 @@ public GetGeoipDatabaseRequest(Elastic.Clients.Elasticsearch.Serverless.Ids? id) /// /// -/// Returns information about one or more geoip database configurations. +/// Get GeoIP database configurations. +/// Get information about one or more IP geolocation database configurations. /// /// public sealed partial class GetGeoipDatabaseRequestDescriptor : RequestDescriptor, GetGeoipDatabaseRequestParameters> @@ -114,7 +116,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns information about one or more geoip database configurations. +/// Get GeoIP database configurations. +/// Get information about one or more IP geolocation database configurations. /// /// public sealed partial class GetGeoipDatabaseRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetIpLocationDatabaseRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetIpLocationDatabaseRequest.g.cs new file mode 100644 index 00000000000..587dfb864e4 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetIpLocationDatabaseRequest.g.cs @@ -0,0 +1,153 @@ +// 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.Ingest; + +public sealed partial class GetIpLocationDatabaseRequestParameters : RequestParameters +{ + /// + /// + /// The period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } +} + +/// +/// +/// Get IP geolocation database configurations. +/// +/// +public sealed partial class GetIpLocationDatabaseRequest : PlainRequest +{ + public GetIpLocationDatabaseRequest() + { + } + + public GetIpLocationDatabaseRequest(Elastic.Clients.Elasticsearch.Serverless.Ids? id) : base(r => r.Optional("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestGetIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.GET; + + internal override bool SupportsBody => false; + + internal override string OperationName => "ingest.get_ip_location_database"; + + /// + /// + /// The period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } +} + +/// +/// +/// Get IP geolocation database configurations. +/// +/// +public sealed partial class GetIpLocationDatabaseRequestDescriptor : RequestDescriptor, GetIpLocationDatabaseRequestParameters> +{ + internal GetIpLocationDatabaseRequestDescriptor(Action> configure) => configure.Invoke(this); + + public GetIpLocationDatabaseRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Ids? id) : base(r => r.Optional("id", id)) + { + } + + public GetIpLocationDatabaseRequestDescriptor() + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestGetIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.GET; + + internal override bool SupportsBody => false; + + internal override string OperationName => "ingest.get_ip_location_database"; + + public GetIpLocationDatabaseRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + + public GetIpLocationDatabaseRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Ids? id) + { + RouteValues.Optional("id", id); + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + } +} + +/// +/// +/// Get IP geolocation database configurations. +/// +/// +public sealed partial class GetIpLocationDatabaseRequestDescriptor : RequestDescriptor +{ + internal GetIpLocationDatabaseRequestDescriptor(Action configure) => configure.Invoke(this); + + public GetIpLocationDatabaseRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Ids? id) : base(r => r.Optional("id", id)) + { + } + + public GetIpLocationDatabaseRequestDescriptor() + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestGetIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.GET; + + internal override bool SupportsBody => false; + + internal override string OperationName => "ingest.get_ip_location_database"; + + public GetIpLocationDatabaseRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + + public GetIpLocationDatabaseRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Ids? id) + { + RouteValues.Optional("id", id); + 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/Ingest/GetIpLocationDatabaseResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetIpLocationDatabaseResponse.g.cs new file mode 100644 index 00000000000..3413683d5e0 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetIpLocationDatabaseResponse.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.Ingest; + +public sealed partial class GetIpLocationDatabaseResponse : ElasticsearchResponse +{ + [JsonInclude, JsonPropertyName("databases")] + public IReadOnlyCollection Databases { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetPipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetPipelineRequest.g.cs index 6c0946d0c25..b7c807774e5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetPipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/GetPipelineRequest.g.cs @@ -50,7 +50,8 @@ public sealed partial class GetPipelineRequestParameters : RequestParameters /// /// -/// Returns information about one or more ingest pipelines. +/// Get pipelines. +/// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// @@ -92,7 +93,8 @@ public GetPipelineRequest(Elastic.Clients.Elasticsearch.Serverless.Id? id) : bas /// /// -/// Returns information about one or more ingest pipelines. +/// Get pipelines. +/// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// @@ -132,7 +134,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns information about one or more ingest pipelines. +/// Get pipelines. +/// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs index d215d173bb3..6478185d553 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs @@ -36,8 +36,9 @@ public sealed partial class ProcessorGrokRequestParameters : RequestParameters /// /// -/// Extracts structured fields out of a single text field within a document. -/// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. +/// Run a grok processor. +/// Extract structured fields out of a single text field within a document. +/// You must 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. /// /// @@ -54,8 +55,9 @@ public sealed partial class ProcessorGrokRequest : PlainRequest /// -/// Extracts structured fields out of a single text field within a document. -/// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. +/// Run a grok processor. +/// Extract structured fields out of a single text field within a document. +/// You must 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. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutGeoipDatabaseRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutGeoipDatabaseRequest.g.cs index 786cdeb77e0..ebb0017a9bd 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutGeoipDatabaseRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutGeoipDatabaseRequest.g.cs @@ -50,7 +50,8 @@ public sealed partial class PutGeoipDatabaseRequestParameters : RequestParameter /// /// -/// Returns information about one or more geoip database configurations. +/// Create or update a GeoIP database configuration. +/// Refer to the create or update IP geolocation database configuration API. /// /// public sealed partial class PutGeoipDatabaseRequest : PlainRequest @@ -104,7 +105,8 @@ public PutGeoipDatabaseRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : /// /// -/// Returns information about one or more geoip database configurations. +/// Create or update a GeoIP database configuration. +/// Refer to the create or update IP geolocation database configuration API. /// /// public sealed partial class PutGeoipDatabaseRequestDescriptor : RequestDescriptor, PutGeoipDatabaseRequestParameters> @@ -205,7 +207,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns information about one or more geoip database configurations. +/// Create or update a GeoIP database configuration. +/// Refer to the create or update IP geolocation database configuration API. /// /// public sealed partial class PutGeoipDatabaseRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutIpLocationDatabaseRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutIpLocationDatabaseRequest.g.cs new file mode 100644 index 00000000000..8f337335f24 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutIpLocationDatabaseRequest.g.cs @@ -0,0 +1,221 @@ +// 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.Ingest; + +public sealed partial class PutIpLocationDatabaseRequestParameters : RequestParameters +{ + /// + /// + /// The period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. + /// If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. + /// A value of -1 indicates that the request should never time out. + /// + /// + public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } +} + +/// +/// +/// Create or update an IP geolocation database configuration. +/// +/// +public sealed partial class PutIpLocationDatabaseRequest : PlainRequest, ISelfSerializable +{ + public PutIpLocationDatabaseRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base(r => r.Required("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestPutIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; + + internal override bool SupportsBody => true; + + internal override string OperationName => "ingest.put_ip_location_database"; + + /// + /// + /// The period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. + /// If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. + /// A value of -1 indicates that the request should never time out. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration Configuration { get; set; } + + void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + JsonSerializer.Serialize(writer, Configuration, options); + } +} + +/// +/// +/// Create or update an IP geolocation database configuration. +/// +/// +public sealed partial class PutIpLocationDatabaseRequestDescriptor : RequestDescriptor, PutIpLocationDatabaseRequestParameters> +{ + internal PutIpLocationDatabaseRequestDescriptor(Action> configure) => configure.Invoke(this); + public PutIpLocationDatabaseRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Serverless.Id id) : base(r => r.Required("id", id)) => ConfigurationValue = configuration; + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestPutIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; + + internal override bool SupportsBody => true; + + internal override string OperationName => "ingest.put_ip_location_database"; + + public PutIpLocationDatabaseRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public PutIpLocationDatabaseRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) => Qs("timeout", timeout); + + public PutIpLocationDatabaseRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) + { + RouteValues.Required("id", id); + return Self; + } + + private Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration ConfigurationValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfigurationDescriptor ConfigurationDescriptor { get; set; } + private Action ConfigurationDescriptorAction { get; set; } + + public PutIpLocationDatabaseRequestDescriptor Configuration(Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration configuration) + { + ConfigurationDescriptor = null; + ConfigurationDescriptorAction = null; + ConfigurationValue = configuration; + return Self; + } + + public PutIpLocationDatabaseRequestDescriptor Configuration(Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfigurationDescriptor descriptor) + { + ConfigurationValue = null; + ConfigurationDescriptorAction = null; + ConfigurationDescriptor = descriptor; + return Self; + } + + public PutIpLocationDatabaseRequestDescriptor Configuration(Action configure) + { + ConfigurationValue = null; + ConfigurationDescriptor = null; + ConfigurationDescriptorAction = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + JsonSerializer.Serialize(writer, ConfigurationValue, options); + } +} + +/// +/// +/// Create or update an IP geolocation database configuration. +/// +/// +public sealed partial class PutIpLocationDatabaseRequestDescriptor : RequestDescriptor +{ + internal PutIpLocationDatabaseRequestDescriptor(Action configure) => configure.Invoke(this); + public PutIpLocationDatabaseRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Serverless.Id id) : base(r => r.Required("id", id)) => ConfigurationValue = configuration; + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestPutIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; + + internal override bool SupportsBody => true; + + internal override string OperationName => "ingest.put_ip_location_database"; + + public PutIpLocationDatabaseRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Serverless.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public PutIpLocationDatabaseRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Serverless.Duration? timeout) => Qs("timeout", timeout); + + public PutIpLocationDatabaseRequestDescriptor Id(Elastic.Clients.Elasticsearch.Serverless.Id id) + { + RouteValues.Required("id", id); + return Self; + } + + private Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration ConfigurationValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfigurationDescriptor ConfigurationDescriptor { get; set; } + private Action ConfigurationDescriptorAction { get; set; } + + public PutIpLocationDatabaseRequestDescriptor Configuration(Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration configuration) + { + ConfigurationDescriptor = null; + ConfigurationDescriptorAction = null; + ConfigurationValue = configuration; + return Self; + } + + public PutIpLocationDatabaseRequestDescriptor Configuration(Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfigurationDescriptor descriptor) + { + ConfigurationValue = null; + ConfigurationDescriptorAction = null; + ConfigurationDescriptor = descriptor; + return Self; + } + + public PutIpLocationDatabaseRequestDescriptor Configuration(Action configure) + { + ConfigurationValue = null; + ConfigurationDescriptor = null; + ConfigurationDescriptorAction = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + JsonSerializer.Serialize(writer, ConfigurationValue, options); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutIpLocationDatabaseResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutIpLocationDatabaseResponse.g.cs new file mode 100644 index 00000000000..3f5f8d048f0 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutIpLocationDatabaseResponse.g.cs @@ -0,0 +1,38 @@ +// 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.Ingest; + +public sealed partial class PutIpLocationDatabaseResponse : ElasticsearchResponse +{ + /// + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// + [JsonInclude, JsonPropertyName("acknowledged")] + public bool Acknowledged { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutPipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutPipelineRequest.g.cs index fd417ebf29c..74a90e43160 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutPipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/PutPipelineRequest.g.cs @@ -56,7 +56,7 @@ public sealed partial class PutPipelineRequestParameters : RequestParameters /// /// -/// Creates or updates an ingest pipeline. +/// Create or update a pipeline. /// Changes made using this API take effect immediately. /// /// @@ -150,7 +150,7 @@ public PutPipelineRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base /// /// -/// Creates or updates an ingest pipeline. +/// Create or update a pipeline. /// Changes made using this API take effect immediately. /// /// @@ -415,7 +415,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Creates or updates an ingest pipeline. +/// Create or update a pipeline. /// Changes made using this API take effect immediately. /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/SimulateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/SimulateRequest.g.cs index 7d516a05062..75bbaf50ecf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/SimulateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Ingest/SimulateRequest.g.cs @@ -42,7 +42,9 @@ public sealed partial class SimulateRequestParameters : RequestParameters /// /// -/// Executes an ingest pipeline against a set of provided documents. +/// Simulate a pipeline. +/// Run an ingest pipeline against a set of provided documents. +/// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// public sealed partial class SimulateRequest : PlainRequest @@ -92,7 +94,9 @@ public SimulateRequest(Elastic.Clients.Elasticsearch.Serverless.Id? id) : base(r /// /// -/// Executes an ingest pipeline against a set of provided documents. +/// Simulate a pipeline. +/// Run an ingest pipeline against a set of provided documents. +/// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// public sealed partial class SimulateRequestDescriptor : RequestDescriptor, SimulateRequestParameters> @@ -259,7 +263,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Executes an ingest pipeline against a set of provided documents. +/// Simulate a pipeline. +/// Run an ingest pipeline against a set of provided documents. +/// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// public sealed partial class SimulateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs index 772b0aac731..0447d435a07 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs @@ -43,8 +43,11 @@ public sealed partial class GetLicenseRequestParameters : RequestParameters /// /// /// Get license information. -/// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. -/// For more information about the different types of licenses, refer to Elastic Stack subscriptions. +/// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. +/// +/// +/// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. +/// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// public sealed partial class GetLicenseRequest : PlainRequest @@ -69,8 +72,11 @@ public sealed partial class GetLicenseRequest : PlainRequest /// /// Get license information. -/// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. -/// For more information about the different types of licenses, refer to Elastic Stack subscriptions. +/// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. +/// +/// +/// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. +/// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// public sealed partial class GetLicenseRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/MlInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/MlInfoRequest.g.cs index eaed39dd0d7..7d93065f664 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/MlInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/MlInfoRequest.g.cs @@ -36,8 +36,8 @@ public sealed partial class MlInfoRequestParameters : RequestParameters /// /// -/// Return ML defaults and limits. -/// Returns defaults and limits used by machine learning. +/// Get machine learning information. +/// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -59,8 +59,8 @@ public sealed partial class MlInfoRequest : PlainRequest /// -/// Return ML defaults and limits. -/// Returns defaults and limits used by machine learning. +/// Get machine learning information. +/// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs index 8f5e1b2b473..24199785d0d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs @@ -143,6 +143,8 @@ public PutDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Serverless.Id /// [JsonInclude, JsonPropertyName("max_num_threads")] public int? MaxNumThreads { get; set; } + [JsonInclude, JsonPropertyName("_meta")] + public IDictionary? Meta { get; set; } /// /// @@ -209,6 +211,7 @@ public PutDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elas private Action> DestDescriptorAction { get; set; } private IDictionary>>? HeadersValue { get; set; } private int? MaxNumThreadsValue { get; set; } + private IDictionary? MetaValue { get; set; } private string? ModelMemoryLimitValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsSource SourceValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsSourceDescriptor SourceDescriptor { get; set; } @@ -380,6 +383,12 @@ public PutDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxN return Self; } + public PutDataFrameAnalyticsRequestDescriptor Meta(Func, FluentDictionary> selector) + { + MetaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + /// /// /// The approximate maximum amount of memory resources that are permitted for @@ -505,6 +514,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(MaxNumThreadsValue.Value); } + if (MetaValue is not null) + { + writer.WritePropertyName("_meta"); + JsonSerializer.Serialize(writer, MetaValue, options); + } + if (!string.IsNullOrEmpty(ModelMemoryLimitValue)) { writer.WritePropertyName("model_memory_limit"); @@ -579,6 +594,7 @@ public PutDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elasticsearch.S private Action DestDescriptorAction { get; set; } private IDictionary>>? HeadersValue { get; set; } private int? MaxNumThreadsValue { get; set; } + private IDictionary? MetaValue { get; set; } private string? ModelMemoryLimitValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsSource SourceValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DataframeAnalyticsSourceDescriptor SourceDescriptor { get; set; } @@ -750,6 +766,12 @@ public PutDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) return Self; } + public PutDataFrameAnalyticsRequestDescriptor Meta(Func, FluentDictionary> selector) + { + MetaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + /// /// /// The approximate maximum amount of memory resources that are permitted for @@ -875,6 +897,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(MaxNumThreadsValue.Value); } + if (MetaValue is not null) + { + writer.WritePropertyName("_meta"); + JsonSerializer.Serialize(writer, MetaValue, options); + } + if (!string.IsNullOrEmpty(ModelMemoryLimitValue)) { writer.WritePropertyName("model_memory_limit"); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDataFrameAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDataFrameAnalyticsResponse.g.cs index 85881875396..60f90198ccf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDataFrameAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDataFrameAnalyticsResponse.g.cs @@ -46,6 +46,8 @@ public sealed partial class PutDataFrameAnalyticsResponse : ElasticsearchRespons public string Id { get; init; } [JsonInclude, JsonPropertyName("max_num_threads")] public int MaxNumThreads { get; init; } + [JsonInclude, JsonPropertyName("_meta")] + public IReadOnlyDictionary? Meta { get; init; } [JsonInclude, JsonPropertyName("model_memory_limit")] public string ModelMemoryLimit { get; init; } [JsonInclude, JsonPropertyName("source")] diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs index 21cd468437c..b014e0cd7d3 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 @@ -68,7 +68,7 @@ public override PutDatafeedRequest Read(ref Utf8JsonReader reader, Type typeToCo if (reader.TokenType == JsonTokenType.PropertyName) { var property = reader.GetString(); - if (property == "aggregations") + if (property == "aggregations" || property == "aggs") { variant.Aggregations = JsonSerializer.Deserialize?>(ref reader, options); continue; @@ -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/MachineLearning/PutJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutJobRequest.g.cs index a328a9024b6..c507002aedb 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutJobRequest.g.cs @@ -32,6 +32,55 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class PutJobRequestParameters : RequestParameters { + /// + /// + /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the + /// _all string or when no indices are specified. + /// + /// + public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } + + /// + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + /// whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: + /// + /// + /// + /// + /// all: Match any data stream or index, including hidden ones. + /// + /// + /// + /// + /// closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + /// + /// + /// + /// + /// hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. + /// + /// + /// + /// + /// none: Wildcard patterns are not accepted. + /// + /// + /// + /// + /// open: Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// + /// + /// + public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } + + /// + /// + /// If true, unavailable indices (missing or closed) are ignored. + /// + /// + public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// @@ -54,6 +103,59 @@ public PutJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : base(r internal override string OperationName => "ml.put_job"; + /// + /// + /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the + /// _all string or when no indices are specified. + /// + /// + [JsonIgnore] + public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } + + /// + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + /// whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: + /// + /// + /// + /// + /// all: Match any data stream or index, including hidden ones. + /// + /// + /// + /// + /// closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + /// + /// + /// + /// + /// hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. + /// + /// + /// + /// + /// none: Wildcard patterns are not accepted. + /// + /// + /// + /// + /// open: Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// + /// + /// + [JsonIgnore] + public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } + + /// + /// + /// If true, unavailable indices (missing or closed) are ignored. + /// + /// + [JsonIgnore] + public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } + /// /// /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. @@ -134,6 +236,14 @@ public PutJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : base(r [JsonInclude, JsonPropertyName("groups")] public ICollection? Groups { get; set; } + /// + /// + /// The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. + /// + /// + [JsonInclude, JsonPropertyName("job_id")] + public Elastic.Clients.Elasticsearch.Serverless.Id? JobId { get; set; } + /// /// /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. @@ -185,10 +295,6 @@ public sealed partial class PutJobRequestDescriptor : RequestDescript { internal PutJobRequestDescriptor(Action> configure) => configure.Invoke(this); - public PutJobRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : base(r => r.Required("job_id", jobId)) - { - } - internal override ApiUrls ApiUrls => ApiUrlLookup.MachineLearningPutJob; protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; @@ -197,11 +303,9 @@ public PutJobRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Id jobId internal override string OperationName => "ml.put_job"; - public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless.Id jobId) - { - RouteValues.Required("job_id", jobId); - return Self; - } + public PutJobRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); + public PutJobRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); + public PutJobRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); private bool? AllowLazyOpenValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisConfig AnalysisConfigValue { get; set; } @@ -221,6 +325,7 @@ public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Se private Action> DatafeedConfigDescriptorAction { get; set; } private string? DescriptionValue { get; set; } private ICollection? GroupsValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Id? JobIdValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPlotConfig? ModelPlotConfigValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPlotConfigDescriptor ModelPlotConfigDescriptor { get; set; } private Action> ModelPlotConfigDescriptorAction { get; set; } @@ -411,6 +516,17 @@ public PutJobRequestDescriptor Groups(ICollection? groups) return Self; } + /// + /// + /// The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. + /// + /// + public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless.Id? jobId) + { + JobIdValue = jobId; + return Self; + } + /// /// /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. @@ -587,6 +703,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, GroupsValue, options); } + if (JobIdValue is not null) + { + writer.WritePropertyName("job_id"); + JsonSerializer.Serialize(writer, JobIdValue, options); + } + if (ModelPlotConfigDescriptor is not null) { writer.WritePropertyName("model_plot_config"); @@ -641,10 +763,6 @@ public sealed partial class PutJobRequestDescriptor : RequestDescriptor configure) => configure.Invoke(this); - public PutJobRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : base(r => r.Required("job_id", jobId)) - { - } - internal override ApiUrls ApiUrls => ApiUrlLookup.MachineLearningPutJob; protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; @@ -653,11 +771,9 @@ public PutJobRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless.Id jobId internal override string OperationName => "ml.put_job"; - public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless.Id jobId) - { - RouteValues.Required("job_id", jobId); - return Self; - } + public PutJobRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); + public PutJobRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); + public PutJobRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); private bool? AllowLazyOpenValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AnalysisConfig AnalysisConfigValue { get; set; } @@ -677,6 +793,7 @@ public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless.Id private Action DatafeedConfigDescriptorAction { get; set; } private string? DescriptionValue { get; set; } private ICollection? GroupsValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Id? JobIdValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPlotConfig? ModelPlotConfigValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPlotConfigDescriptor ModelPlotConfigDescriptor { get; set; } private Action ModelPlotConfigDescriptorAction { get; set; } @@ -867,6 +984,17 @@ public PutJobRequestDescriptor Groups(ICollection? groups) return Self; } + /// + /// + /// The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. + /// + /// + public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless.Id? jobId) + { + JobIdValue = jobId; + return Self; + } + /// /// /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. @@ -1043,6 +1171,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, GroupsValue, options); } + if (JobIdValue is not null) + { + writer.WritePropertyName("job_id"); + JsonSerializer.Serialize(writer, JobIdValue, options); + } + if (ModelPlotConfigDescriptor is not null) { writer.WritePropertyName("model_plot_config"); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs index 1d1df81e3df..93ed85a9966 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs @@ -128,6 +128,8 @@ public sealed partial class PutTrainedModelResponse : ElasticsearchResponse /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } + [JsonInclude, JsonPropertyName("model_package")] + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPackageConfig? ModelPackage { get; init; } [JsonInclude, JsonPropertyName("model_size_bytes")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? ModelSizeBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs index ae9051b30bc..4ff0ec1bb87 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs @@ -129,7 +129,7 @@ public UpdateJobRequest(Elastic.Clients.Elasticsearch.Serverless.Id jobId) : bas /// /// [JsonInclude, JsonPropertyName("detectors")] - public ICollection? Detectors { get; set; } + public ICollection? Detectors { get; set; } /// /// @@ -222,10 +222,10 @@ public UpdateJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch private IDictionary? CustomSettingsValue { get; set; } private long? DailyModelSnapshotRetentionAfterDaysValue { get; set; } private string? DescriptionValue { get; set; } - private ICollection? DetectorsValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorDescriptor DetectorsDescriptor { get; set; } - private Action> DetectorsDescriptorAction { get; set; } - private Action>[] DetectorsDescriptorActions { get; set; } + private ICollection? DetectorsValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorUpdateDescriptor DetectorsDescriptor { get; set; } + private Action> DetectorsDescriptorAction { get; set; } + private Action>[] DetectorsDescriptorActions { get; set; } private ICollection? GroupsValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPlotConfig? ModelPlotConfigValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPlotConfigDescriptor ModelPlotConfigDescriptor { get; set; } @@ -353,7 +353,7 @@ public UpdateJobRequestDescriptor Description(string? description) /// An array of detector update objects. /// /// - public UpdateJobRequestDescriptor Detectors(ICollection? detectors) + public UpdateJobRequestDescriptor Detectors(ICollection? detectors) { DetectorsDescriptor = null; DetectorsDescriptorAction = null; @@ -362,7 +362,7 @@ public UpdateJobRequestDescriptor Detectors(ICollection Detectors(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorDescriptor descriptor) + public UpdateJobRequestDescriptor Detectors(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorUpdateDescriptor descriptor) { DetectorsValue = null; DetectorsDescriptorAction = null; @@ -371,7 +371,7 @@ public UpdateJobRequestDescriptor Detectors(Elastic.Clients.Elasticse return Self; } - public UpdateJobRequestDescriptor Detectors(Action> configure) + public UpdateJobRequestDescriptor Detectors(Action> configure) { DetectorsValue = null; DetectorsDescriptor = null; @@ -380,7 +380,7 @@ public UpdateJobRequestDescriptor Detectors(Action Detectors(params Action>[] configure) + public UpdateJobRequestDescriptor Detectors(params Action>[] configure) { DetectorsValue = null; DetectorsDescriptor = null; @@ -567,7 +567,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o { writer.WritePropertyName("detectors"); writer.WriteStartArray(); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorDescriptor(DetectorsDescriptorAction), options); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorUpdateDescriptor(DetectorsDescriptorAction), options); writer.WriteEndArray(); } else if (DetectorsDescriptorActions is not null) @@ -576,7 +576,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStartArray(); foreach (var action in DetectorsDescriptorActions) { - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorDescriptor(action), options); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorUpdateDescriptor(action), options); } writer.WriteEndArray(); @@ -690,10 +690,10 @@ public UpdateJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Serverless private IDictionary? CustomSettingsValue { get; set; } private long? DailyModelSnapshotRetentionAfterDaysValue { get; set; } private string? DescriptionValue { get; set; } - private ICollection? DetectorsValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorDescriptor DetectorsDescriptor { get; set; } - private Action DetectorsDescriptorAction { get; set; } - private Action[] DetectorsDescriptorActions { get; set; } + private ICollection? DetectorsValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorUpdateDescriptor DetectorsDescriptor { get; set; } + private Action DetectorsDescriptorAction { get; set; } + private Action[] DetectorsDescriptorActions { get; set; } private ICollection? GroupsValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPlotConfig? ModelPlotConfigValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPlotConfigDescriptor ModelPlotConfigDescriptor { get; set; } @@ -821,7 +821,7 @@ public UpdateJobRequestDescriptor Description(string? description) /// An array of detector update objects. /// /// - public UpdateJobRequestDescriptor Detectors(ICollection? detectors) + public UpdateJobRequestDescriptor Detectors(ICollection? detectors) { DetectorsDescriptor = null; DetectorsDescriptorAction = null; @@ -830,7 +830,7 @@ public UpdateJobRequestDescriptor Detectors(ICollection configure) + public UpdateJobRequestDescriptor Detectors(Action configure) { DetectorsValue = null; DetectorsDescriptor = null; @@ -848,7 +848,7 @@ public UpdateJobRequestDescriptor Detectors(Action[] configure) + public UpdateJobRequestDescriptor Detectors(params Action[] configure) { DetectorsValue = null; DetectorsDescriptor = null; @@ -1035,7 +1035,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o { writer.WritePropertyName("detectors"); writer.WriteStartArray(); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorDescriptor(DetectorsDescriptorAction), options); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorUpdateDescriptor(DetectorsDescriptorAction), options); writer.WriteEndArray(); } else if (DetectorsDescriptorActions is not null) @@ -1044,7 +1044,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStartArray(); foreach (var action in DetectorsDescriptorActions) { - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorDescriptor(action), options); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectorUpdateDescriptor(action), options); } writer.WriteEndArray(); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs index 2a37e67278c..f911314146a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class ValidateDetectorRequestParameters : RequestParameter /// /// -/// Validates an anomaly detection detector. +/// Validate an anomaly detection job. /// /// public sealed partial class ValidateDetectorRequest : PlainRequest, ISelfSerializable @@ -60,7 +60,7 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op /// /// -/// Validates an anomaly detection detector. +/// Validate an anomaly detection job. /// /// public sealed partial class ValidateDetectorRequestDescriptor : RequestDescriptor, ValidateDetectorRequestParameters> @@ -112,7 +112,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Validates an anomaly detection detector. +/// Validate an anomaly detection job. /// /// public sealed partial class ValidateDetectorRequestDescriptor : 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 9aa85448a96..e9954b360ad 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 8c0ef9bbda7..25f73f21209 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 3d32f3e4575..1fffa2f1906 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 1f4602c4741..40cdd16d284 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/Nodes/HotThreadsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/HotThreadsRequest.g.cs index db93be34837..a38d38b448c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/HotThreadsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/HotThreadsRequest.g.cs @@ -95,8 +95,9 @@ public sealed partial class HotThreadsRequestParameters : RequestParameters /// /// -/// 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. +/// Get the hot threads for nodes. +/// Get a breakdown of the hot threads on each selected node in the cluster. +/// The output is plain text with a breakdown of the top hot threads for each node. /// /// public sealed partial class HotThreadsRequest : PlainRequest @@ -188,8 +189,9 @@ public HotThreadsRequest(Elastic.Clients.Elasticsearch.Serverless.NodeIds? 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. +/// Get the hot threads for nodes. +/// Get a breakdown of the hot threads on each selected node in the cluster. +/// The output is plain text with a breakdown of the top hot threads for each node. /// /// public sealed partial class HotThreadsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesInfoRequest.g.cs index 4b4b4da648f..c5b0faa1e22 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesInfoRequest.g.cs @@ -56,7 +56,8 @@ public sealed partial class NodesInfoRequestParameters : RequestParameters /// /// -/// Returns cluster nodes information. +/// Get node information. +/// By default, the API returns all attributes and core settings for cluster nodes. /// /// public sealed partial class NodesInfoRequest : PlainRequest @@ -112,7 +113,8 @@ public NodesInfoRequest(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeId /// /// -/// Returns cluster nodes information. +/// Get node information. +/// By default, the API returns all attributes and core settings for cluster nodes. /// /// public sealed partial class NodesInfoRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesStatsRequest.g.cs index 84bcd40044d..1a4216e41b4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesStatsRequest.g.cs @@ -105,7 +105,9 @@ public sealed partial class NodesStatsRequestParameters : RequestParameters /// /// -/// Returns cluster nodes statistics. +/// Get node statistics. +/// Get statistics for nodes in a cluster. +/// By default, all stats are returned. You can limit the returned information by using metrics. /// /// public sealed partial class NodesStatsRequest : PlainRequest @@ -225,7 +227,9 @@ public NodesStatsRequest(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeI /// /// -/// Returns cluster nodes statistics. +/// Get node statistics. +/// Get statistics for nodes in a cluster. +/// By default, all stats are returned. You can limit the returned information by using metrics. /// /// public sealed partial class NodesStatsRequestDescriptor : RequestDescriptor, NodesStatsRequestParameters> @@ -284,7 +288,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns cluster nodes statistics. +/// Get node statistics. +/// Get statistics for nodes in a cluster. +/// By default, all stats are returned. You can limit the returned information by using metrics. /// /// public sealed partial class NodesStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesUsageRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesUsageRequest.g.cs index 2b05ccd320b..f21f5a16d72 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesUsageRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Nodes/NodesUsageRequest.g.cs @@ -43,7 +43,7 @@ public sealed partial class NodesUsageRequestParameters : RequestParameters /// /// -/// Returns information on the usage of features. +/// Get feature usage information. /// /// public sealed partial class NodesUsageRequest : PlainRequest @@ -84,7 +84,7 @@ public NodesUsageRequest(Elastic.Clients.Elasticsearch.Serverless.NodeIds? nodeI /// /// -/// Returns information on the usage of features. +/// Get feature usage information. /// /// public sealed partial class NodesUsageRequestDescriptor : 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 da6b9acc96f..ebdecca3a0f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/OpenPointInTimeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/OpenPointInTimeRequest.g.cs @@ -32,6 +32,14 @@ namespace Elastic.Clients.Elasticsearch.Serverless; public sealed partial class OpenPointInTimeRequestParameters : RequestParameters { + /// + /// + /// If false, creating a point in time request when a shard is missing or unavailable will throw an exception. + /// If true, the point in time will contain all the shards that are available at the time of the request. + /// + /// + public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } + /// /// /// Type of index that wildcard patterns can match. @@ -73,13 +81,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 { @@ -95,6 +110,15 @@ public OpenPointInTimeRequest(Elastic.Clients.Elasticsearch.Serverless.Indices i internal override string OperationName => "open_point_in_time"; + /// + /// + /// If false, creating a point in time request when a shard is missing or unavailable will throw an exception. + /// If true, the point in time will contain all the shards that are available at the time of the request. + /// + /// + [JsonIgnore] + public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } + /// /// /// Type of index that wildcard patterns can match. @@ -149,13 +173,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> { @@ -177,6 +208,7 @@ public OpenPointInTimeRequestDescriptor() : this(typeof(TDocument)) internal override string OperationName => "open_point_in_time"; + public OpenPointInTimeRequestDescriptor AllowPartialSearchResults(bool? allowPartialSearchResults = true) => Qs("allow_partial_search_results", allowPartialSearchResults); public OpenPointInTimeRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public OpenPointInTimeRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); public OpenPointInTimeRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Serverless.Duration keepAlive) => Qs("keep_alive", keepAlive); @@ -247,13 +279,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 { @@ -271,6 +310,7 @@ public OpenPointInTimeRequestDescriptor(Elastic.Clients.Elasticsearch.Serverless internal override string OperationName => "open_point_in_time"; + public OpenPointInTimeRequestDescriptor AllowPartialSearchResults(bool? allowPartialSearchResults = true) => Qs("allow_partial_search_results", allowPartialSearchResults); public OpenPointInTimeRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public OpenPointInTimeRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); public OpenPointInTimeRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Serverless.Duration keepAlive) => Qs("keep_alive", keepAlive); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PingRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PingRequest.g.cs index ca73ff8e6b8..e3ecacfd4db 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/PingRequest.g.cs @@ -37,7 +37,7 @@ public sealed partial class PingRequestParameters : RequestParameters /// /// /// Ping the cluster. -/// Returns whether the cluster is running. +/// Get information about whether the cluster is running. /// /// public sealed partial class PingRequest : PlainRequest @@ -54,7 +54,7 @@ public sealed partial class PingRequest : PlainRequest /// /// /// Ping the cluster. -/// Returns whether the cluster is running. +/// Get information about whether the cluster is running. /// /// public sealed partial class PingRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRuleRequest.g.cs index 68f4d45387b..71d2929e026 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRuleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class DeleteRuleRequestParameters : RequestParameters /// /// -/// Deletes a query rule within a query ruleset. +/// Delete a query rule. +/// Delete a query rule within a query ruleset. /// /// public sealed partial class DeleteRuleRequest : PlainRequest @@ -56,7 +57,8 @@ public DeleteRuleRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, /// /// -/// Deletes a query rule within a query ruleset. +/// Delete a query rule. +/// Delete a query rule within a query ruleset. /// /// public sealed partial class DeleteRuleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs index 53750c2a169..019da9d7104 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class DeleteRulesetRequestParameters : RequestParameters /// /// -/// Deletes a query ruleset. +/// Delete a query ruleset. /// /// public sealed partial class DeleteRulesetRequest : PlainRequest @@ -56,7 +56,7 @@ public DeleteRulesetRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetI /// /// -/// Deletes a query ruleset. +/// Delete a query ruleset. /// /// public sealed partial class DeleteRulesetRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRuleRequest.g.cs index 82b9cfb4363..da7f6ec6cd5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRuleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetRuleRequestParameters : RequestParameters /// /// -/// Returns the details about a query rule within a query ruleset +/// Get a query rule. +/// Get details about a query rule within a query ruleset. /// /// public sealed partial class GetRuleRequest : PlainRequest @@ -56,7 +57,8 @@ public GetRuleRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Ela /// /// -/// Returns the details about a query rule within a query ruleset +/// Get a query rule. +/// Get details about a query rule within a query ruleset. /// /// public sealed partial class GetRuleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRulesetRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRulesetRequest.g.cs index 713129ca4dd..c93e6a9d245 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRulesetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/GetRulesetRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetRulesetRequestParameters : RequestParameters /// /// -/// Returns the details about a query ruleset +/// Get a query ruleset. +/// Get details about a query ruleset. /// /// public sealed partial class GetRulesetRequest : PlainRequest @@ -56,7 +57,8 @@ public GetRulesetRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId) /// /// -/// Returns the details about a query ruleset +/// Get a query ruleset. +/// Get details about a query ruleset. /// /// public sealed partial class GetRulesetRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs index b8ac43368da..88e7dd052ba 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs @@ -49,7 +49,8 @@ public sealed partial class ListRulesetsRequestParameters : RequestParameters /// /// -/// Returns summarized information about existing query rulesets. +/// Get all query rulesets. +/// Get summarized information about the query rulesets. /// /// public sealed partial class ListRulesetsRequest : PlainRequest @@ -81,7 +82,8 @@ public sealed partial class ListRulesetsRequest : PlainRequest /// -/// Returns summarized information about existing query rulesets. +/// Get all query rulesets. +/// Get summarized information about the query rulesets. /// /// public sealed partial class ListRulesetsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRuleRequest.g.cs index df796ed43a9..3016e2216bc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRuleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class PutRuleRequestParameters : RequestParameters /// /// -/// Creates or updates a query rule within a query ruleset. +/// Create or update a query rule. +/// Create or update a query rule within a query ruleset. /// /// public sealed partial class PutRuleRequest : PlainRequest @@ -66,7 +67,8 @@ public PutRuleRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId, Ela /// /// -/// Creates or updates a query rule within a query ruleset. +/// Create or update a query rule. +/// Create or update a query rule within a query ruleset. /// /// public sealed partial class PutRuleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRulesetRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRulesetRequest.g.cs index c5345402201..11e38f97478 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRulesetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/PutRulesetRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class PutRulesetRequestParameters : RequestParameters /// /// -/// Creates or updates a query ruleset. +/// Create or update a query ruleset. /// /// public sealed partial class PutRulesetRequest : PlainRequest @@ -60,7 +60,7 @@ public PutRulesetRequest(Elastic.Clients.Elasticsearch.Serverless.Id rulesetId) /// /// -/// Creates or updates a query ruleset. +/// Create or update a query ruleset. /// /// public sealed partial class PutRulesetRequestDescriptor : 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 00000000000..5c77b61ebde --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/QueryRules/TestRequest.g.cs @@ -0,0 +1,104 @@ +// 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 +{ +} + +/// +/// +/// Test a query ruleset. +/// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. +/// +/// +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; } +} + +/// +/// +/// Test a query ruleset. +/// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. +/// +/// +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 00000000000..f2999d2d408 --- /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 85d9c3e904c..fea24846862 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 d0738646824..8bcfea0159a 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 98214e0bfa4..7a9a01ec4d1 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 4f722b979b8..c86812de36d 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 5c1f2d95bc6..f66e7e1f320 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 79e1a49b383..d7dfb6182ad 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 e1288d7fefc..3a37210a636 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 51d7f4d54b2..fe394e4fec3 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 ecd2ad18764..e87105682bd 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/AuthenticateResponse.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/AuthenticateResponse.g.cs index 653805273f8..3da609f9d34 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/AuthenticateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Security/AuthenticateResponse.g.cs @@ -29,7 +29,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Security; public sealed partial class AuthenticateResponse : ElasticsearchResponse { [JsonInclude, JsonPropertyName("api_key")] - public Elastic.Clients.Elasticsearch.Serverless.Security.ApiKey? ApiKey { get; init; } + public Elastic.Clients.Elasticsearch.Serverless.Security.AuthenticateApiKey? ApiKey { get; init; } [JsonInclude, JsonPropertyName("authentication_realm")] public Elastic.Clients.Elasticsearch.Serverless.Security.RealmInfo AuthenticationRealm { get; init; } [JsonInclude, JsonPropertyName("authentication_type")] 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 ee3942ef7ac..68ea0ad9b1b 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 f7cf7f825e2..459580f2125 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 342b9460d4d..d4817ad108d 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 6222ec0725b..71ab78556a2 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 e867442c434..88ff2437b7e 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 63eb2f221d5..1b9b3c6c0e3 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 6290641f215..7005cecd4fd 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 45ea6354019..9568152258e 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 cf914c5cb46..1b16f173167 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 b13523c31d5..53e7878ab3a 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 51e64452bb0..91b20085b24 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 8b78b92a099..511239673ca 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 48fd4aeb88e..ce2465d95d8 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 ffe29e0129b..a3b20051197 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 4e0b5e25e00..68aba25f44f 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 4b6499dc563..81ba73b3014 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 326829e915f..b8873b769ae 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 f8523f5be5e..289a4f1da56 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 da45eb97feb..a90bea1fddf 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 30e94b5b7f3..a454c8e7319 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 f4132f81a2f..38491b40830 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 3d722b0eb8b..bf6cd184fd8 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 3d2a0ecfb8d..f343ece9bb0 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 0fea9bc36db..52d992c21c1 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 3f6b988aad1..6e0183f4d6a 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 bb282a71b60..5f0dd65f114 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 250badd5619..91b196ec00a 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 dbeec56ac2a..103009be8ce 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 ec0fc8461a8..56c7c266a74 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 d9256ca110e..c4d81214b8a 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 3f146541c72..91ad1b235ae 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 ab3366a5509..2a4b0e681d5 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 9be7d80b892..8b012008cd7 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 17b733fefac..7cb42023af5 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 7e74a7993c4..4da4639b1b7 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 87f3f201e45..7aea332007d 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 0f1142d276b..3d9242111bb 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 148ca66cd00..8222f4fdbf2 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 66f777e8d73..58b98982f3d 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 cdcc6ca1c5a..b631761eb4c 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 0423c1881d5..9b2ffde5d00 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 92570ab779d..fab192886e1 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 91804f5cb3b..601fd669ecb 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 48bb4800091..8aa590fb3b4 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 06552e2e13c..aa6dbc91c92 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 632005a5cc7..3b56008f30a 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/Snapshot/CleanupRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs index 536a9900476..59d830881ff 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs @@ -49,7 +49,8 @@ public sealed partial class CleanupRepositoryRequestParameters : RequestParamete /// /// -/// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. +/// Clean up the snapshot repository. +/// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// public sealed partial class CleanupRepositoryRequest : PlainRequest @@ -85,7 +86,8 @@ public CleanupRepositoryRequest(Elastic.Clients.Elasticsearch.Serverless.Name na /// /// -/// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. +/// Clean up the snapshot repository. +/// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// public sealed partial class CleanupRepositoryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs index 980e63215bd..0407321a189 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs @@ -43,7 +43,8 @@ public sealed partial class CloneSnapshotRequestParameters : RequestParameters /// /// -/// Clones indices from one snapshot into another snapshot in the same repository. +/// Clone a snapshot. +/// Clone part of all of a snapshot into another snapshot in the same repository. /// /// public sealed partial class CloneSnapshotRequest : PlainRequest @@ -75,7 +76,8 @@ public CloneSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Name reposi /// /// -/// Clones indices from one snapshot into another snapshot in the same repository. +/// Clone a snapshot. +/// Clone part of all of a snapshot into another snapshot in the same repository. /// /// public sealed partial class CloneSnapshotRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs index aa33ea57182..a7e7ff20cc7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs @@ -56,7 +56,10 @@ public sealed partial class CreateRepositoryRequestParameters : RequestParameter /// /// -/// Creates a repository. +/// Create or update a snapshot repository. +/// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. +/// To register a snapshot repository, the cluster's global metadata must be writeable. +/// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// public sealed partial class CreateRepositoryRequest : PlainRequest, ISelfSerializable @@ -107,7 +110,10 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op /// /// -/// Creates a repository. +/// Create or update a snapshot repository. +/// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. +/// To register a snapshot repository, the cluster's global metadata must be writeable. +/// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// public sealed partial class CreateRepositoryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs index 3ddf306d510..44ff7ec4ed4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs @@ -49,7 +49,8 @@ public sealed partial class CreateSnapshotRequestParameters : RequestParameters /// /// -/// Creates a snapshot in a repository. +/// Create a snapshot. +/// Take a snapshot of a cluster or of data streams and indices. /// /// public sealed partial class CreateSnapshotRequest : PlainRequest @@ -133,7 +134,8 @@ public CreateSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Name repos /// /// -/// Creates a snapshot in a repository. +/// Create a snapshot. +/// Take a snapshot of a cluster or of data streams and indices. /// /// public sealed partial class CreateSnapshotRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs index 9ffe834ee6e..8446675ce42 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs @@ -49,7 +49,9 @@ public sealed partial class DeleteRepositoryRequestParameters : RequestParameter /// /// -/// Deletes a repository. +/// Delete snapshot repositories. +/// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. +/// The snapshots themselves are left untouched and in place. /// /// public sealed partial class DeleteRepositoryRequest : PlainRequest @@ -85,7 +87,9 @@ public DeleteRepositoryRequest(Elastic.Clients.Elasticsearch.Serverless.Names na /// /// -/// Deletes a repository. +/// Delete snapshot repositories. +/// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. +/// The snapshots themselves are left untouched and in place. /// /// public sealed partial class DeleteRepositoryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs index d3b43160891..42dfe18f7a5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs @@ -42,7 +42,7 @@ public sealed partial class DeleteSnapshotRequestParameters : RequestParameters /// /// -/// Deletes one or more snapshots. +/// Delete snapshots. /// /// public sealed partial class DeleteSnapshotRequest : PlainRequest @@ -70,7 +70,7 @@ public DeleteSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Name repos /// /// -/// Deletes one or more snapshots. +/// Delete snapshots. /// /// public sealed partial class DeleteSnapshotRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs index 42c34330963..80da7c29d60 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs @@ -49,7 +49,7 @@ public sealed partial class GetRepositoryRequestParameters : RequestParameters /// /// -/// Returns information about a repository. +/// Get snapshot repository information. /// /// public sealed partial class GetRepositoryRequest : PlainRequest @@ -89,7 +89,7 @@ public GetRepositoryRequest(Elastic.Clients.Elasticsearch.Serverless.Names? name /// /// -/// Returns information about a repository. +/// Get snapshot repository information. /// /// public sealed partial class GetRepositoryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs index cead7ac5f96..e24aa458406 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs @@ -126,7 +126,7 @@ public sealed partial class GetSnapshotRequestParameters : RequestParameters /// /// -/// Returns information about a snapshot. +/// Get snapshot information. /// /// public sealed partial class GetSnapshotRequest : PlainRequest @@ -250,7 +250,7 @@ public GetSnapshotRequest(Elastic.Clients.Elasticsearch.Serverless.Name reposito /// /// -/// Returns information about a snapshot. +/// Get snapshot information. /// /// public sealed partial class GetSnapshotRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/RestoreRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/RestoreRequest.g.cs index 1bad85d4a84..0b737738f7b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/RestoreRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/RestoreRequest.g.cs @@ -49,7 +49,28 @@ public sealed partial class RestoreRequestParameters : RequestParameters /// /// -/// Restores a snapshot. +/// Restore a snapshot. +/// Restore a snapshot of a cluster or data streams and indices. +/// +/// +/// You can restore a snapshot only to a running cluster with an elected master node. +/// The snapshot repository must be registered and available to the cluster. +/// The snapshot and cluster versions must be compatible. +/// +/// +/// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. +/// +/// +/// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: +/// +/// +/// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream +/// +/// +/// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. +/// +/// +/// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// public sealed partial class RestoreRequest : PlainRequest @@ -105,7 +126,28 @@ public RestoreRequest(Elastic.Clients.Elasticsearch.Serverless.Name repository, /// /// -/// Restores a snapshot. +/// Restore a snapshot. +/// Restore a snapshot of a cluster or data streams and indices. +/// +/// +/// You can restore a snapshot only to a running cluster with an elected master node. +/// The snapshot repository must be registered and available to the cluster. +/// The snapshot and cluster versions must be compatible. +/// +/// +/// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. +/// +/// +/// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: +/// +/// +/// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream +/// +/// +/// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. +/// +/// +/// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// public sealed partial class RestoreRequestDescriptor : RequestDescriptor, RestoreRequestParameters> @@ -309,7 +351,28 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Restores a snapshot. +/// Restore a snapshot. +/// Restore a snapshot of a cluster or data streams and indices. +/// +/// +/// You can restore a snapshot only to a running cluster with an elected master node. +/// The snapshot repository must be registered and available to the cluster. +/// The snapshot and cluster versions must be compatible. +/// +/// +/// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. +/// +/// +/// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: +/// +/// +/// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream +/// +/// +/// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. +/// +/// +/// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// public sealed partial class RestoreRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs index 380bc29ce61..f30fbb0d885 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs @@ -49,7 +49,19 @@ public sealed partial class SnapshotStatusRequestParameters : RequestParameters /// /// -/// Returns information about the status of a snapshot. +/// Get the snapshot status. +/// Get a detailed description of the current state for each shard participating in the snapshot. +/// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. +/// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. +/// +/// +/// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. +/// The API requires a read from the repository for each shard in each snapshot. +/// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). +/// +/// +/// Depending on the latency of your storage, such requests can take an extremely long time to return results. +/// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// public sealed partial class SnapshotStatusRequest : PlainRequest @@ -93,7 +105,19 @@ public SnapshotStatusRequest(Elastic.Clients.Elasticsearch.Serverless.Name? repo /// /// -/// Returns information about the status of a snapshot. +/// Get the snapshot status. +/// Get a detailed description of the current state for each shard participating in the snapshot. +/// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. +/// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. +/// +/// +/// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. +/// The API requires a read from the repository for each shard in each snapshot. +/// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). +/// +/// +/// Depending on the latency of your storage, such requests can take an extremely long time to return results. +/// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// public sealed partial class SnapshotStatusRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs index 9cb312c97e3..ef9a8848780 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs @@ -49,7 +49,8 @@ public sealed partial class VerifyRepositoryRequestParameters : RequestParameter /// /// -/// Verifies a repository. +/// Verify a snapshot repository. +/// Check for common misconfigurations in a snapshot repository. /// /// public sealed partial class VerifyRepositoryRequest : PlainRequest @@ -85,7 +86,8 @@ public VerifyRepositoryRequest(Elastic.Clients.Elasticsearch.Serverless.Name nam /// /// -/// Verifies a repository. +/// Verify a snapshot repository. +/// Check for common misconfigurations in a snapshot repository. /// /// public sealed partial class VerifyRepositoryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs index 4928051cc69..07d02724d46 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class DeleteLifecycleRequestParameters : RequestParameters /// /// -/// Deletes an existing snapshot lifecycle policy. +/// Delete a policy. +/// Delete a snapshot lifecycle policy definition. +/// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// public sealed partial class DeleteLifecycleRequest : PlainRequest @@ -56,7 +58,9 @@ public DeleteLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.Name poli /// /// -/// Deletes an existing snapshot lifecycle policy. +/// Delete a policy. +/// Delete a snapshot lifecycle policy definition. +/// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// public sealed partial class DeleteLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs index 8eef429b7c5..c593ffdc5fe 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class ExecuteLifecycleRequestParameters : RequestParameter /// /// -/// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. +/// Run a policy. +/// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. +/// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// public sealed partial class ExecuteLifecycleRequest : PlainRequest @@ -56,7 +58,9 @@ public ExecuteLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.Name pol /// /// -/// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. +/// Run a policy. +/// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. +/// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// public sealed partial class ExecuteLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs index f40e8846bee..56476c30003 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class ExecuteRetentionRequestParameters : RequestParameter /// /// -/// Deletes any snapshots that are expired according to the policy's retention rules. +/// Run a retention policy. +/// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. +/// The retention policy is normally applied according to its schedule. /// /// public sealed partial class ExecuteRetentionRequest : PlainRequest @@ -52,7 +54,9 @@ public sealed partial class ExecuteRetentionRequest : PlainRequest /// -/// Deletes any snapshots that are expired according to the policy's retention rules. +/// Run a retention policy. +/// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. +/// The retention policy is normally applied according to its schedule. /// /// public sealed partial class ExecuteRetentionRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs index ec9a638e65a..1cbee94e18a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetLifecycleRequestParameters : RequestParameters /// /// -/// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. +/// Get policy information. +/// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// public sealed partial class GetLifecycleRequest : PlainRequest @@ -60,7 +61,8 @@ public GetLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.Names? polic /// /// -/// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. +/// Get policy information. +/// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// public sealed partial class GetLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs index fbf1bca10a5..f77374b8586 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class GetSlmStatusRequestParameters : RequestParameters /// /// -/// Retrieves the status of snapshot lifecycle management (SLM). +/// Get the snapshot lifecycle management status. /// /// public sealed partial class GetSlmStatusRequest : PlainRequest @@ -52,7 +52,7 @@ public sealed partial class GetSlmStatusRequest : PlainRequest /// -/// Retrieves the status of snapshot lifecycle management (SLM). +/// Get the snapshot lifecycle management status. /// /// public sealed partial class GetSlmStatusRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs index f9493bf36d2..ec1b6f7077b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetStatsRequestParameters : RequestParameters /// /// -/// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. +/// Get snapshot lifecycle management statistics. +/// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// public sealed partial class GetStatsRequest : PlainRequest @@ -52,7 +53,8 @@ public sealed partial class GetStatsRequest : PlainRequest /// -/// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. +/// Get snapshot lifecycle management statistics. +/// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// public sealed partial class GetStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs index 0db37421a40..535ce9f30f4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs @@ -49,7 +49,10 @@ public sealed partial class PutLifecycleRequestParameters : RequestParameters /// /// -/// Creates or updates a snapshot lifecycle policy. +/// Create or update a policy. +/// Create or update a snapshot lifecycle policy. +/// If the policy already exists, this request increments the policy version. +/// Only the latest version of a policy is stored. /// /// public sealed partial class PutLifecycleRequest : PlainRequest @@ -125,7 +128,10 @@ public PutLifecycleRequest(Elastic.Clients.Elasticsearch.Serverless.Name policyI /// /// -/// Creates or updates a snapshot lifecycle policy. +/// Create or update a policy. +/// Create or update a snapshot lifecycle policy. +/// If the policy already exists, this request increments the policy version. +/// Only the latest version of a policy is stored. /// /// public sealed partial class PutLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs index 30e8185be51..5b6039a70e7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class StartSlmRequestParameters : RequestParameters /// /// -/// Turns on snapshot lifecycle management (SLM). +/// Start snapshot lifecycle management. +/// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. +/// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// public sealed partial class StartSlmRequest : PlainRequest @@ -52,7 +54,9 @@ public sealed partial class StartSlmRequest : PlainRequest /// -/// Turns on snapshot lifecycle management (SLM). +/// Start snapshot lifecycle management. +/// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. +/// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// public sealed partial class StartSlmRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs index f45eb97087a..5609d3cdb0e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs @@ -36,7 +36,15 @@ public sealed partial class StopSlmRequestParameters : RequestParameters /// /// -/// Turns off snapshot lifecycle management (SLM). +/// Stop snapshot lifecycle management. +/// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. +/// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. +/// Stopping SLM does not stop any snapshots that are in progress. +/// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. +/// +/// +/// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. +/// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// public sealed partial class StopSlmRequest : PlainRequest @@ -52,7 +60,15 @@ public sealed partial class StopSlmRequest : PlainRequest /// -/// Turns off snapshot lifecycle management (SLM). +/// Stop snapshot lifecycle management. +/// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. +/// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. +/// Stopping SLM does not stop any snapshots that are in progress. +/// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. +/// +/// +/// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. +/// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// public sealed partial class StopSlmRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/ClearCursorRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/ClearCursorRequest.g.cs index cdd973674e8..62374e69b2f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/ClearCursorRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/ClearCursorRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class ClearCursorRequestParameters : RequestParameters /// /// -/// Clears the SQL cursor +/// Clear an SQL search cursor. /// /// public sealed partial class ClearCursorRequest : PlainRequest @@ -60,7 +60,7 @@ public sealed partial class ClearCursorRequest : PlainRequest /// -/// Clears the SQL cursor +/// Clear an SQL search cursor. /// /// public sealed partial class ClearCursorRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/DeleteAsyncRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/DeleteAsyncRequest.g.cs index cd4a651c231..28e4492132b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/DeleteAsyncRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/DeleteAsyncRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class DeleteAsyncRequestParameters : RequestParameters /// /// -/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// Delete an async SQL search. +/// Delete an async SQL search or a stored synchronous SQL search. +/// If the search is still running, the API cancels it. /// /// public sealed partial class DeleteAsyncRequest : PlainRequest @@ -56,7 +58,9 @@ public DeleteAsyncRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base /// /// -/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// Delete an async SQL search. +/// Delete an async SQL search or a stored synchronous SQL search. +/// If the search is still running, the API cancels it. /// /// public sealed partial class DeleteAsyncRequestDescriptor : RequestDescriptor, DeleteAsyncRequestParameters> @@ -88,7 +92,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// Delete an async SQL search. +/// Delete an async SQL search or a stored synchronous SQL search. +/// If the search is still running, the API cancels it. /// /// public sealed partial class DeleteAsyncRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncRequest.g.cs index 67f792e1318..0c705dc0baf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncRequest.g.cs @@ -66,7 +66,8 @@ public sealed partial class GetAsyncRequestParameters : RequestParameters /// /// -/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// Get async SQL search results. +/// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// public sealed partial class GetAsyncRequest : PlainRequest @@ -121,7 +122,8 @@ public GetAsyncRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base(r /// /// -/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// Get async SQL search results. +/// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// public sealed partial class GetAsyncRequestDescriptor : RequestDescriptor, GetAsyncRequestParameters> @@ -158,7 +160,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// Get async SQL search results. +/// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// public sealed partial class GetAsyncRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs index eef69541dba..c8722fb5eb4 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetAsyncStatusRequestParameters : RequestParameters /// /// -/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// Get the async SQL search status. +/// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// public sealed partial class GetAsyncStatusRequest : PlainRequest @@ -56,7 +57,8 @@ public GetAsyncStatusRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : b /// /// -/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// Get the async SQL search status. +/// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// public sealed partial class GetAsyncStatusRequestDescriptor : RequestDescriptor, GetAsyncStatusRequestParameters> @@ -88,7 +90,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// Get the async SQL search status. +/// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// public sealed partial class GetAsyncStatusRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/QueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/QueryRequest.g.cs index 52855fd1922..89eac05f2c1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/QueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/QueryRequest.g.cs @@ -42,7 +42,8 @@ public sealed partial class QueryRequestParameters : RequestParameters /// /// -/// Executes a SQL request +/// Get SQL search results. +/// Run an SQL request. /// /// public sealed partial class QueryRequest : PlainRequest @@ -197,7 +198,8 @@ public sealed partial class QueryRequest : PlainRequest /// /// -/// Executes a SQL request +/// Get SQL search results. +/// Run an SQL request. /// /// public sealed partial class QueryRequestDescriptor : RequestDescriptor, QueryRequestParameters> @@ -549,7 +551,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Executes a SQL request +/// Get SQL search results. +/// Run an SQL request. /// /// public sealed partial class QueryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/TranslateRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/TranslateRequest.g.cs index 9d1b219c729..232449c0e9b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/TranslateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Sql/TranslateRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class TranslateRequestParameters : RequestParameters /// /// -/// Translates SQL into Elasticsearch queries +/// Translate SQL into Elasticsearch queries. +/// Translate an SQL search into a search API request containing Query DSL. /// /// public sealed partial class TranslateRequest : PlainRequest @@ -84,7 +85,8 @@ public sealed partial class TranslateRequest : PlainRequest /// -/// Translates SQL into Elasticsearch queries +/// Translate SQL into Elasticsearch queries. +/// Translate an SQL search into a search API request containing Query DSL. /// /// public sealed partial class TranslateRequestDescriptor : RequestDescriptor, TranslateRequestParameters> @@ -211,7 +213,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Translates SQL into Elasticsearch queries +/// Translate SQL into Elasticsearch queries. +/// Translate an SQL search into a search API request containing Query DSL. /// /// public sealed partial class TranslateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs index bbf7376e41c..744034456bf 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class DeleteSynonymRequestParameters : RequestParameters /// /// -/// Deletes a synonym set +/// Delete a synonym set. /// /// public sealed partial class DeleteSynonymRequest : PlainRequest @@ -56,7 +56,7 @@ public DeleteSynonymRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : ba /// /// -/// Deletes a synonym set +/// Delete a synonym set. /// /// public sealed partial class DeleteSynonymRequestDescriptor : RequestDescriptor, DeleteSynonymRequestParameters> @@ -88,7 +88,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes a synonym set +/// Delete a synonym set. /// /// public sealed partial class DeleteSynonymRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs index 4895992fa55..5564af586ab 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class DeleteSynonymRuleRequestParameters : RequestParamete /// /// -/// Deletes a synonym rule in a synonym set +/// Delete a synonym rule. +/// Delete a synonym rule from a synonym set. /// /// public sealed partial class DeleteSynonymRuleRequest : PlainRequest @@ -56,7 +57,8 @@ public DeleteSynonymRuleRequest(Elastic.Clients.Elasticsearch.Serverless.Id setI /// /// -/// Deletes a synonym rule in a synonym set +/// Delete a synonym rule. +/// Delete a synonym rule from a synonym set. /// /// public sealed partial class DeleteSynonymRuleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRequest.g.cs index a3ba571e818..e1c50dc206c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRequest.g.cs @@ -49,7 +49,7 @@ public sealed partial class GetSynonymRequestParameters : RequestParameters /// /// -/// Retrieves a synonym set +/// Get a synonym set. /// /// public sealed partial class GetSynonymRequest : PlainRequest @@ -85,7 +85,7 @@ public GetSynonymRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base( /// /// -/// Retrieves a synonym set +/// Get a synonym set. /// /// public sealed partial class GetSynonymRequestDescriptor : RequestDescriptor, GetSynonymRequestParameters> @@ -120,7 +120,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieves a synonym set +/// Get a synonym set. /// /// public sealed partial class GetSynonymRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs index 551a46722fc..6568a2355e8 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetSynonymRuleRequestParameters : RequestParameters /// /// -/// Retrieves a synonym rule from a synonym set +/// Get a synonym rule. +/// Get a synonym rule from a synonym set. /// /// public sealed partial class GetSynonymRuleRequest : PlainRequest @@ -56,7 +57,8 @@ public GetSynonymRuleRequest(Elastic.Clients.Elasticsearch.Serverless.Id setId, /// /// -/// Retrieves a synonym rule from a synonym set +/// Get a synonym rule. +/// Get a synonym rule from a synonym set. /// /// public sealed partial class GetSynonymRuleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs index f3556c07639..7ffe234f589 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs @@ -49,7 +49,8 @@ public sealed partial class GetSynonymsSetsRequestParameters : RequestParameters /// /// -/// Retrieves a summary of all defined synonym sets +/// Get all synonym sets. +/// Get a summary of all defined synonym sets. /// /// public sealed partial class GetSynonymsSetsRequest : PlainRequest @@ -81,7 +82,8 @@ public sealed partial class GetSynonymsSetsRequest : PlainRequest /// -/// Retrieves a summary of all defined synonym sets +/// Get all synonym sets. +/// Get a summary of all defined synonym sets. /// /// public sealed partial class GetSynonymsSetsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRequest.g.cs index eb3bc42c977..917cc4d52a7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class PutSynonymRequestParameters : RequestParameters /// /// -/// Creates or updates a synonym set. +/// Create or update a synonym set. +/// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. +/// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// public sealed partial class PutSynonymRequest : PlainRequest @@ -65,7 +67,9 @@ public PutSynonymRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : base( /// /// -/// Creates or updates a synonym set. +/// Create or update a synonym set. +/// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. +/// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// public sealed partial class PutSynonymRequestDescriptor : RequestDescriptor, PutSynonymRequestParameters> @@ -174,7 +178,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Creates or updates a synonym set. +/// Create or update a synonym set. +/// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. +/// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// public sealed partial class PutSynonymRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs index 8be950cb915..670ee2ea436 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class PutSynonymRuleRequestParameters : RequestParameters /// /// -/// Creates or updates a synonym rule in a synonym set +/// Create or update a synonym rule. +/// Create or update a synonym rule in a synonym set. /// /// public sealed partial class PutSynonymRuleRequest : PlainRequest @@ -59,7 +60,8 @@ public PutSynonymRuleRequest(Elastic.Clients.Elasticsearch.Serverless.Id setId, /// /// -/// Creates or updates a synonym rule in a synonym set +/// Create or update a synonym rule. +/// Create or update a synonym rule in a synonym set. /// /// public sealed partial class PutSynonymRuleRequestDescriptor : 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 9819d123880..7854f379409 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 52e089690d1..5173a597bac 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/TextStructure/TestGrokPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs index 2dbc2a313ac..244b0a6f31d 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs @@ -42,7 +42,9 @@ public sealed partial class TestGrokPatternRequestParameters : RequestParameters /// /// -/// Tests a Grok pattern on some text. +/// Test a Grok pattern. +/// Test a Grok pattern on one or more lines of text. +/// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// public sealed partial class TestGrokPatternRequest : PlainRequest @@ -82,7 +84,9 @@ public sealed partial class TestGrokPatternRequest : PlainRequest /// -/// Tests a Grok pattern on some text. +/// Test a Grok pattern. +/// Test a Grok pattern on one or more lines of text. +/// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// public sealed partial class TestGrokPatternRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs index 39f39a92812..0f3088cb7ff 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs @@ -50,12 +50,22 @@ public sealed partial class UpgradeTransformsRequestParameters : RequestParamete /// /// -/// Upgrades all transforms. -/// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It -/// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not -/// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when -/// Elasticsearch security features are enabled; the role used to read source data and write to the destination index -/// remains unchanged. +/// Upgrade all transforms. +/// Transforms are compatible across minor versions and between supported major versions. +/// However, over time, the format of transform configuration information may change. +/// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. +/// It also cleans up the internal data structures that store the transform state and checkpoints. +/// The upgrade does not affect the source and destination indices. +/// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. +/// +/// +/// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. +/// Resolve the issue then re-run the process again. +/// A summary is returned when the upgrade is finished. +/// +/// +/// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. +/// You may want to perform a recent cluster backup prior to the upgrade. /// /// public sealed partial class UpgradeTransformsRequest : PlainRequest @@ -88,12 +98,22 @@ public sealed partial class UpgradeTransformsRequest : PlainRequest /// -/// Upgrades all transforms. -/// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It -/// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not -/// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when -/// Elasticsearch security features are enabled; the role used to read source data and write to the destination index -/// remains unchanged. +/// Upgrade all transforms. +/// Transforms are compatible across minor versions and between supported major versions. +/// However, over time, the format of transform configuration information may change. +/// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. +/// It also cleans up the internal data structures that store the transform state and checkpoints. +/// The upgrade does not affect the source and destination indices. +/// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. +/// +/// +/// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. +/// Resolve the issue then re-run the process again. +/// A summary is returned when the upgrade is finished. +/// +/// +/// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. +/// You may want to perform a recent cluster backup prior to the upgrade. /// /// public sealed partial class UpgradeTransformsRequestDescriptor : 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 a10de0936d2..a5f50b58ef1 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/Api/Xpack/XpackInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackInfoRequest.g.cs index 27e5362452e..397e22bf78c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackInfoRequest.g.cs @@ -49,8 +49,26 @@ public sealed partial class XpackInfoRequestParameters : RequestParameters /// /// -/// Provides general information about the installed X-Pack features. +/// Get information. +/// The information provided by the API includes: /// +/// +/// +/// +/// Build information including the build number and timestamp. +/// +/// +/// +/// +/// License information about the currently installed license. +/// +/// +/// +/// +/// Feature information for the features that are currently enabled and available under the current license. +/// +/// +/// /// public sealed partial class XpackInfoRequest : PlainRequest { @@ -81,8 +99,26 @@ public sealed partial class XpackInfoRequest : PlainRequest /// -/// Provides general information about the installed X-Pack features. +/// Get information. +/// The information provided by the API includes: +/// +/// +/// +/// +/// Build information including the build number and timestamp. +/// +/// +/// +/// +/// License information about the currently installed license. +/// +/// +/// +/// +/// Feature information for the features that are currently enabled and available under the current license. /// +/// +/// /// public sealed partial class XpackInfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackUsageRequest.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackUsageRequest.g.cs index e3db78bf7d7..5d80470c1ec 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackUsageRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/Xpack/XpackUsageRequest.g.cs @@ -42,7 +42,9 @@ public sealed partial class XpackUsageRequestParameters : RequestParameters /// /// -/// This API provides information about which features are currently enabled and available under the current license and some usage statistics. +/// Get usage information. +/// Get information about the features that are currently enabled and available under the current license. +/// The API also provides some usage statistics. /// /// public sealed partial class XpackUsageRequest : PlainRequest @@ -66,7 +68,9 @@ public sealed partial class XpackUsageRequest : PlainRequest /// -/// This API provides information about which features are currently enabled and available under the current license and some usage statistics. +/// Get usage information. +/// Get information about the features that are currently enabled and available under the current license. +/// The API also provides some usage statistics. /// /// public sealed partial class XpackUsageRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs index 95d1920cbb8..180d5e8e8ef 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 ac98b37b291..6afbfcf0cf6 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 @@ -41,9 +41,13 @@ internal ClusterNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Provides explanations for shard allocations in the cluster. + /// Explain the shard allocations. + /// Get explanations for shard allocations in the cluster. + /// For unassigned shards, it provides an explanation for why the shard is unassigned. + /// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + /// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// - /// 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) { @@ -53,9 +57,13 @@ public virtual Task AllocationExplainAsync(Allocation /// /// - /// Provides explanations for shard allocations in the cluster. + /// Explain the shard allocations. + /// Get explanations for shard allocations in the cluster. + /// For unassigned shards, it provides an explanation for why the shard is unassigned. + /// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + /// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// - /// 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) { @@ -65,9 +73,13 @@ public virtual Task AllocationExplainAsync(Allocation /// /// - /// Provides explanations for shard allocations in the cluster. + /// Explain the shard allocations. + /// Get explanations for shard allocations in the cluster. + /// For unassigned shards, it provides an explanation for why the shard is unassigned. + /// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + /// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// - /// 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) { @@ -78,9 +90,13 @@ public virtual Task AllocationExplainAsync(Cancellati /// /// - /// Provides explanations for shard allocations in the cluster. + /// Explain the shard allocations. + /// Get explanations for shard allocations in the cluster. + /// For unassigned shards, it provides an explanation for why the shard is unassigned. + /// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + /// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// - /// 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 +112,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 +126,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 +140,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 +155,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 +170,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 +183,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 +196,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 +210,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 +225,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 +238,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 +251,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 +265,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 +280,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 +294,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) { @@ -290,10 +306,10 @@ public virtual Task GetComponentTemplateAsync(Acti /// /// - /// Returns cluster-wide settings. + /// Get 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) { @@ -303,10 +319,10 @@ public virtual Task GetSettingsAsync(GetClusterSetti /// /// - /// Returns cluster-wide settings. + /// Get 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) { @@ -316,10 +332,10 @@ public virtual Task GetSettingsAsync(GetClusterSetti /// /// - /// Returns cluster-wide settings. + /// Get 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) { @@ -330,10 +346,10 @@ public virtual Task GetSettingsAsync(CancellationTok /// /// - /// Returns cluster-wide settings. + /// Get 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) { @@ -345,10 +361,20 @@ public virtual Task GetSettingsAsync(Action /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. - /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// Get the cluster health status. + /// 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. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequest request, CancellationToken cancellationToken = default) { @@ -358,10 +384,20 @@ 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. + /// Get the cluster health status. + /// 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. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -371,10 +407,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) { @@ -385,10 +431,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// 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) { @@ -400,10 +456,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// 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) { @@ -414,10 +480,20 @@ 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. + /// Get the cluster health status. + /// 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. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -429,10 +505,20 @@ public virtual Task HealthAsync(Action /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. - /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -442,10 +528,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) { @@ -456,10 +552,20 @@ 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. + /// Get the cluster health status. + /// 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. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -471,10 +577,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// 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) { @@ -485,10 +601,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -503,7 +629,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 +642,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 +655,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 +669,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) { @@ -555,12 +681,15 @@ public virtual Task InfoAsync(IReadOnlyCollection /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// Get the pending cluster tasks. + /// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + /// + /// /// NOTE: This API returns a list of any pending updates to the cluster state. - /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// 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) { @@ -570,12 +699,15 @@ public virtual Task PendingTasksAsync(PendingTasksRequest /// /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// Get the pending cluster tasks. + /// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + /// + /// /// NOTE: This API returns a list of any pending updates to the cluster state. - /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// 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) { @@ -585,12 +717,15 @@ public virtual Task PendingTasksAsync(PendingTasksRequestD /// /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// Get the pending cluster tasks. + /// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + /// + /// /// NOTE: This API returns a list of any pending updates to the cluster state. - /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// 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) { @@ -601,12 +736,15 @@ public virtual Task PendingTasksAsync(CancellationToken ca /// /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// Get the pending cluster tasks. + /// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + /// + /// /// NOTE: This API returns a list of any pending updates to the cluster state. - /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// 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 +777,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 +808,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 +839,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 +871,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 +904,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 +935,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 +967,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) { @@ -841,10 +979,10 @@ public virtual Task PutComponentTemplateAsync(Elas /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) { @@ -854,10 +992,10 @@ public virtual Task StatsAsync(ClusterStatsRequest request /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) { @@ -867,10 +1005,10 @@ public virtual Task StatsAsync(ClusterStatsRequestDescript /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) { @@ -881,10 +1019,10 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) { @@ -896,10 +1034,10 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) { @@ -910,10 +1048,10 @@ public virtual Task StatsAsync(CancellationToken cancellat /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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 374798d47c5..263f7a4f19d 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 @@ -96,9 +96,10 @@ public virtual Task DeletePolicyAsync(Elastic.Clients.Elas /// /// - /// Creates the enrich index for an existing enrich policy. + /// Run an enrich policy. + /// Create 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) { @@ -108,9 +109,10 @@ public virtual Task ExecutePolicyAsync(ExecutePolicyReque /// /// - /// Creates the enrich index for an existing enrich policy. + /// Run an enrich policy. + /// Create 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) { @@ -120,9 +122,10 @@ public virtual Task ExecutePolicyAsync(ExecutePolicyReque /// /// - /// Creates the enrich index for an existing enrich policy. + /// Run an enrich policy. + /// Create 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) { @@ -133,9 +136,10 @@ public virtual Task ExecutePolicyAsync(Elastic.Clients.El /// /// - /// Creates the enrich index for an existing enrich policy. + /// Run an enrich policy. + /// Create 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 +238,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 +251,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 +264,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 +278,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 +293,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 +306,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 +320,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 cf1153ff7cc..2e526151b69 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 @@ -41,7 +41,8 @@ internal EqlNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -54,7 +55,8 @@ public virtual Task DeleteAsync(EqlDeleteRequest request, Can /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -67,7 +69,8 @@ public virtual Task DeleteAsync(EqlDeleteRequestDe /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -81,7 +84,8 @@ public virtual Task DeleteAsync(Elastic.Clients.El /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -96,7 +100,8 @@ public virtual Task DeleteAsync(Elastic.Clients.El /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -109,7 +114,8 @@ public virtual Task DeleteAsync(EqlDeleteRequestDescriptor de /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -123,7 +129,8 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -138,9 +145,10 @@ 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. + /// Get async EQL search results. + /// Get 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) { @@ -150,9 +158,10 @@ public virtual Task> GetAsync(EqlGetRequest reque /// /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// Get async EQL search results. + /// Get 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) { @@ -162,9 +171,10 @@ public virtual Task> GetAsync(EqlGetRequestDescri /// /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// Get async EQL search results. + /// Get 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) { @@ -175,9 +185,10 @@ 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. + /// Get async EQL search results. + /// Get 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) { @@ -189,9 +200,10 @@ 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. + /// Get the async EQL status. + /// Get 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) { @@ -201,9 +213,10 @@ public virtual Task GetStatusAsync(GetEqlStatusRequest req /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) { @@ -213,9 +226,10 @@ public virtual Task GetStatusAsync(GetEqlStatus /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) { @@ -226,9 +240,10 @@ public virtual Task GetStatusAsync(Elastic.Clie /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) { @@ -240,9 +255,10 @@ public virtual Task GetStatusAsync(Elastic.Clie /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) { @@ -252,9 +268,10 @@ public virtual Task GetStatusAsync(GetEqlStatusRequestDesc /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) { @@ -265,9 +282,10 @@ 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. + /// Get the async EQL status. + /// Get 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) { @@ -279,7 +297,9 @@ public virtual Task GetStatusAsync(Elastic.Clients.Elastic /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -291,7 +311,9 @@ public virtual Task> SearchAsync(EqlSearchRequ /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -303,7 +325,9 @@ public virtual Task> SearchAsync(EqlSearchRequ /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -316,7 +340,9 @@ public virtual Task> SearchAsync(Elastic.Clien /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -330,7 +356,9 @@ public virtual Task> SearchAsync(Elastic.Clien /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -343,7 +371,9 @@ public virtual Task> SearchAsync(CancellationT /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 e6b8033d87e..54b8f92f245 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 @@ -41,9 +41,10 @@ internal EsqlNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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) { @@ -53,9 +54,10 @@ public virtual Task QueryAsync(EsqlQueryRequest request, Canc /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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) { @@ -65,9 +67,10 @@ public virtual Task QueryAsync(EsqlQueryRequestDes /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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) { @@ -78,9 +81,10 @@ public virtual Task QueryAsync(CancellationToken c /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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) { @@ -92,9 +96,10 @@ public virtual Task QueryAsync(Action /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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) { @@ -104,9 +109,10 @@ public virtual Task QueryAsync(EsqlQueryRequestDescriptor des /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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) { @@ -117,9 +123,10 @@ public virtual Task QueryAsync(CancellationToken cancellation /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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 fd06cd6d387..d74eed54e18 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 @@ -41,9 +41,14 @@ internal GraphNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -53,9 +58,14 @@ public virtual Task ExploreAsync(ExploreRequest request, Cancel /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -65,9 +75,14 @@ public virtual Task ExploreAsync(ExploreRequestDescr /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -78,9 +93,14 @@ public virtual Task ExploreAsync(Elastic.Clients.Ela /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -92,9 +112,14 @@ public virtual Task ExploreAsync(Elastic.Clients.Ela /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -105,9 +130,14 @@ public virtual Task ExploreAsync(CancellationToken c /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -119,9 +149,14 @@ public virtual Task ExploreAsync(Action /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -131,9 +166,14 @@ public virtual Task ExploreAsync(ExploreRequestDescriptor descr /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -144,9 +184,14 @@ public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch. /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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 7b6acfce7ab..d4cd006316c 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) { @@ -185,8 +196,9 @@ public virtual Task AnalyzeAsync(Action /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -198,8 +210,9 @@ public virtual Task ClearCacheAsync(ClearCacheRequest reques /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -211,8 +224,9 @@ public virtual Task ClearCacheAsync(ClearCacheReq /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -225,8 +239,9 @@ public virtual Task ClearCacheAsync(Elastic.Clien /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -240,8 +255,9 @@ public virtual Task ClearCacheAsync(Elastic.Clien /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -254,8 +270,9 @@ public virtual Task ClearCacheAsync(CancellationT /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -269,8 +286,9 @@ public virtual Task ClearCacheAsync(Action /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -282,8 +300,9 @@ public virtual Task ClearCacheAsync(ClearCacheRequestDescrip /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -296,8 +315,9 @@ public virtual Task ClearCacheAsync(Elastic.Clients.Elastics /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -311,8 +331,9 @@ public virtual Task ClearCacheAsync(Elastic.Clients.Elastics /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -325,8 +346,9 @@ public virtual Task ClearCacheAsync(CancellationToken cancel /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -340,9 +362,30 @@ public virtual Task ClearCacheAsync(Action /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequest request, CancellationToken cancellationToken = default) { @@ -352,9 +395,30 @@ public virtual Task CloseAsync(CloseIndexRequest request, Ca /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -364,9 +428,30 @@ public virtual Task CloseAsync(CloseIndexRequestD /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// - /// 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) { @@ -377,9 +462,30 @@ public virtual Task CloseAsync(Elastic.Clients.El /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -391,9 +497,30 @@ public virtual Task CloseAsync(Elastic.Clients.El /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CancellationToken cancellationToken = default) { @@ -404,9 +531,30 @@ public virtual Task CloseAsync(CancellationToken /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -418,9 +566,30 @@ public virtual Task CloseAsync(Action /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// - /// 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) { @@ -430,9 +599,30 @@ public virtual Task CloseAsync(CloseIndexRequestDescriptor d /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Serverless.Indices indices, CancellationToken cancellationToken = default) { @@ -443,9 +633,30 @@ public virtual Task CloseAsync(Elastic.Clients.Elasticsearch /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// 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 +671,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 +684,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 +697,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 +711,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 +726,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 +740,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 +755,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 +768,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 +782,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) { @@ -1432,7 +1643,8 @@ public virtual Task ExistsAliasAsync(Elastic.Clients.Elasti /// /// - /// Returns information about whether a particular index template exists. + /// Check index templates. + /// Check whether index templates exist. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1444,7 +1656,8 @@ public virtual Task ExistsIndexTemplateAsync(Exists /// /// - /// Returns information about whether a particular index template exists. + /// Check index templates. + /// Check whether index templates exist. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1456,7 +1669,8 @@ public virtual Task ExistsIndexTemplateAsync(Exists /// /// - /// Returns information about whether a particular index template exists. + /// Check index templates. + /// Check whether index templates exist. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1469,7 +1683,8 @@ public virtual Task ExistsIndexTemplateAsync(Elasti /// /// - /// Returns information about whether a particular index template exists. + /// Check index templates. + /// Check whether index templates exist. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1484,7 +1699,7 @@ public virtual Task ExistsIndexTemplateAsync(Elasti /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1497,7 +1712,7 @@ public virtual Task ExplainDataLifecycleAsync(Expl /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1510,7 +1725,7 @@ public virtual Task ExplainDataLifecycleAsync /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1524,7 +1739,7 @@ public virtual Task ExplainDataLifecycleAsync /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1539,7 +1754,7 @@ public virtual Task ExplainDataLifecycleAsync /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1553,7 +1768,7 @@ public virtual Task ExplainDataLifecycleAsync /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1568,7 +1783,7 @@ public virtual Task ExplainDataLifecycleAsync /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1581,7 +1796,7 @@ public virtual Task ExplainDataLifecycleAsync(Expl /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1595,7 +1810,7 @@ public virtual Task ExplainDataLifecycleAsync(Elas /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1609,9 +1824,21 @@ public virtual Task ExplainDataLifecycleAsync(Elas /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequest request, CancellationToken cancellationToken = default) { @@ -1621,9 +1848,21 @@ public virtual Task FlushAsync(FlushRequest request, Cancellation /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// 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) { @@ -1633,9 +1872,21 @@ public virtual Task FlushAsync(FlushRequestDescriptor< /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// 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) { @@ -1646,9 +1897,21 @@ public virtual Task FlushAsync(Elastic.Clients.Elastic /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1660,9 +1923,21 @@ public virtual Task FlushAsync(Elastic.Clients.Elastic /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// 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) { @@ -1673,9 +1948,21 @@ public virtual Task FlushAsync(CancellationToken cance /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1687,9 +1974,21 @@ public virtual Task FlushAsync(Action /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1699,9 +1998,21 @@ public virtual Task FlushAsync(FlushRequestDescriptor descriptor, /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serverless.Indices? indices, CancellationToken cancellationToken = default) { @@ -1712,9 +2023,21 @@ public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serv /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// 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) { @@ -1726,9 +2049,21 @@ public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Serv /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// 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) { @@ -1739,9 +2074,21 @@ public virtual Task FlushAsync(CancellationToken cancellationToke /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -1753,7 +2100,21 @@ public virtual Task FlushAsync(Action con /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1765,7 +2126,21 @@ public virtual Task ForcemergeAsync(ForcemergeRequest reques /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1777,7 +2152,21 @@ public virtual Task ForcemergeAsync(ForcemergeReq /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1790,7 +2179,21 @@ public virtual Task ForcemergeAsync(Elastic.Clien /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1804,7 +2207,21 @@ public virtual Task ForcemergeAsync(Elastic.Clien /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1817,7 +2234,21 @@ public virtual Task ForcemergeAsync(CancellationT /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1831,7 +2262,21 @@ public virtual Task ForcemergeAsync(Action /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1843,7 +2288,21 @@ public virtual Task ForcemergeAsync(ForcemergeRequestDescrip /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1856,7 +2315,21 @@ public virtual Task ForcemergeAsync(Elastic.Clients.Elastics /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1870,7 +2343,21 @@ public virtual Task ForcemergeAsync(Elastic.Clients.Elastics /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1883,7 +2370,21 @@ public virtual Task ForcemergeAsync(CancellationToken cancel /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3171,9 +3672,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 +3686,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); @@ -3602,8 +4103,56 @@ public virtual Task PutSettingsAsync(Elastic.Clients /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3615,8 +4164,56 @@ public virtual Task RecoveryAsync(RecoveryRequest request, Can /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3628,8 +4225,56 @@ public virtual Task RecoveryAsync(RecoveryRequestDe /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3642,8 +4287,56 @@ public virtual Task RecoveryAsync(Elastic.Clients.E /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3657,8 +4350,56 @@ public virtual Task RecoveryAsync(Elastic.Clients.E /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3671,8 +4412,56 @@ public virtual Task RecoveryAsync(CancellationToken /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3686,8 +4475,56 @@ public virtual Task RecoveryAsync(Action /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3699,8 +4536,56 @@ public virtual Task RecoveryAsync(RecoveryRequestDescriptor de /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3713,8 +4598,56 @@ public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3728,8 +4661,56 @@ public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3742,8 +4723,56 @@ public virtual Task RecoveryAsync(CancellationToken cancellati /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3923,7 +4952,8 @@ public virtual Task RefreshAsync(Action /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Resolve indices. + /// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// Learn more about this API in the Elasticsearch documentation. @@ -3936,7 +4966,8 @@ public virtual Task ResolveIndexAsync(ResolveIndexRequest /// /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Resolve indices. + /// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// Learn more about this API in the Elasticsearch documentation. @@ -3949,7 +4980,8 @@ public virtual Task ResolveIndexAsync(ResolveIndexRequestD /// /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Resolve indices. + /// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// Learn more about this API in the Elasticsearch documentation. @@ -3963,7 +4995,8 @@ public virtual Task ResolveIndexAsync(Elastic.Clients.Elas /// /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Resolve indices. + /// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// Learn more about this API in the Elasticsearch documentation. @@ -3981,7 +5014,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 +5027,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 +5040,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 +5054,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 +5069,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 +5083,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 +5098,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 +5111,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 +5125,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 +5140,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 +5154,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) { @@ -4133,8 +5166,9 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4146,8 +5180,9 @@ public virtual Task SegmentsAsync(SegmentsRequest request, Can /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4159,8 +5194,9 @@ public virtual Task SegmentsAsync(SegmentsRequestDe /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4173,8 +5209,9 @@ public virtual Task SegmentsAsync(Elastic.Clients.E /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4188,8 +5225,9 @@ public virtual Task SegmentsAsync(Elastic.Clients.E /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4202,8 +5240,9 @@ public virtual Task SegmentsAsync(CancellationToken /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4217,8 +5256,9 @@ public virtual Task SegmentsAsync(Action /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4230,8 +5270,9 @@ public virtual Task SegmentsAsync(SegmentsRequestDescriptor de /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4244,8 +5285,9 @@ public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4259,8 +5301,9 @@ public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4273,8 +5316,9 @@ public virtual Task SegmentsAsync(CancellationToken cancellati /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4498,8 +5542,20 @@ public virtual Task SimulateTemplateAsync(Action /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4511,8 +5567,20 @@ public virtual Task StatsAsync(IndicesStatsRequest request /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4524,8 +5592,20 @@ public virtual Task StatsAsync(IndicesStatsRequ /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4538,8 +5618,20 @@ public virtual Task StatsAsync(Elastic.Clients. /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4553,8 +5645,20 @@ public virtual Task StatsAsync(Elastic.Clients. /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4567,8 +5671,20 @@ public virtual Task StatsAsync(CancellationToke /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4582,8 +5698,20 @@ public virtual Task StatsAsync(Action /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4595,8 +5723,20 @@ public virtual Task StatsAsync(IndicesStatsRequestDescript /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4609,8 +5749,20 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4624,8 +5776,20 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4638,8 +5802,20 @@ public virtual Task StatsAsync(CancellationToken cancellat /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 00000000000..3699a793e74 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Inference.g.cs @@ -0,0 +1,413 @@ +// 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. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. + /// + /// 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. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. + /// + /// 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. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. + /// + /// 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. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. + /// + /// 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. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. + /// + /// 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. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. + /// + /// 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 cdd7941b0fe..31b8355f352 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 @@ -41,7 +41,8 @@ internal IngestNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -53,7 +54,8 @@ public virtual Task DeleteGeoipDatabaseAsync(Delete /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -65,7 +67,8 @@ public virtual Task DeleteGeoipDatabaseAsync /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -78,7 +81,8 @@ public virtual Task DeleteGeoipDatabaseAsync /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -92,7 +96,8 @@ public virtual Task DeleteGeoipDatabaseAsync /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -104,7 +109,8 @@ public virtual Task DeleteGeoipDatabaseAsync(Delete /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -117,7 +123,8 @@ public virtual Task DeleteGeoipDatabaseAsync(Elasti /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -131,7 +138,98 @@ public virtual Task DeleteGeoipDatabaseAsync(Elasti /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(DeleteIpLocationDatabaseRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(DeleteIpLocationDatabaseRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync, DeleteIpLocationDatabaseResponse, DeleteIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Serverless.Ids id, CancellationToken cancellationToken = default) + { + var descriptor = new DeleteIpLocationDatabaseRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequestAsync, DeleteIpLocationDatabaseResponse, DeleteIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Serverless.Ids id, Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new DeleteIpLocationDatabaseRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, DeleteIpLocationDatabaseResponse, DeleteIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(DeleteIpLocationDatabaseRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Serverless.Ids id, CancellationToken cancellationToken = default) + { + var descriptor = new DeleteIpLocationDatabaseRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Serverless.Ids id, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new DeleteIpLocationDatabaseRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -143,7 +241,8 @@ public virtual Task DeletePipelineAsync(DeletePipelineRe /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -155,7 +254,8 @@ public virtual Task DeletePipelineAsync(Delet /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -168,7 +268,8 @@ public virtual Task DeletePipelineAsync(Elast /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -182,7 +283,8 @@ public virtual Task DeletePipelineAsync(Elast /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -194,7 +296,8 @@ public virtual Task DeletePipelineAsync(DeletePipelineRe /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -207,7 +310,8 @@ public virtual Task DeletePipelineAsync(Elastic.Clients. /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -221,9 +325,10 @@ public virtual Task DeletePipelineAsync(Elastic.Clients. /// /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// Get GeoIP statistics. + /// Get download statistics for GeoIP2 databases that are 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) { @@ -233,9 +338,10 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequest reques /// /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// Get GeoIP statistics. + /// Get download statistics for GeoIP2 databases that are 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) { @@ -245,9 +351,10 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequestDescrip /// /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// Get GeoIP statistics. + /// Get download statistics for GeoIP2 databases that are 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) { @@ -258,9 +365,10 @@ public virtual Task GeoIpStatsAsync(CancellationToken cancel /// /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// Get GeoIP statistics. + /// Get download statistics for GeoIP2 databases that are 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) { @@ -272,7 +380,8 @@ public virtual Task GeoIpStatsAsync(Action /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -284,7 +393,8 @@ public virtual Task GetGeoipDatabaseAsync(GetGeoipData /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -296,7 +406,8 @@ public virtual Task GetGeoipDatabaseAsync(G /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -309,7 +420,8 @@ public virtual Task GetGeoipDatabaseAsync(E /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -323,7 +435,8 @@ public virtual Task GetGeoipDatabaseAsync(E /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -336,7 +449,8 @@ public virtual Task GetGeoipDatabaseAsync(C /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -350,7 +464,8 @@ public virtual Task GetGeoipDatabaseAsync(A /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -362,7 +477,8 @@ public virtual Task GetGeoipDatabaseAsync(GetGeoipData /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -375,7 +491,8 @@ public virtual Task GetGeoipDatabaseAsync(Elastic.Clie /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -389,7 +506,8 @@ public virtual Task GetGeoipDatabaseAsync(Elastic.Clie /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -402,7 +520,8 @@ public virtual Task GetGeoipDatabaseAsync(Cancellation /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -416,7 +535,152 @@ public virtual Task GetGeoipDatabaseAsync(Action /// - /// Returns information about one or more ingest pipelines. + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(GetIpLocationDatabaseRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(GetIpLocationDatabaseRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? id, CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequestAsync, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? id, Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequestAsync, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(GetIpLocationDatabaseRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? id, CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Serverless.Ids? id, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -429,7 +693,8 @@ public virtual Task GetPipelineAsync(GetPipelineRequest req /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -442,7 +707,8 @@ public virtual Task GetPipelineAsync(GetPipeline /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -456,7 +722,8 @@ public virtual Task GetPipelineAsync(Elastic.Cli /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -471,7 +738,8 @@ public virtual Task GetPipelineAsync(Elastic.Cli /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -485,7 +753,8 @@ public virtual Task GetPipelineAsync(Cancellatio /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -500,7 +769,8 @@ public virtual Task GetPipelineAsync(Action /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -513,7 +783,8 @@ public virtual Task GetPipelineAsync(GetPipelineRequestDesc /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -527,7 +798,8 @@ public virtual Task GetPipelineAsync(Elastic.Clients.Elasti /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -542,7 +814,8 @@ public virtual Task GetPipelineAsync(Elastic.Clients.Elasti /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -556,7 +829,8 @@ public virtual Task GetPipelineAsync(CancellationToken canc /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -571,11 +845,12 @@ public virtual Task GetPipelineAsync(Action /// - /// Extracts structured fields out of a single text field within a document. - /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// Run a grok processor. + /// Extract structured fields out of a single text field within a document. + /// You must 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) { @@ -585,11 +860,12 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque /// /// - /// Extracts structured fields out of a single text field within a document. - /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// Run a grok processor. + /// Extract structured fields out of a single text field within a document. + /// You must 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) { @@ -599,11 +875,12 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque /// /// - /// Extracts structured fields out of a single text field within a document. - /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// Run a grok processor. + /// Extract structured fields out of a single text field within a document. + /// You must 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) { @@ -614,11 +891,12 @@ public virtual Task ProcessorGrokAsync(CancellationToken /// /// - /// Extracts structured fields out of a single text field within a document. - /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// Run a grok processor. + /// Extract structured fields out of a single text field within a document. + /// You must 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) { @@ -630,7 +908,8 @@ public virtual Task ProcessorGrokAsync(Action /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -642,7 +921,8 @@ public virtual Task PutGeoipDatabaseAsync(PutGeoipData /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -654,7 +934,8 @@ public virtual Task PutGeoipDatabaseAsync(P /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -667,7 +948,8 @@ public virtual Task PutGeoipDatabaseAsync(E /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -681,7 +963,8 @@ public virtual Task PutGeoipDatabaseAsync(E /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -693,7 +976,8 @@ public virtual Task PutGeoipDatabaseAsync(PutGeoipData /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -706,7 +990,8 @@ public virtual Task PutGeoipDatabaseAsync(Elastic.Clie /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -720,10 +1005,100 @@ public virtual Task PutGeoipDatabaseAsync(Elastic.Clie /// /// - /// Creates or updates an ingest pipeline. + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(PutIpLocationDatabaseRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(PutIpLocationDatabaseRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync, PutIpLocationDatabaseResponse, PutIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) + { + var descriptor = new PutIpLocationDatabaseRequestDescriptor(configuration, id); + descriptor.BeforeRequest(); + return DoRequestAsync, PutIpLocationDatabaseResponse, PutIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Serverless.Id id, Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new PutIpLocationDatabaseRequestDescriptor(configuration, id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, PutIpLocationDatabaseResponse, PutIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(PutIpLocationDatabaseRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Serverless.Id id, CancellationToken cancellationToken = default) + { + var descriptor = new PutIpLocationDatabaseRequestDescriptor(configuration, id); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Serverless.Id id, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new PutIpLocationDatabaseRequestDescriptor(configuration, id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create or update a 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) { @@ -733,10 +1108,10 @@ public virtual Task PutPipelineAsync(PutPipelineRequest req /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -746,10 +1121,10 @@ public virtual Task PutPipelineAsync(PutPipeline /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -760,10 +1135,10 @@ public virtual Task PutPipelineAsync(Elastic.Cli /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -775,10 +1150,10 @@ public virtual Task PutPipelineAsync(Elastic.Cli /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -788,10 +1163,10 @@ public virtual Task PutPipelineAsync(PutPipelineRequestDesc /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -802,10 +1177,10 @@ public virtual Task PutPipelineAsync(Elastic.Clients.Elasti /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -817,7 +1192,9 @@ public virtual Task PutPipelineAsync(Elastic.Clients.Elasti /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -829,7 +1206,9 @@ public virtual Task SimulateAsync(SimulateRequest request, Can /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -841,7 +1220,9 @@ public virtual Task SimulateAsync(SimulateRequestDe /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -854,7 +1235,9 @@ public virtual Task SimulateAsync(Elastic.Clients.E /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -868,7 +1251,9 @@ public virtual Task SimulateAsync(Elastic.Clients.E /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -881,7 +1266,9 @@ public virtual Task SimulateAsync(CancellationToken /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -895,7 +1282,9 @@ public virtual Task SimulateAsync(Action /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -907,7 +1296,9 @@ public virtual Task SimulateAsync(SimulateRequestDescriptor de /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -920,7 +1311,9 @@ public virtual Task SimulateAsync(Elastic.Clients.Elasticsearc /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -934,7 +1327,9 @@ public virtual Task SimulateAsync(Elastic.Clients.Elasticsearc /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -947,7 +1342,9 @@ public virtual Task SimulateAsync(CancellationToken cancellati /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.License.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.License.g.cs index 9393a46cfa1..faf42c4af08 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.License.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.License.g.cs @@ -42,8 +42,11 @@ internal LicenseManagementNamespacedClient(ElasticsearchClient client) : base(cl /// /// /// Get license information. - /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + /// + /// + /// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. + /// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -56,8 +59,11 @@ public virtual Task GetAsync(GetLicenseRequest request, Canc /// /// /// Get license information. - /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + /// + /// + /// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. + /// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -70,8 +76,11 @@ public virtual Task GetAsync(GetLicenseRequestDescriptor des /// /// /// Get license information. - /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + /// + /// + /// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. + /// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -85,8 +94,11 @@ public virtual Task GetAsync(CancellationToken cancellationT /// /// /// Get license information. - /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + /// + /// + /// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. + /// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 6f5f2eb4b08..f01ac29e9c1 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) { @@ -3837,8 +3837,8 @@ public virtual Task InferTrainedModelAsync(Elastic.Cl /// /// - /// Return ML defaults and limits. - /// Returns defaults and limits used by machine learning. + /// Get machine learning information. + /// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -3856,8 +3856,8 @@ public virtual Task InfoAsync(MlInfoRequest request, Cancellatio /// /// - /// Return ML defaults and limits. - /// Returns defaults and limits used by machine learning. + /// Get machine learning information. + /// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -3875,8 +3875,8 @@ public virtual Task InfoAsync(MlInfoRequestDescriptor descriptor /// /// - /// Return ML defaults and limits. - /// Returns defaults and limits used by machine learning. + /// Get machine learning information. + /// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -3895,8 +3895,8 @@ public virtual Task InfoAsync(CancellationToken cancellationToke /// /// - /// Return ML defaults and limits. - /// Returns defaults and limits used by machine learning. + /// Get machine learning information. + /// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -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) { @@ -4604,35 +4639,6 @@ public virtual Task PutJobAsync(PutJobRequestDescript return DoRequestAsync, PutJobResponse, PutJobRequestParameters>(descriptor, cancellationToken); } - /// - /// - /// Create an anomaly detection job. - /// If you include a datafeed_config, you must have read index privileges on the source index. - /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) - { - var descriptor = new PutJobRequestDescriptor(jobId); - descriptor.BeforeRequest(); - return DoRequestAsync, PutJobResponse, PutJobRequestParameters>(descriptor, cancellationToken); - } - - /// - /// - /// Create an anomaly detection job. - /// If you include a datafeed_config, you must have read index privileges on the source index. - /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) - { - var descriptor = new PutJobRequestDescriptor(jobId); - configureRequest?.Invoke(descriptor); - descriptor.BeforeRequest(); - return DoRequestAsync, PutJobResponse, PutJobRequestParameters>(descriptor, cancellationToken); - } - /// /// /// Create an anomaly detection job. @@ -4646,35 +4652,6 @@ public virtual Task PutJobAsync(PutJobRequestDescriptor descript return DoRequestAsync(descriptor, cancellationToken); } - /// - /// - /// Create an anomaly detection job. - /// If you include a datafeed_config, you must have read index privileges on the source index. - /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, CancellationToken cancellationToken = default) - { - var descriptor = new PutJobRequestDescriptor(jobId); - descriptor.BeforeRequest(); - return DoRequestAsync(descriptor, cancellationToken); - } - - /// - /// - /// Create an anomaly detection job. - /// If you include a datafeed_config, you must have read index privileges on the source index. - /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Serverless.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) - { - var descriptor = new PutJobRequestDescriptor(jobId); - configureRequest?.Invoke(descriptor); - descriptor.BeforeRequest(); - return DoRequestAsync(descriptor, cancellationToken); - } - /// /// /// Create a trained model. @@ -6387,7 +6364,7 @@ public virtual Task ValidateAsync(Action /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6399,7 +6376,7 @@ public virtual Task ValidateDetectorAsync(ValidateDete /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6411,7 +6388,7 @@ public virtual Task ValidateDetectorAsync(V /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6424,7 +6401,7 @@ public virtual Task ValidateDetectorAsync(E /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6438,7 +6415,7 @@ public virtual Task ValidateDetectorAsync(E /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6450,7 +6427,7 @@ public virtual Task ValidateDetectorAsync(ValidateDete /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6463,7 +6440,7 @@ public virtual Task ValidateDetectorAsync(Elastic.Clie /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 545ba98ec16..3a3cb7d2560 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 @@ -41,10 +41,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// 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) { @@ -54,10 +55,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// 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) { @@ -67,10 +69,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// 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) { @@ -81,10 +84,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// 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) { @@ -96,10 +100,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// 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) { @@ -110,10 +115,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// 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) { @@ -125,9 +131,10 @@ public virtual Task HotThreadsAsync(Action /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// 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) { @@ -137,9 +144,10 @@ public virtual Task InfoAsync(NodesInfoRequest request, Cance /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// 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) { @@ -149,9 +157,10 @@ public virtual Task InfoAsync(NodesInfoRequestDescriptor desc /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// 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) { @@ -162,9 +171,10 @@ public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.S /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// 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) { @@ -176,9 +186,10 @@ public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.S /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// 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) { @@ -189,9 +200,10 @@ public virtual Task InfoAsync(CancellationToken cancellationT /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// 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) { @@ -203,9 +215,11 @@ public virtual Task InfoAsync(Action /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -215,9 +229,11 @@ public virtual Task StatsAsync(NodesStatsRequest request, Ca /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -227,9 +243,11 @@ public virtual Task StatsAsync(NodesStatsRequestD /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -240,9 +258,11 @@ public virtual Task StatsAsync(Elastic.Clients.El /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -254,9 +274,11 @@ public virtual Task StatsAsync(Elastic.Clients.El /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -267,9 +289,11 @@ public virtual Task StatsAsync(CancellationToken /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -281,9 +305,11 @@ public virtual Task StatsAsync(Action /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -293,9 +319,11 @@ public virtual Task StatsAsync(NodesStatsRequestDescriptor d /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -306,9 +334,11 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsearch /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -320,9 +350,11 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsearch /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -333,9 +365,11 @@ public virtual Task StatsAsync(CancellationToken cancellatio /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -347,9 +381,9 @@ public virtual Task StatsAsync(Action /// - /// Returns information on the usage of features. + /// Get feature usage information. /// - /// 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) { @@ -359,9 +393,9 @@ public virtual Task UsageAsync(NodesUsageRequest request, Ca /// /// - /// Returns information on the usage of features. + /// Get feature usage information. /// - /// 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) { @@ -371,9 +405,9 @@ public virtual Task UsageAsync(NodesUsageRequestDescriptor d /// /// - /// Returns information on the usage of features. + /// Get feature usage information. /// - /// 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) { @@ -384,9 +418,9 @@ public virtual Task UsageAsync(Elastic.Clients.Elasticsearch /// /// - /// Returns information on the usage of features. + /// Get feature usage information. /// - /// 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) { @@ -398,9 +432,9 @@ public virtual Task UsageAsync(Elastic.Clients.Elasticsearch /// /// - /// Returns information on the usage of features. + /// Get feature usage information. /// - /// 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) { @@ -411,9 +445,9 @@ public virtual Task UsageAsync(CancellationToken cancellatio /// /// - /// Returns information on the usage of features. + /// Get feature usage information. /// - /// 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 9adeb57e856..4fc75b8a584 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 @@ -41,7 +41,8 @@ internal QueryRulesNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Deletes a query rule within a query ruleset. + /// Delete a query rule. + /// Delete a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -53,7 +54,8 @@ public virtual Task DeleteRuleAsync(DeleteRuleRequest reques /// /// - /// Deletes a query rule within a query ruleset. + /// Delete a query rule. + /// Delete a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -65,7 +67,8 @@ public virtual Task DeleteRuleAsync(DeleteRuleRequestDescrip /// /// - /// Deletes a query rule within a query ruleset. + /// Delete a query rule. + /// Delete a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -78,7 +81,8 @@ public virtual Task DeleteRuleAsync(Elastic.Clients.Elastics /// /// - /// Deletes a query rule within a query ruleset. + /// Delete a query rule. + /// Delete a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -92,7 +96,7 @@ public virtual Task DeleteRuleAsync(Elastic.Clients.Elastics /// /// - /// Deletes a query ruleset. + /// Delete a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -104,7 +108,7 @@ public virtual Task DeleteRulesetAsync(DeleteRulesetReque /// /// - /// Deletes a query ruleset. + /// Delete a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -116,7 +120,7 @@ public virtual Task DeleteRulesetAsync(DeleteRulesetReque /// /// - /// Deletes a query ruleset. + /// Delete a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -129,7 +133,7 @@ public virtual Task DeleteRulesetAsync(Elastic.Clients.El /// /// - /// Deletes a query ruleset. + /// Delete a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -143,7 +147,8 @@ public virtual Task DeleteRulesetAsync(Elastic.Clients.El /// /// - /// Returns the details about a query rule within a query ruleset + /// Get a query rule. + /// Get details about a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -155,7 +160,8 @@ public virtual Task GetRuleAsync(GetRuleRequest request, Cancel /// /// - /// Returns the details about a query rule within a query ruleset + /// Get a query rule. + /// Get details about a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -167,7 +173,8 @@ public virtual Task GetRuleAsync(GetRuleRequestDescriptor descr /// /// - /// Returns the details about a query rule within a query ruleset + /// Get a query rule. + /// Get details about a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -180,7 +187,8 @@ public virtual Task GetRuleAsync(Elastic.Clients.Elasticsearch. /// /// - /// Returns the details about a query rule within a query ruleset + /// Get a query rule. + /// Get details about a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -194,7 +202,8 @@ public virtual Task GetRuleAsync(Elastic.Clients.Elasticsearch. /// /// - /// Returns the details about a query ruleset + /// Get a query ruleset. + /// Get details about a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -206,7 +215,8 @@ public virtual Task GetRulesetAsync(GetRulesetRequest reques /// /// - /// Returns the details about a query ruleset + /// Get a query ruleset. + /// Get details about a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -218,7 +228,8 @@ public virtual Task GetRulesetAsync(GetRulesetRequestDescrip /// /// - /// Returns the details about a query ruleset + /// Get a query ruleset. + /// Get details about a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -231,7 +242,8 @@ public virtual Task GetRulesetAsync(Elastic.Clients.Elastics /// /// - /// Returns the details about a query ruleset + /// Get a query ruleset. + /// Get details about a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -245,7 +257,8 @@ public virtual Task GetRulesetAsync(Elastic.Clients.Elastics /// /// - /// Returns summarized information about existing query rulesets. + /// Get all query rulesets. + /// Get summarized information about the query rulesets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -257,7 +270,8 @@ public virtual Task ListRulesetsAsync(ListRulesetsRequest /// /// - /// Returns summarized information about existing query rulesets. + /// Get all query rulesets. + /// Get summarized information about the query rulesets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -269,7 +283,8 @@ public virtual Task ListRulesetsAsync(ListRulesetsRequestD /// /// - /// Returns summarized information about existing query rulesets. + /// Get all query rulesets. + /// Get summarized information about the query rulesets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -282,7 +297,8 @@ public virtual Task ListRulesetsAsync(CancellationToken ca /// /// - /// Returns summarized information about existing query rulesets. + /// Get all query rulesets. + /// Get summarized information about the query rulesets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -296,7 +312,8 @@ public virtual Task ListRulesetsAsync(Action /// - /// Creates or updates a query rule within a query ruleset. + /// Create or update a query rule. + /// Create or update a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -308,7 +325,8 @@ public virtual Task PutRuleAsync(PutRuleRequest request, Cancel /// /// - /// Creates or updates a query rule within a query ruleset. + /// Create or update a query rule. + /// Create or update a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -320,7 +338,8 @@ public virtual Task PutRuleAsync(PutRuleRequestDescriptor descr /// /// - /// Creates or updates a query rule within a query ruleset. + /// Create or update a query rule. + /// Create or update a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -333,7 +352,8 @@ public virtual Task PutRuleAsync(Elastic.Clients.Elasticsearch. /// /// - /// Creates or updates a query rule within a query ruleset. + /// Create or update a query rule. + /// Create or update a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -347,7 +367,7 @@ public virtual Task PutRuleAsync(Elastic.Clients.Elasticsearch. /// /// - /// Creates or updates a query ruleset. + /// Create or update a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -359,7 +379,7 @@ public virtual Task PutRulesetAsync(PutRulesetRequest reques /// /// - /// Creates or updates a query ruleset. + /// Create or update a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -371,7 +391,7 @@ public virtual Task PutRulesetAsync(PutRulesetRequestDescrip /// /// - /// Creates or updates a query ruleset. + /// Create or update a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -384,7 +404,7 @@ public virtual Task PutRulesetAsync(Elastic.Clients.Elastics /// /// - /// Creates or updates a query ruleset. + /// Create or update a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -395,4 +415,59 @@ public virtual Task PutRulesetAsync(Elastic.Clients.Elastics descriptor.BeforeRequest(); return DoRequestAsync(descriptor, cancellationToken); } + + /// + /// + /// Test a query ruleset. + /// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task TestAsync(TestRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Test a query ruleset. + /// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task TestAsync(TestRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Test a query ruleset. + /// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. + /// + /// 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); + } + + /// + /// + /// Test a query ruleset. + /// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. + /// + /// 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 67e3c6f6217..3b630a6b91e 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.Slm.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Slm.g.cs index 7103898eb08..fd809d45b05 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Slm.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Slm.g.cs @@ -41,7 +41,9 @@ internal SnapshotLifecycleManagementNamespacedClient(ElasticsearchClient client) /// /// - /// Deletes an existing snapshot lifecycle policy. + /// Delete a policy. + /// Delete a snapshot lifecycle policy definition. + /// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -53,7 +55,9 @@ public virtual Task DeleteLifecycleAsync(DeleteLifecycl /// /// - /// Deletes an existing snapshot lifecycle policy. + /// Delete a policy. + /// Delete a snapshot lifecycle policy definition. + /// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -65,7 +69,9 @@ public virtual Task DeleteLifecycleAsync(DeleteLifecycl /// /// - /// Deletes an existing snapshot lifecycle policy. + /// Delete a policy. + /// Delete a snapshot lifecycle policy definition. + /// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -78,7 +84,9 @@ public virtual Task DeleteLifecycleAsync(Elastic.Client /// /// - /// Deletes an existing snapshot lifecycle policy. + /// Delete a policy. + /// Delete a snapshot lifecycle policy definition. + /// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -92,7 +100,9 @@ public virtual Task DeleteLifecycleAsync(Elastic.Client /// /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// Run a policy. + /// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + /// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -104,7 +114,9 @@ public virtual Task ExecuteLifecycleAsync(ExecuteLifec /// /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// Run a policy. + /// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + /// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -116,7 +128,9 @@ public virtual Task ExecuteLifecycleAsync(ExecuteLifec /// /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// Run a policy. + /// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + /// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -129,7 +143,9 @@ public virtual Task ExecuteLifecycleAsync(Elastic.Clie /// /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// Run a policy. + /// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + /// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -143,7 +159,9 @@ public virtual Task ExecuteLifecycleAsync(Elastic.Clie /// /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// Run a retention policy. + /// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + /// The retention policy is normally applied according to its schedule. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -155,7 +173,9 @@ public virtual Task ExecuteRetentionAsync(ExecuteReten /// /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// Run a retention policy. + /// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + /// The retention policy is normally applied according to its schedule. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -167,7 +187,9 @@ public virtual Task ExecuteRetentionAsync(ExecuteReten /// /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// Run a retention policy. + /// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + /// The retention policy is normally applied according to its schedule. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -180,7 +202,9 @@ public virtual Task ExecuteRetentionAsync(Cancellation /// /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// Run a retention policy. + /// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + /// The retention policy is normally applied according to its schedule. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -194,7 +218,8 @@ public virtual Task ExecuteRetentionAsync(Action /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -206,7 +231,8 @@ public virtual Task GetLifecycleAsync(GetLifecycleRequest /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -218,7 +244,8 @@ public virtual Task GetLifecycleAsync(GetLifecycleRequestD /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -231,7 +258,8 @@ public virtual Task GetLifecycleAsync(Elastic.Clients.Elas /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -245,7 +273,8 @@ public virtual Task GetLifecycleAsync(Elastic.Clients.Elas /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -258,7 +287,8 @@ public virtual Task GetLifecycleAsync(CancellationToken ca /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -272,7 +302,8 @@ public virtual Task GetLifecycleAsync(Action /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// Get snapshot lifecycle management statistics. + /// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -284,7 +315,8 @@ public virtual Task GetStatsAsync(GetStatsRequest request, Can /// /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// Get snapshot lifecycle management statistics. + /// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -296,7 +328,8 @@ public virtual Task GetStatsAsync(GetStatsRequestDescriptor de /// /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// Get snapshot lifecycle management statistics. + /// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -309,7 +342,8 @@ public virtual Task GetStatsAsync(CancellationToken cancellati /// /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// Get snapshot lifecycle management statistics. + /// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -323,7 +357,7 @@ public virtual Task GetStatsAsync(Action /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// Get the snapshot lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -335,7 +369,7 @@ public virtual Task GetStatusAsync(GetSlmStatusRequest req /// /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// Get the snapshot lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -347,7 +381,7 @@ public virtual Task GetStatusAsync(GetSlmStatusRequestDesc /// /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// Get the snapshot lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -360,7 +394,7 @@ public virtual Task GetStatusAsync(CancellationToken cance /// /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// Get the snapshot lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -374,7 +408,10 @@ public virtual Task GetStatusAsync(Action /// - /// Creates or updates a snapshot lifecycle policy. + /// Create or update a policy. + /// Create or update a snapshot lifecycle policy. + /// If the policy already exists, this request increments the policy version. + /// Only the latest version of a policy is stored. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -386,7 +423,10 @@ public virtual Task PutLifecycleAsync(PutLifecycleRequest /// /// - /// Creates or updates a snapshot lifecycle policy. + /// Create or update a policy. + /// Create or update a snapshot lifecycle policy. + /// If the policy already exists, this request increments the policy version. + /// Only the latest version of a policy is stored. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -398,7 +438,10 @@ public virtual Task PutLifecycleAsync(PutLifecycleRequestD /// /// - /// Creates or updates a snapshot lifecycle policy. + /// Create or update a policy. + /// Create or update a snapshot lifecycle policy. + /// If the policy already exists, this request increments the policy version. + /// Only the latest version of a policy is stored. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -411,7 +454,10 @@ public virtual Task PutLifecycleAsync(Elastic.Clients.Elas /// /// - /// Creates or updates a snapshot lifecycle policy. + /// Create or update a policy. + /// Create or update a snapshot lifecycle policy. + /// If the policy already exists, this request increments the policy version. + /// Only the latest version of a policy is stored. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -425,7 +471,9 @@ public virtual Task PutLifecycleAsync(Elastic.Clients.Elas /// /// - /// Turns on snapshot lifecycle management (SLM). + /// Start snapshot lifecycle management. + /// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + /// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -437,7 +485,9 @@ public virtual Task StartAsync(StartSlmRequest request, Cancel /// /// - /// Turns on snapshot lifecycle management (SLM). + /// Start snapshot lifecycle management. + /// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + /// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -449,7 +499,9 @@ public virtual Task StartAsync(StartSlmRequestDescriptor descr /// /// - /// Turns on snapshot lifecycle management (SLM). + /// Start snapshot lifecycle management. + /// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + /// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -462,7 +514,9 @@ public virtual Task StartAsync(CancellationToken cancellationT /// /// - /// Turns on snapshot lifecycle management (SLM). + /// Start snapshot lifecycle management. + /// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + /// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -476,7 +530,15 @@ public virtual Task StartAsync(Action /// - /// Turns off snapshot lifecycle management (SLM). + /// Stop snapshot lifecycle management. + /// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + /// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + /// Stopping SLM does not stop any snapshots that are in progress. + /// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + /// + /// + /// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + /// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -488,7 +550,15 @@ public virtual Task StopAsync(StopSlmRequest request, Cancellat /// /// - /// Turns off snapshot lifecycle management (SLM). + /// Stop snapshot lifecycle management. + /// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + /// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + /// Stopping SLM does not stop any snapshots that are in progress. + /// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + /// + /// + /// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + /// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -500,7 +570,15 @@ public virtual Task StopAsync(StopSlmRequestDescriptor descript /// /// - /// Turns off snapshot lifecycle management (SLM). + /// Stop snapshot lifecycle management. + /// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + /// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + /// Stopping SLM does not stop any snapshots that are in progress. + /// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + /// + /// + /// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + /// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -513,7 +591,15 @@ public virtual Task StopAsync(CancellationToken cancellationTok /// /// - /// Turns off snapshot lifecycle management (SLM). + /// Stop snapshot lifecycle management. + /// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + /// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + /// Stopping SLM does not stop any snapshots that are in progress. + /// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + /// + /// + /// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + /// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Snapshot.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Snapshot.g.cs index 1993aa63876..82dcdb9e99c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Snapshot.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Snapshot.g.cs @@ -41,7 +41,8 @@ internal SnapshotNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// Clean up the snapshot repository. + /// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -53,7 +54,8 @@ public virtual Task CleanupRepositoryAsync(CleanupRep /// /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// Clean up the snapshot repository. + /// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -65,7 +67,8 @@ public virtual Task CleanupRepositoryAsync(CleanupRep /// /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// Clean up the snapshot repository. + /// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -78,7 +81,8 @@ public virtual Task CleanupRepositoryAsync(Elastic.Cl /// /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// Clean up the snapshot repository. + /// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -92,7 +96,8 @@ public virtual Task CleanupRepositoryAsync(Elastic.Cl /// /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// Clone a snapshot. + /// Clone part of all of a snapshot into another snapshot in the same repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -104,7 +109,8 @@ public virtual Task CloneAsync(CloneSnapshotRequest reque /// /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// Clone a snapshot. + /// Clone part of all of a snapshot into another snapshot in the same repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -116,7 +122,8 @@ public virtual Task CloneAsync(CloneSnapshotRequestDescri /// /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// Clone a snapshot. + /// Clone part of all of a snapshot into another snapshot in the same repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -129,7 +136,8 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsea /// /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// Clone a snapshot. + /// Clone part of all of a snapshot into another snapshot in the same repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -143,7 +151,8 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsea /// /// - /// Creates a snapshot in a repository. + /// Create a snapshot. + /// Take a snapshot of a cluster or of data streams and indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -155,7 +164,8 @@ public virtual Task CreateAsync(CreateSnapshotRequest re /// /// - /// Creates a snapshot in a repository. + /// Create a snapshot. + /// Take a snapshot of a cluster or of data streams and indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -167,7 +177,8 @@ public virtual Task CreateAsync(CreateSnapshotRequestDes /// /// - /// Creates a snapshot in a repository. + /// Create a snapshot. + /// Take a snapshot of a cluster or of data streams and indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -180,7 +191,8 @@ public virtual Task CreateAsync(Elastic.Clients.Elastics /// /// - /// Creates a snapshot in a repository. + /// Create a snapshot. + /// Take a snapshot of a cluster or of data streams and indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -194,7 +206,10 @@ public virtual Task CreateAsync(Elastic.Clients.Elastics /// /// - /// Creates a repository. + /// Create or update a snapshot repository. + /// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + /// To register a snapshot repository, the cluster's global metadata must be writeable. + /// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -206,7 +221,10 @@ public virtual Task CreateRepositoryAsync(CreateReposi /// /// - /// Creates a repository. + /// Create or update a snapshot repository. + /// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + /// To register a snapshot repository, the cluster's global metadata must be writeable. + /// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -218,7 +236,10 @@ public virtual Task CreateRepositoryAsync(CreateReposi /// /// - /// Creates a repository. + /// Create or update a snapshot repository. + /// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + /// To register a snapshot repository, the cluster's global metadata must be writeable. + /// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -231,7 +252,10 @@ public virtual Task CreateRepositoryAsync(Elastic.Clie /// /// - /// Creates a repository. + /// Create or update a snapshot repository. + /// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + /// To register a snapshot repository, the cluster's global metadata must be writeable. + /// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -245,7 +269,7 @@ public virtual Task CreateRepositoryAsync(Elastic.Clie /// /// - /// Deletes one or more snapshots. + /// Delete snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -257,7 +281,7 @@ public virtual Task DeleteAsync(DeleteSnapshotRequest re /// /// - /// Deletes one or more snapshots. + /// Delete snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -269,7 +293,7 @@ public virtual Task DeleteAsync(DeleteSnapshotRequestDes /// /// - /// Deletes one or more snapshots. + /// Delete snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -282,7 +306,7 @@ public virtual Task DeleteAsync(Elastic.Clients.Elastics /// /// - /// Deletes one or more snapshots. + /// Delete snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -296,7 +320,9 @@ public virtual Task DeleteAsync(Elastic.Clients.Elastics /// /// - /// Deletes a repository. + /// Delete snapshot repositories. + /// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + /// The snapshots themselves are left untouched and in place. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -308,7 +334,9 @@ public virtual Task DeleteRepositoryAsync(DeleteReposi /// /// - /// Deletes a repository. + /// Delete snapshot repositories. + /// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + /// The snapshots themselves are left untouched and in place. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -320,7 +348,9 @@ public virtual Task DeleteRepositoryAsync(DeleteReposi /// /// - /// Deletes a repository. + /// Delete snapshot repositories. + /// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + /// The snapshots themselves are left untouched and in place. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -333,7 +363,9 @@ public virtual Task DeleteRepositoryAsync(Elastic.Clie /// /// - /// Deletes a repository. + /// Delete snapshot repositories. + /// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + /// The snapshots themselves are left untouched and in place. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -347,7 +379,7 @@ public virtual Task DeleteRepositoryAsync(Elastic.Clie /// /// - /// Returns information about a snapshot. + /// Get snapshot information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -359,7 +391,7 @@ public virtual Task GetAsync(GetSnapshotRequest request, Ca /// /// - /// Returns information about a snapshot. + /// Get snapshot information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -371,7 +403,7 @@ public virtual Task GetAsync(GetSnapshotRequestDescriptor d /// /// - /// Returns information about a snapshot. + /// Get snapshot information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -384,7 +416,7 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch. /// /// - /// Returns information about a snapshot. + /// Get snapshot information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -398,7 +430,7 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch. /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -410,7 +442,7 @@ public virtual Task GetRepositoryAsync(GetRepositoryReque /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -422,7 +454,7 @@ public virtual Task GetRepositoryAsync(GetRepositoryReque /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -435,7 +467,7 @@ public virtual Task GetRepositoryAsync(Elastic.Clients.El /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -449,7 +481,7 @@ public virtual Task GetRepositoryAsync(Elastic.Clients.El /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -462,7 +494,7 @@ public virtual Task GetRepositoryAsync(CancellationToken /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -476,7 +508,28 @@ public virtual Task GetRepositoryAsync(Action /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -488,7 +541,28 @@ public virtual Task RestoreAsync(RestoreRequest request, Cancel /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -500,7 +574,28 @@ public virtual Task RestoreAsync(RestoreRequestDescr /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -513,7 +608,28 @@ public virtual Task RestoreAsync(Elastic.Clients.Ela /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -527,7 +643,28 @@ public virtual Task RestoreAsync(Elastic.Clients.Ela /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -539,7 +676,28 @@ public virtual Task RestoreAsync(RestoreRequestDescriptor descr /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -552,7 +710,28 @@ public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch. /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -566,7 +745,19 @@ public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch. /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -578,7 +769,19 @@ public virtual Task StatusAsync(SnapshotStatusRequest re /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -590,7 +793,19 @@ public virtual Task StatusAsync(SnapshotStatusRequestDes /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -603,7 +818,19 @@ public virtual Task StatusAsync(Elastic.Clients.Elastics /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -617,7 +844,19 @@ public virtual Task StatusAsync(Elastic.Clients.Elastics /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -630,7 +869,19 @@ public virtual Task StatusAsync(CancellationToken cancel /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -644,7 +895,8 @@ public virtual Task StatusAsync(Action /// - /// Verifies a repository. + /// Verify a snapshot repository. + /// Check for common misconfigurations in a snapshot repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -656,7 +908,8 @@ public virtual Task VerifyRepositoryAsync(VerifyReposi /// /// - /// Verifies a repository. + /// Verify a snapshot repository. + /// Check for common misconfigurations in a snapshot repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -668,7 +921,8 @@ public virtual Task VerifyRepositoryAsync(VerifyReposi /// /// - /// Verifies a repository. + /// Verify a snapshot repository. + /// Check for common misconfigurations in a snapshot repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -681,7 +935,8 @@ public virtual Task VerifyRepositoryAsync(Elastic.Clie /// /// - /// Verifies a repository. + /// Verify a snapshot repository. + /// Check for common misconfigurations in a snapshot repository. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Sql.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Sql.g.cs index 4fc0ea883d9..89fe8e9894a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Sql.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Sql.g.cs @@ -41,7 +41,7 @@ internal SqlNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Clears the SQL cursor + /// Clear an SQL search cursor. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -53,7 +53,7 @@ public virtual Task ClearCursorAsync(ClearCursorRequest req /// /// - /// Clears the SQL cursor + /// Clear an SQL search cursor. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -65,7 +65,7 @@ public virtual Task ClearCursorAsync(ClearCursorRequestDesc /// /// - /// Clears the SQL cursor + /// Clear an SQL search cursor. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -78,7 +78,7 @@ public virtual Task ClearCursorAsync(CancellationToken canc /// /// - /// Clears the SQL cursor + /// Clear an SQL search cursor. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -92,7 +92,9 @@ public virtual Task ClearCursorAsync(Action /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -104,7 +106,9 @@ public virtual Task DeleteAsyncAsync(DeleteAsyncRequest req /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -116,7 +120,9 @@ public virtual Task DeleteAsyncAsync(DeleteAsync /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -129,7 +135,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Cli /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -143,7 +151,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Cli /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -155,7 +165,9 @@ public virtual Task DeleteAsyncAsync(DeleteAsyncRequestDesc /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -168,7 +180,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasti /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -182,7 +196,8 @@ public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasti /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -194,7 +209,8 @@ public virtual Task GetAsyncAsync(GetAsyncRequest request, Can /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -206,7 +222,8 @@ public virtual Task GetAsyncAsync(GetAsyncRequestDe /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -219,7 +236,8 @@ public virtual Task GetAsyncAsync(Elastic.Clients.E /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -233,7 +251,8 @@ public virtual Task GetAsyncAsync(Elastic.Clients.E /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -245,7 +264,8 @@ public virtual Task GetAsyncAsync(GetAsyncRequestDescriptor de /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -258,7 +278,8 @@ public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -272,7 +293,8 @@ public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -284,7 +306,8 @@ public virtual Task GetAsyncStatusAsync(GetAsyncStatusRe /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -296,7 +319,8 @@ public virtual Task GetAsyncStatusAsync(GetAs /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -309,7 +333,8 @@ public virtual Task GetAsyncStatusAsync(Elast /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -323,7 +348,8 @@ public virtual Task GetAsyncStatusAsync(Elast /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -335,7 +361,8 @@ public virtual Task GetAsyncStatusAsync(GetAsyncStatusRe /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -348,7 +375,8 @@ public virtual Task GetAsyncStatusAsync(Elastic.Clients. /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -362,7 +390,8 @@ public virtual Task GetAsyncStatusAsync(Elastic.Clients. /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -374,7 +403,8 @@ public virtual Task QueryAsync(QueryRequest request, Cancellation /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -386,7 +416,8 @@ public virtual Task QueryAsync(QueryRequestDescriptor< /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -399,7 +430,8 @@ public virtual Task QueryAsync(CancellationToken cance /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -413,7 +445,8 @@ public virtual Task QueryAsync(Action /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -425,7 +458,8 @@ public virtual Task QueryAsync(QueryRequestDescriptor descriptor, /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -438,7 +472,8 @@ public virtual Task QueryAsync(CancellationToken cancellationToke /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -452,7 +487,8 @@ public virtual Task QueryAsync(Action con /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -464,7 +500,8 @@ public virtual Task TranslateAsync(TranslateRequest request, /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -476,7 +513,8 @@ public virtual Task TranslateAsync(TranslateReques /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -489,7 +527,8 @@ public virtual Task TranslateAsync(CancellationTok /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -503,7 +542,8 @@ public virtual Task TranslateAsync(Action /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -515,7 +555,8 @@ public virtual Task TranslateAsync(TranslateRequestDescriptor /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -528,7 +569,8 @@ public virtual Task TranslateAsync(CancellationToken cancella /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Synonyms.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Synonyms.g.cs index 2682447ffa6..8be64bd2bd9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Synonyms.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Synonyms.g.cs @@ -41,7 +41,7 @@ internal SynonymsNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -53,7 +53,7 @@ public virtual Task DeleteSynonymAsync(DeleteSynonymReque /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -65,7 +65,7 @@ public virtual Task DeleteSynonymAsync(DeleteS /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -78,7 +78,7 @@ public virtual Task DeleteSynonymAsync(Elastic /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -92,7 +92,7 @@ public virtual Task DeleteSynonymAsync(Elastic /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -104,7 +104,7 @@ public virtual Task DeleteSynonymAsync(DeleteSynonymReque /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -117,7 +117,7 @@ public virtual Task DeleteSynonymAsync(Elastic.Clients.El /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -131,7 +131,8 @@ public virtual Task DeleteSynonymAsync(Elastic.Clients.El /// /// - /// Deletes a synonym rule in a synonym set + /// Delete a synonym rule. + /// Delete a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -143,7 +144,8 @@ public virtual Task DeleteSynonymRuleAsync(DeleteSyno /// /// - /// Deletes a synonym rule in a synonym set + /// Delete a synonym rule. + /// Delete a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -155,7 +157,8 @@ public virtual Task DeleteSynonymRuleAsync(DeleteSyno /// /// - /// Deletes a synonym rule in a synonym set + /// Delete a synonym rule. + /// Delete a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -168,7 +171,8 @@ public virtual Task DeleteSynonymRuleAsync(Elastic.Cl /// /// - /// Deletes a synonym rule in a synonym set + /// Delete a synonym rule. + /// Delete a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -182,7 +186,7 @@ public virtual Task DeleteSynonymRuleAsync(Elastic.Cl /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -194,7 +198,7 @@ public virtual Task GetSynonymAsync(GetSynonymRequest reques /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -206,7 +210,7 @@ public virtual Task GetSynonymAsync(GetSynonymReq /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -219,7 +223,7 @@ public virtual Task GetSynonymAsync(Elastic.Clien /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -233,7 +237,7 @@ public virtual Task GetSynonymAsync(Elastic.Clien /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -245,7 +249,7 @@ public virtual Task GetSynonymAsync(GetSynonymRequestDescrip /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -258,7 +262,7 @@ public virtual Task GetSynonymAsync(Elastic.Clients.Elastics /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -272,7 +276,8 @@ public virtual Task GetSynonymAsync(Elastic.Clients.Elastics /// /// - /// Retrieves a synonym rule from a synonym set + /// Get a synonym rule. + /// Get a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -284,7 +289,8 @@ public virtual Task GetSynonymRuleAsync(GetSynonymRuleRe /// /// - /// Retrieves a synonym rule from a synonym set + /// Get a synonym rule. + /// Get a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -296,7 +302,8 @@ public virtual Task GetSynonymRuleAsync(GetSynonymRuleRe /// /// - /// Retrieves a synonym rule from a synonym set + /// Get a synonym rule. + /// Get a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -309,7 +316,8 @@ public virtual Task GetSynonymRuleAsync(Elastic.Clients. /// /// - /// Retrieves a synonym rule from a synonym set + /// Get a synonym rule. + /// Get a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -323,7 +331,8 @@ public virtual Task GetSynonymRuleAsync(Elastic.Clients. /// /// - /// Retrieves a summary of all defined synonym sets + /// Get all synonym sets. + /// Get a summary of all defined synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -335,7 +344,8 @@ public virtual Task GetSynonymsSetsAsync(GetSynonymsSet /// /// - /// Retrieves a summary of all defined synonym sets + /// Get all synonym sets. + /// Get a summary of all defined synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -347,7 +357,8 @@ public virtual Task GetSynonymsSetsAsync(GetSynonymsSet /// /// - /// Retrieves a summary of all defined synonym sets + /// Get all synonym sets. + /// Get a summary of all defined synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -360,7 +371,8 @@ public virtual Task GetSynonymsSetsAsync(CancellationTo /// /// - /// Retrieves a summary of all defined synonym sets + /// Get all synonym sets. + /// Get a summary of all defined synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -374,7 +386,9 @@ public virtual Task GetSynonymsSetsAsync(Action /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -386,7 +400,9 @@ public virtual Task PutSynonymAsync(PutSynonymRequest reques /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -398,7 +414,9 @@ public virtual Task PutSynonymAsync(PutSynonymReq /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -411,7 +429,9 @@ public virtual Task PutSynonymAsync(Elastic.Clien /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -425,7 +445,9 @@ public virtual Task PutSynonymAsync(Elastic.Clien /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -437,7 +459,9 @@ public virtual Task PutSynonymAsync(PutSynonymRequestDescrip /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -450,7 +474,9 @@ public virtual Task PutSynonymAsync(Elastic.Clients.Elastics /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -464,7 +490,8 @@ public virtual Task PutSynonymAsync(Elastic.Clients.Elastics /// /// - /// Creates or updates a synonym rule in a synonym set + /// Create or update a synonym rule. + /// Create or update a synonym rule in a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -476,7 +503,8 @@ public virtual Task PutSynonymRuleAsync(PutSynonymRuleRe /// /// - /// Creates or updates a synonym rule in a synonym set + /// Create or update a synonym rule. + /// Create or update a synonym rule in a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -488,7 +516,8 @@ public virtual Task PutSynonymRuleAsync(PutSynonymRuleRe /// /// - /// Creates or updates a synonym rule in a synonym set + /// Create or update a synonym rule. + /// Create or update a synonym rule in a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -501,7 +530,8 @@ public virtual Task PutSynonymRuleAsync(Elastic.Clients. /// /// - /// Creates or updates a synonym rule in a synonym set + /// Create or update a synonym rule. + /// Create or update a synonym rule in a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.TextStructure.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.TextStructure.g.cs index 6244a645f91..d7e72514032 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.TextStructure.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.TextStructure.g.cs @@ -41,7 +41,9 @@ internal TextStructureNamespacedClient(ElasticsearchClient client) : base(client /// /// - /// Tests a Grok pattern on some text. + /// Test a Grok pattern. + /// Test a Grok pattern on one or more lines of text. + /// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -53,7 +55,9 @@ public virtual Task TestGrokPatternAsync(TestGrokPatter /// /// - /// Tests a Grok pattern on some text. + /// Test a Grok pattern. + /// Test a Grok pattern on one or more lines of text. + /// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -65,7 +69,9 @@ public virtual Task TestGrokPatternAsync(TestGrokPatter /// /// - /// Tests a Grok pattern on some text. + /// Test a Grok pattern. + /// Test a Grok pattern on one or more lines of text. + /// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -78,7 +84,9 @@ public virtual Task TestGrokPatternAsync(CancellationTo /// /// - /// Tests a Grok pattern on some text. + /// Test a Grok pattern. + /// Test a Grok pattern on one or more lines of text. + /// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Transform.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Transform.g.cs index 162ad128d0a..ecba0eb5a5a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Transform.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Transform.g.cs @@ -1080,12 +1080,22 @@ public virtual Task UpdateTransformAsync(Elastic.Client /// /// - /// Upgrades all transforms. - /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index - /// remains unchanged. + /// Upgrade all transforms. + /// Transforms are compatible across minor versions and between supported major versions. + /// However, over time, the format of transform configuration information may change. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + /// It also cleans up the internal data structures that store the transform state and checkpoints. + /// The upgrade does not affect the source and destination indices. + /// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + /// + /// + /// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + /// Resolve the issue then re-run the process again. + /// A summary is returned when the upgrade is finished. + /// + /// + /// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + /// You may want to perform a recent cluster backup prior to the upgrade. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1097,12 +1107,22 @@ public virtual Task UpgradeTransformsAsync(UpgradeTra /// /// - /// Upgrades all transforms. - /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index - /// remains unchanged. + /// Upgrade all transforms. + /// Transforms are compatible across minor versions and between supported major versions. + /// However, over time, the format of transform configuration information may change. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + /// It also cleans up the internal data structures that store the transform state and checkpoints. + /// The upgrade does not affect the source and destination indices. + /// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + /// + /// + /// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + /// Resolve the issue then re-run the process again. + /// A summary is returned when the upgrade is finished. + /// + /// + /// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + /// You may want to perform a recent cluster backup prior to the upgrade. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1114,12 +1134,22 @@ public virtual Task UpgradeTransformsAsync(UpgradeTra /// /// - /// Upgrades all transforms. - /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index - /// remains unchanged. + /// Upgrade all transforms. + /// Transforms are compatible across minor versions and between supported major versions. + /// However, over time, the format of transform configuration information may change. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + /// It also cleans up the internal data structures that store the transform state and checkpoints. + /// The upgrade does not affect the source and destination indices. + /// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + /// + /// + /// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + /// Resolve the issue then re-run the process again. + /// A summary is returned when the upgrade is finished. + /// + /// + /// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + /// You may want to perform a recent cluster backup prior to the upgrade. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1132,12 +1162,22 @@ public virtual Task UpgradeTransformsAsync(Cancellati /// /// - /// Upgrades all transforms. - /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index - /// remains unchanged. + /// Upgrade all transforms. + /// Transforms are compatible across minor versions and between supported major versions. + /// However, over time, the format of transform configuration information may change. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + /// It also cleans up the internal data structures that store the transform state and checkpoints. + /// The upgrade does not affect the source and destination indices. + /// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + /// + /// + /// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + /// Resolve the issue then re-run the process again. + /// A summary is returned when the upgrade is finished. + /// + /// + /// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + /// You may want to perform a recent cluster backup prior to the upgrade. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Xpack.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Xpack.g.cs index 10bf4564987..90810eb6645 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Xpack.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Client/ElasticsearchClient.Xpack.g.cs @@ -41,8 +41,26 @@ internal XpackNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Provides general information about the installed X-Pack features. + /// Get information. + /// The information provided by the API includes: /// + /// + /// + /// + /// Build information including the build number and timestamp. + /// + /// + /// + /// + /// License information about the currently installed license. + /// + /// + /// + /// + /// Feature information for the features that are currently enabled and available under the current license. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(XpackInfoRequest request, CancellationToken cancellationToken = default) @@ -53,8 +71,26 @@ public virtual Task InfoAsync(XpackInfoRequest request, Cance /// /// - /// Provides general information about the installed X-Pack features. + /// Get information. + /// The information provided by the API includes: + /// + /// + /// + /// + /// Build information including the build number and timestamp. + /// + /// + /// + /// + /// License information about the currently installed license. + /// + /// + /// + /// + /// Feature information for the features that are currently enabled and available under the current license. /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(XpackInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -65,8 +101,26 @@ public virtual Task InfoAsync(XpackInfoRequestDescriptor desc /// /// - /// Provides general information about the installed X-Pack features. + /// Get information. + /// The information provided by the API includes: /// + /// + /// + /// + /// Build information including the build number and timestamp. + /// + /// + /// + /// + /// License information about the currently installed license. + /// + /// + /// + /// + /// Feature information for the features that are currently enabled and available under the current license. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(CancellationToken cancellationToken = default) @@ -78,8 +132,26 @@ public virtual Task InfoAsync(CancellationToken cancellationT /// /// - /// Provides general information about the installed X-Pack features. + /// Get information. + /// The information provided by the API includes: + /// + /// + /// + /// + /// Build information including the build number and timestamp. + /// + /// + /// + /// + /// License information about the currently installed license. + /// + /// + /// + /// + /// Feature information for the features that are currently enabled and available under the current license. /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -92,7 +164,9 @@ public virtual Task InfoAsync(Action /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// Get usage information. + /// Get information about the features that are currently enabled and available under the current license. + /// The API also provides some usage statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -104,7 +178,9 @@ public virtual Task UsageAsync(XpackUsageRequest request, Ca /// /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// Get usage information. + /// Get information about the features that are currently enabled and available under the current license. + /// The API also provides some usage statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -116,7 +192,9 @@ public virtual Task UsageAsync(XpackUsageRequestDescriptor d /// /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// Get usage information. + /// Get information about the features that are currently enabled and available under the current license. + /// The API also provides some usage statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -129,7 +207,9 @@ public virtual Task UsageAsync(CancellationToken cancellatio /// /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// Get usage information. + /// Get information about the features that are currently enabled and available under the current license. + /// The API also provides some usage statistics. /// /// 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 afed21e35c8..4e8ef8c6d98 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. /// - /// 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) { @@ -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. /// - /// 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(ClosePointInTimeRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -334,9 +361,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(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) { @@ -361,7 +400,8 @@ public virtual Task ClosePointInTimeAsync(Action /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -373,7 +413,8 @@ public virtual Task CountAsync(CountRequest request, Cancellation /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -385,7 +426,8 @@ public virtual Task CountAsync(CountRequestDescriptor< /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -398,7 +440,8 @@ public virtual Task CountAsync(Elastic.Clients.Elastic /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -412,7 +455,8 @@ public virtual Task CountAsync(Elastic.Clients.Elastic /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -425,7 +469,8 @@ public virtual Task CountAsync(CancellationToken cance /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -439,7 +484,8 @@ public virtual Task CountAsync(Action /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -451,7 +497,8 @@ public virtual Task CountAsync(CountRequestDescriptor descriptor, /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -464,7 +511,8 @@ public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Serv /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -478,7 +526,8 @@ public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Serv /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -491,7 +540,8 @@ public virtual Task CountAsync(CancellationToken cancellationToke /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -996,7 +1046,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 +1062,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 +1078,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 +1095,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 +1807,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 +1827,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 +1847,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 +1868,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 +1890,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 +1911,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 +1933,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 +1953,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 +1974,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 +1996,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 +2017,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. /// @@ -2346,7 +2478,29 @@ public virtual Task> GetSourceAsync(Elas /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2358,7 +2512,29 @@ public virtual Task HealthReportAsync(HealthReportRequest /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2370,7 +2546,29 @@ public virtual Task HealthReportAsync(HealthReportRequestD /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2383,7 +2581,29 @@ public virtual Task HealthReportAsync(IReadOnlyCollection< /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2397,7 +2617,29 @@ public virtual Task HealthReportAsync(IReadOnlyCollection< /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2410,7 +2652,29 @@ public virtual Task HealthReportAsync(CancellationToken ca /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2631,7 +2895,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 +2913,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 +2931,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 +2950,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 +2970,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 +2989,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 +3009,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 +3027,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 +3046,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 +3066,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 +3085,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 +3105,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 +3122,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 +3139,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 +3157,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 +3176,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 +3194,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 +3213,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 +3243,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 +3273,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 +3304,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 +3336,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 +3367,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 +3399,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 +3411,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 +3423,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 +3436,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 +3450,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 +3463,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 +3477,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 +3501,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 +3525,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 +3550,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 +3576,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 +3601,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 +3627,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 +3651,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 +3676,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) { @@ -3172,7 +3703,7 @@ public virtual Task OpenPointInTimeAsync(Elastic.Client /// /// /// Ping the cluster. - /// Returns whether the cluster is running. + /// Get information about whether the cluster is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3185,7 +3716,7 @@ public virtual Task PingAsync(PingRequest request, CancellationTok /// /// /// Ping the cluster. - /// Returns whether the cluster is running. + /// Get information about whether the cluster is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3198,7 +3729,7 @@ public virtual Task PingAsync(PingRequestDescriptor descriptor, Ca /// /// /// Ping the cluster. - /// Returns whether the cluster is running. + /// Get information about whether the cluster is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3212,7 +3743,7 @@ public virtual Task PingAsync(CancellationToken cancellationToken /// /// /// Ping the cluster. - /// Returns whether the cluster is running. + /// Get information about whether the cluster is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3381,7 +3912,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 +3927,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 +3942,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 +3958,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 +3975,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 +3991,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 +4008,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 +4023,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 +4039,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 +4056,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 +4072,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 +4186,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 +4201,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 +4216,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 +4232,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 +4249,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 +4264,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 +4279,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 +4295,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 +4312,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 +4328,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 +4345,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 +4360,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 +4376,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 +4393,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 +4409,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 +4426,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 +4455,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 +4472,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 +4489,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 +4507,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 +4526,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 +4544,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 +4564,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 +4579,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 +4594,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 +4610,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 +4627,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 +4643,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 +4660,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 +4675,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 +4691,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 +4707,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 +4719,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 +4731,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 +4744,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 +4758,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 +4771,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 +4785,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 +4808,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 +4831,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 +4855,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 +4880,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 +4904,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 +4929,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 +4952,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 +4976,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 +5002,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 +5017,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 +5032,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 +5048,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 +5065,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 +5081,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 +5098,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 +5114,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 +5131,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 +5147,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 +5164,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 +5180,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 +5197,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 +5213,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 +5535,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 +5551,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 +5567,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 +5584,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 7edf328e1ba..e5111e9b1b4 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 b2d4e9e7d50..1a8b867dea2 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 c078dc59136..4761d78cf9c 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/HealthReport/FileSettingsIndicator.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/FileSettingsIndicator.g.cs new file mode 100644 index 00000000000..50e90d939ec --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/FileSettingsIndicator.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.Core.HealthReport; + +/// +/// +/// FILE_SETTINGS +/// +/// +public sealed partial class FileSettingsIndicator +{ + [JsonInclude, JsonPropertyName("details")] + public Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport.FileSettingsIndicatorDetails? Details { get; init; } + [JsonInclude, JsonPropertyName("diagnosis")] + public IReadOnlyCollection? Diagnosis { get; init; } + [JsonInclude, JsonPropertyName("impacts")] + public IReadOnlyCollection? Impacts { get; init; } + [JsonInclude, JsonPropertyName("status")] + public Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport.IndicatorHealthStatus Status { get; init; } + [JsonInclude, JsonPropertyName("symptom")] + public string Symptom { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/FileSettingsIndicatorDetails.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/FileSettingsIndicatorDetails.g.cs new file mode 100644 index 00000000000..ee342d48d11 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/FileSettingsIndicatorDetails.g.cs @@ -0,0 +1,36 @@ +// 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.Core.HealthReport; + +public sealed partial class FileSettingsIndicatorDetails +{ + [JsonInclude, JsonPropertyName("failure_streak")] + public long FailureStreak { get; init; } + [JsonInclude, JsonPropertyName("most_recent_failure")] + public string MostRecentFailure { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/Indicators.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/Indicators.g.cs index 421938267ef..6e72eeae618 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/Indicators.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Core/HealthReport/Indicators.g.cs @@ -33,6 +33,8 @@ public sealed partial class Indicators public Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport.DataStreamLifecycleIndicator? DataStreamLifecycle { get; init; } [JsonInclude, JsonPropertyName("disk")] public Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport.DiskIndicator? Disk { get; init; } + [JsonInclude, JsonPropertyName("file_settings")] + public Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport.FileSettingsIndicator? FileSettings { get; init; } [JsonInclude, JsonPropertyName("ilm")] public Elastic.Clients.Elasticsearch.Serverless.Core.HealthReport.IlmIndicator? Ilm { get; init; } [JsonInclude, JsonPropertyName("master_is_stable")] 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 9d1ac592068..f53eb2505da 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 9399ba7a53b..acf5fb54ea7 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 424a709eb1a..eba098f5694 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 2f539197a3e..fdade2d12af 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 795cc695623..e8e65353032 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 00000000000..2a4deee6213 --- /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.Mapping.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Mapping.g.cs index 5fd4dcffbe2..35464a20739 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Mapping.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Enums/Enums.Mapping.g.cs @@ -403,6 +403,8 @@ public enum FieldType RankFeature, [EnumMember(Value = "percolator")] Percolator, + [EnumMember(Value = "passthrough")] + Passthrough, [EnumMember(Value = "object")] Object, [EnumMember(Value = "none")] @@ -504,6 +506,8 @@ public override FieldType Read(ref Utf8JsonReader reader, Type typeToConvert, Js return FieldType.RankFeature; case "percolator": return FieldType.Percolator; + case "passthrough": + return FieldType.Passthrough; case "object": return FieldType.Object; case "none": @@ -618,6 +622,9 @@ public override void Write(Utf8JsonWriter writer, FieldType value, JsonSerialize case FieldType.Percolator: writer.WriteStringValue("percolator"); return; + case FieldType.Passthrough: + writer.WriteStringValue("passthrough"); + return; case FieldType.Object: writer.WriteStringValue("object"); return; 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 08429f5c021..bd9dce49136 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 @@ -126,6 +126,48 @@ public override void Write(Utf8JsonWriter writer, ApiKeyGrantType value, JsonSer } } +[JsonConverter(typeof(ApiKeyTypeConverter))] +public enum ApiKeyType +{ + [EnumMember(Value = "rest")] + Rest, + [EnumMember(Value = "cross_cluster")] + CrossCluster +} + +internal sealed class ApiKeyTypeConverter : JsonConverter +{ + public override ApiKeyType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + var enumString = reader.GetString(); + switch (enumString) + { + case "rest": + return ApiKeyType.Rest; + case "cross_cluster": + return ApiKeyType.CrossCluster; + } + + ThrowHelper.ThrowJsonException(); + return default; + } + + public override void Write(Utf8JsonWriter writer, ApiKeyType value, JsonSerializerOptions options) + { + switch (value) + { + case ApiKeyType.Rest: + writer.WriteStringValue("rest"); + return; + case ApiKeyType.CrossCluster: + writer.WriteStringValue("cross_cluster"); + return; + } + + writer.WriteNullValue(); + } +} + [JsonConverter(typeof(EnumStructConverter))] public readonly partial struct ClusterPrivilege : IEnumStruct { @@ -265,6 +307,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 55076a1833e..4c54c28aa4c 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 52d2669e5eb..1cd15282d5b 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 b9ccfb7f5fc..48871a55b04 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 8094905750c..3d942cd5f39 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 d006d71418f..ef149859971 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 615da923b57..69e9ad496be 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 e0a1a5e6a2f..5c9472e884d 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/IndexManagement/MappingLimitSettingsTotalFields.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs index 95ab12b37b8..2bb334a6e3e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs @@ -39,7 +39,7 @@ public sealed partial class MappingLimitSettingsTotalFields /// /// [JsonInclude, JsonPropertyName("ignore_dynamic_beyond_limit")] - public bool? IgnoreDynamicBeyondLimit { get; set; } + public object? IgnoreDynamicBeyondLimit { get; set; } /// /// @@ -49,7 +49,7 @@ public sealed partial class MappingLimitSettingsTotalFields /// /// [JsonInclude, JsonPropertyName("limit")] - public long? Limit { get; set; } + public object? Limit { get; set; } } public sealed partial class MappingLimitSettingsTotalFieldsDescriptor : SerializableDescriptor @@ -60,8 +60,8 @@ public MappingLimitSettingsTotalFieldsDescriptor() : base() { } - private bool? IgnoreDynamicBeyondLimitValue { get; set; } - private long? LimitValue { get; set; } + private object? IgnoreDynamicBeyondLimitValue { get; set; } + private object? LimitValue { get; set; } /// /// @@ -72,7 +72,7 @@ public MappingLimitSettingsTotalFieldsDescriptor() : base() /// The fields that were not added to the mapping will be added to the _ignored field. /// /// - public MappingLimitSettingsTotalFieldsDescriptor IgnoreDynamicBeyondLimit(bool? ignoreDynamicBeyondLimit = true) + public MappingLimitSettingsTotalFieldsDescriptor IgnoreDynamicBeyondLimit(object? ignoreDynamicBeyondLimit) { IgnoreDynamicBeyondLimitValue = ignoreDynamicBeyondLimit; return Self; @@ -85,7 +85,7 @@ public MappingLimitSettingsTotalFieldsDescriptor IgnoreDynamicBeyondLimit(bool? /// degradations and memory issues, especially in clusters with a high load or few resources. /// /// - public MappingLimitSettingsTotalFieldsDescriptor Limit(long? limit) + public MappingLimitSettingsTotalFieldsDescriptor Limit(object? limit) { LimitValue = limit; return Self; @@ -94,16 +94,16 @@ public MappingLimitSettingsTotalFieldsDescriptor Limit(long? limit) protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); - if (IgnoreDynamicBeyondLimitValue.HasValue) + if (IgnoreDynamicBeyondLimitValue is not null) { writer.WritePropertyName("ignore_dynamic_beyond_limit"); - writer.WriteBooleanValue(IgnoreDynamicBeyondLimitValue.Value); + JsonSerializer.Serialize(writer, IgnoreDynamicBeyondLimitValue, options); } - if (LimitValue.HasValue) + if (LimitValue is not null) { writer.WritePropertyName("limit"); - writer.WriteNumberValue(LimitValue.Value); + JsonSerializer.Serialize(writer, LimitValue, options); } writer.WriteEndObject(); 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 00000000000..3f8912a1069 --- /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 00000000000..aee66bad661 --- /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/DatabaseConfiguration.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DatabaseConfiguration.g.cs index 3c5f7090bd1..bbe957c526a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DatabaseConfiguration.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DatabaseConfiguration.g.cs @@ -21,28 +21,289 @@ using Elastic.Clients.Elasticsearch.Serverless.Serialization; using System; using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; using System.Linq.Expressions; using System.Text.Json; using System.Text.Json.Serialization; namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; +/// +/// +/// The configuration necessary to identify which IP geolocation provider to use to download a database, as well as any provider-specific configuration necessary for such downloading. +/// At present, the only supported providers are maxmind and ipinfo, and the maxmind provider requires that an account_id (string) is configured. +/// A provider (either maxmind or ipinfo) must be specified. The web and local providers can be returned as read only configurations. +/// +/// +[JsonConverter(typeof(DatabaseConfigurationConverter))] public sealed partial class DatabaseConfiguration { + internal DatabaseConfiguration(string variantName, object variant) + { + if (variantName is null) + throw new ArgumentNullException(nameof(variantName)); + if (variant is null) + throw new ArgumentNullException(nameof(variant)); + if (string.IsNullOrWhiteSpace(variantName)) + throw new ArgumentException("Variant name must not be empty or whitespace."); + VariantName = variantName; + Variant = variant; + } + + internal object Variant { get; } + internal string VariantName { get; } + + public static DatabaseConfiguration Ipinfo(Elastic.Clients.Elasticsearch.Serverless.Ingest.Ipinfo ipinfo) => new DatabaseConfiguration("ipinfo", ipinfo); + public static DatabaseConfiguration Maxmind(Elastic.Clients.Elasticsearch.Serverless.Ingest.Maxmind maxmind) => new DatabaseConfiguration("maxmind", maxmind); + + /// + /// + /// The provider-assigned name of the IP geolocation database to download. + /// + /// + [JsonInclude, JsonPropertyName("name")] + public Elastic.Clients.Elasticsearch.Serverless.Name Name { get; set; } + + public bool TryGet([NotNullWhen(true)] out T? result) where T : class + { + result = default; + if (Variant is T variant) + { + result = variant; + return true; + } + + return false; + } +} + +internal sealed partial class DatabaseConfigurationConverter : JsonConverter +{ + public override DatabaseConfiguration Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType != JsonTokenType.StartObject) + { + throw new JsonException("Expected start token."); + } + + object? variantValue = default; + string? variantNameValue = default; + Elastic.Clients.Elasticsearch.Serverless.Name nameValue = default; + while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) + { + if (reader.TokenType != JsonTokenType.PropertyName) + { + throw new JsonException("Expected a property name token."); + } + + if (reader.TokenType != JsonTokenType.PropertyName) + { + throw new JsonException("Expected a property name token representing the name of an Elasticsearch field."); + } + + var propertyName = reader.GetString(); + reader.Read(); + if (propertyName == "name") + { + nameValue = JsonSerializer.Deserialize(ref reader, options); + continue; + } + + if (propertyName == "ipinfo") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + + if (propertyName == "maxmind") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + + throw new JsonException($"Unknown property name '{propertyName}' received while deserializing the 'DatabaseConfiguration' from the response."); + } + + var result = new DatabaseConfiguration(variantNameValue, variantValue); + result.Name = nameValue; + return result; + } + + public override void Write(Utf8JsonWriter writer, DatabaseConfiguration value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + if (value.Name is not null) + { + writer.WritePropertyName("name"); + JsonSerializer.Serialize(writer, value.Name, options); + } + + if (value.VariantName is not null && value.Variant is not null) + { + writer.WritePropertyName(value.VariantName); + switch (value.VariantName) + { + case "ipinfo": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.Ingest.Ipinfo)value.Variant, options); + break; + case "maxmind": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.Ingest.Maxmind)value.Variant, options); + break; + } + } + + writer.WriteEndObject(); + } +} + +public sealed partial class DatabaseConfigurationDescriptor : SerializableDescriptor> +{ + internal DatabaseConfigurationDescriptor(Action> configure) => configure.Invoke(this); + + public DatabaseConfigurationDescriptor() : base() + { + } + + private bool ContainsVariant { get; set; } + private string ContainedVariantName { get; set; } + private object Variant { get; set; } + private Descriptor Descriptor { get; set; } + + private DatabaseConfigurationDescriptor Set(Action descriptorAction, string variantName) where T : Descriptor + { + ContainedVariantName = variantName; + ContainsVariant = true; + var descriptor = (T)Activator.CreateInstance(typeof(T), true); + descriptorAction?.Invoke(descriptor); + Descriptor = descriptor; + return Self; + } + + private DatabaseConfigurationDescriptor Set(object variant, string variantName) + { + Variant = variant; + ContainedVariantName = variantName; + ContainsVariant = true; + return Self; + } + + private Elastic.Clients.Elasticsearch.Serverless.Name NameValue { get; set; } + /// /// - /// The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading. - /// At present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured. + /// The provider-assigned name of the IP geolocation database to download. /// /// - [JsonInclude, JsonPropertyName("maxmind")] - public Elastic.Clients.Elasticsearch.Serverless.Ingest.Maxmind Maxmind { get; init; } + public DatabaseConfigurationDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.Name name) + { + NameValue = name; + return Self; + } + + public DatabaseConfigurationDescriptor Ipinfo(Elastic.Clients.Elasticsearch.Serverless.Ingest.Ipinfo ipinfo) => Set(ipinfo, "ipinfo"); + public DatabaseConfigurationDescriptor Ipinfo(Action configure) => Set(configure, "ipinfo"); + public DatabaseConfigurationDescriptor Maxmind(Elastic.Clients.Elasticsearch.Serverless.Ingest.Maxmind maxmind) => Set(maxmind, "maxmind"); + public DatabaseConfigurationDescriptor Maxmind(Action configure) => Set(configure, "maxmind"); + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (NameValue is not null) + { + writer.WritePropertyName("name"); + JsonSerializer.Serialize(writer, NameValue, options); + } + + if (!string.IsNullOrEmpty(ContainedVariantName)) + { + writer.WritePropertyName(ContainedVariantName); + if (Variant is not null) + { + JsonSerializer.Serialize(writer, Variant, Variant.GetType(), options); + writer.WriteEndObject(); + return; + } + + JsonSerializer.Serialize(writer, Descriptor, Descriptor.GetType(), options); + } + + writer.WriteEndObject(); + } +} + +public sealed partial class DatabaseConfigurationDescriptor : SerializableDescriptor +{ + internal DatabaseConfigurationDescriptor(Action configure) => configure.Invoke(this); + + public DatabaseConfigurationDescriptor() : base() + { + } + + private bool ContainsVariant { get; set; } + private string ContainedVariantName { get; set; } + private object Variant { get; set; } + private Descriptor Descriptor { get; set; } + + private DatabaseConfigurationDescriptor Set(Action descriptorAction, string variantName) where T : Descriptor + { + ContainedVariantName = variantName; + ContainsVariant = true; + var descriptor = (T)Activator.CreateInstance(typeof(T), true); + descriptorAction?.Invoke(descriptor); + Descriptor = descriptor; + return Self; + } + + private DatabaseConfigurationDescriptor Set(object variant, string variantName) + { + Variant = variant; + ContainedVariantName = variantName; + ContainsVariant = true; + return Self; + } + + private Elastic.Clients.Elasticsearch.Serverless.Name NameValue { get; set; } /// /// /// The provider-assigned name of the IP geolocation database to download. /// /// - [JsonInclude, JsonPropertyName("name")] - public string Name { get; init; } + public DatabaseConfigurationDescriptor Name(Elastic.Clients.Elasticsearch.Serverless.Name name) + { + NameValue = name; + return Self; + } + + public DatabaseConfigurationDescriptor Ipinfo(Elastic.Clients.Elasticsearch.Serverless.Ingest.Ipinfo ipinfo) => Set(ipinfo, "ipinfo"); + public DatabaseConfigurationDescriptor Ipinfo(Action configure) => Set(configure, "ipinfo"); + public DatabaseConfigurationDescriptor Maxmind(Elastic.Clients.Elasticsearch.Serverless.Ingest.Maxmind maxmind) => Set(maxmind, "maxmind"); + public DatabaseConfigurationDescriptor Maxmind(Action configure) => Set(configure, "maxmind"); + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (NameValue is not null) + { + writer.WritePropertyName("name"); + JsonSerializer.Serialize(writer, NameValue, options); + } + + if (!string.IsNullOrEmpty(ContainedVariantName)) + { + writer.WritePropertyName(ContainedVariantName); + if (Variant is not null) + { + JsonSerializer.Serialize(writer, Variant, Variant.GetType(), options); + writer.WriteEndObject(); + return; + } + + JsonSerializer.Serialize(writer, Descriptor, Descriptor.GetType(), options); + } + + writer.WriteEndObject(); + } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DatabaseConfigurationFull.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DatabaseConfigurationFull.g.cs new file mode 100644 index 00000000000..74ed0662918 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/DatabaseConfigurationFull.g.cs @@ -0,0 +1,332 @@ +// 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.Diagnostics.CodeAnalysis; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Serverless.Ingest; + +[JsonConverter(typeof(DatabaseConfigurationFullConverter))] +public sealed partial class DatabaseConfigurationFull +{ + internal DatabaseConfigurationFull(string variantName, object variant) + { + if (variantName is null) + throw new ArgumentNullException(nameof(variantName)); + if (variant is null) + throw new ArgumentNullException(nameof(variant)); + if (string.IsNullOrWhiteSpace(variantName)) + throw new ArgumentException("Variant name must not be empty or whitespace."); + VariantName = variantName; + Variant = variant; + } + + internal object Variant { get; } + internal string VariantName { get; } + + public static DatabaseConfigurationFull Ipinfo(Elastic.Clients.Elasticsearch.Serverless.Ingest.Ipinfo ipinfo) => new DatabaseConfigurationFull("ipinfo", ipinfo); + public static DatabaseConfigurationFull Local(Elastic.Clients.Elasticsearch.Serverless.Ingest.Local local) => new DatabaseConfigurationFull("local", local); + public static DatabaseConfigurationFull Maxmind(Elastic.Clients.Elasticsearch.Serverless.Ingest.Maxmind maxmind) => new DatabaseConfigurationFull("maxmind", maxmind); + public static DatabaseConfigurationFull Web(Elastic.Clients.Elasticsearch.Serverless.Ingest.Web web) => new DatabaseConfigurationFull("web", web); + + /// + /// + /// The provider-assigned name of the IP geolocation database to download. + /// + /// + [JsonInclude, JsonPropertyName("name")] + public string Name { get; set; } + + public bool TryGet([NotNullWhen(true)] out T? result) where T : class + { + result = default; + if (Variant is T variant) + { + result = variant; + return true; + } + + return false; + } +} + +internal sealed partial class DatabaseConfigurationFullConverter : JsonConverter +{ + public override DatabaseConfigurationFull Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType != JsonTokenType.StartObject) + { + throw new JsonException("Expected start token."); + } + + object? variantValue = default; + string? variantNameValue = default; + string nameValue = default; + while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) + { + if (reader.TokenType != JsonTokenType.PropertyName) + { + throw new JsonException("Expected a property name token."); + } + + if (reader.TokenType != JsonTokenType.PropertyName) + { + throw new JsonException("Expected a property name token representing the name of an Elasticsearch field."); + } + + var propertyName = reader.GetString(); + reader.Read(); + if (propertyName == "name") + { + nameValue = JsonSerializer.Deserialize(ref reader, options); + continue; + } + + if (propertyName == "ipinfo") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + + if (propertyName == "local") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + + if (propertyName == "maxmind") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + + if (propertyName == "web") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + + throw new JsonException($"Unknown property name '{propertyName}' received while deserializing the 'DatabaseConfigurationFull' from the response."); + } + + var result = new DatabaseConfigurationFull(variantNameValue, variantValue); + result.Name = nameValue; + return result; + } + + public override void Write(Utf8JsonWriter writer, DatabaseConfigurationFull value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(value.Name)) + { + writer.WritePropertyName("name"); + writer.WriteStringValue(value.Name); + } + + if (value.VariantName is not null && value.Variant is not null) + { + writer.WritePropertyName(value.VariantName); + switch (value.VariantName) + { + case "ipinfo": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.Ingest.Ipinfo)value.Variant, options); + break; + case "local": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.Ingest.Local)value.Variant, options); + break; + case "maxmind": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.Ingest.Maxmind)value.Variant, options); + break; + case "web": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.Ingest.Web)value.Variant, options); + break; + } + } + + writer.WriteEndObject(); + } +} + +public sealed partial class DatabaseConfigurationFullDescriptor : SerializableDescriptor> +{ + internal DatabaseConfigurationFullDescriptor(Action> configure) => configure.Invoke(this); + + public DatabaseConfigurationFullDescriptor() : base() + { + } + + private bool ContainsVariant { get; set; } + private string ContainedVariantName { get; set; } + private object Variant { get; set; } + private Descriptor Descriptor { get; set; } + + private DatabaseConfigurationFullDescriptor Set(Action descriptorAction, string variantName) where T : Descriptor + { + ContainedVariantName = variantName; + ContainsVariant = true; + var descriptor = (T)Activator.CreateInstance(typeof(T), true); + descriptorAction?.Invoke(descriptor); + Descriptor = descriptor; + return Self; + } + + private DatabaseConfigurationFullDescriptor Set(object variant, string variantName) + { + Variant = variant; + ContainedVariantName = variantName; + ContainsVariant = true; + return Self; + } + + private string NameValue { get; set; } + + /// + /// + /// The provider-assigned name of the IP geolocation database to download. + /// + /// + public DatabaseConfigurationFullDescriptor Name(string name) + { + NameValue = name; + return Self; + } + + public DatabaseConfigurationFullDescriptor Ipinfo(Elastic.Clients.Elasticsearch.Serverless.Ingest.Ipinfo ipinfo) => Set(ipinfo, "ipinfo"); + public DatabaseConfigurationFullDescriptor Ipinfo(Action configure) => Set(configure, "ipinfo"); + public DatabaseConfigurationFullDescriptor Local(Elastic.Clients.Elasticsearch.Serverless.Ingest.Local local) => Set(local, "local"); + public DatabaseConfigurationFullDescriptor Local(Action configure) => Set(configure, "local"); + public DatabaseConfigurationFullDescriptor Maxmind(Elastic.Clients.Elasticsearch.Serverless.Ingest.Maxmind maxmind) => Set(maxmind, "maxmind"); + public DatabaseConfigurationFullDescriptor Maxmind(Action configure) => Set(configure, "maxmind"); + public DatabaseConfigurationFullDescriptor Web(Elastic.Clients.Elasticsearch.Serverless.Ingest.Web web) => Set(web, "web"); + public DatabaseConfigurationFullDescriptor Web(Action configure) => Set(configure, "web"); + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(NameValue)) + { + writer.WritePropertyName("name"); + writer.WriteStringValue(NameValue); + } + + if (!string.IsNullOrEmpty(ContainedVariantName)) + { + writer.WritePropertyName(ContainedVariantName); + if (Variant is not null) + { + JsonSerializer.Serialize(writer, Variant, Variant.GetType(), options); + writer.WriteEndObject(); + return; + } + + JsonSerializer.Serialize(writer, Descriptor, Descriptor.GetType(), options); + } + + writer.WriteEndObject(); + } +} + +public sealed partial class DatabaseConfigurationFullDescriptor : SerializableDescriptor +{ + internal DatabaseConfigurationFullDescriptor(Action configure) => configure.Invoke(this); + + public DatabaseConfigurationFullDescriptor() : base() + { + } + + private bool ContainsVariant { get; set; } + private string ContainedVariantName { get; set; } + private object Variant { get; set; } + private Descriptor Descriptor { get; set; } + + private DatabaseConfigurationFullDescriptor Set(Action descriptorAction, string variantName) where T : Descriptor + { + ContainedVariantName = variantName; + ContainsVariant = true; + var descriptor = (T)Activator.CreateInstance(typeof(T), true); + descriptorAction?.Invoke(descriptor); + Descriptor = descriptor; + return Self; + } + + private DatabaseConfigurationFullDescriptor Set(object variant, string variantName) + { + Variant = variant; + ContainedVariantName = variantName; + ContainsVariant = true; + return Self; + } + + private string NameValue { get; set; } + + /// + /// + /// The provider-assigned name of the IP geolocation database to download. + /// + /// + public DatabaseConfigurationFullDescriptor Name(string name) + { + NameValue = name; + return Self; + } + + public DatabaseConfigurationFullDescriptor Ipinfo(Elastic.Clients.Elasticsearch.Serverless.Ingest.Ipinfo ipinfo) => Set(ipinfo, "ipinfo"); + public DatabaseConfigurationFullDescriptor Ipinfo(Action configure) => Set(configure, "ipinfo"); + public DatabaseConfigurationFullDescriptor Local(Elastic.Clients.Elasticsearch.Serverless.Ingest.Local local) => Set(local, "local"); + public DatabaseConfigurationFullDescriptor Local(Action configure) => Set(configure, "local"); + public DatabaseConfigurationFullDescriptor Maxmind(Elastic.Clients.Elasticsearch.Serverless.Ingest.Maxmind maxmind) => Set(maxmind, "maxmind"); + public DatabaseConfigurationFullDescriptor Maxmind(Action configure) => Set(configure, "maxmind"); + public DatabaseConfigurationFullDescriptor Web(Elastic.Clients.Elasticsearch.Serverless.Ingest.Web web) => Set(web, "web"); + public DatabaseConfigurationFullDescriptor Web(Action configure) => Set(configure, "web"); + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(NameValue)) + { + writer.WritePropertyName("name"); + writer.WriteStringValue(NameValue); + } + + if (!string.IsNullOrEmpty(ContainedVariantName)) + { + writer.WritePropertyName(ContainedVariantName); + if (Variant is not null) + { + JsonSerializer.Serialize(writer, Variant, Variant.GetType(), options); + writer.WriteEndObject(); + return; + } + + JsonSerializer.Serialize(writer, Descriptor, Descriptor.GetType(), options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/IpDatabaseConfigurationMetadata.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/IpDatabaseConfigurationMetadata.g.cs new file mode 100644 index 00000000000..d69946484e2 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/IpDatabaseConfigurationMetadata.g.cs @@ -0,0 +1,42 @@ +// 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 IpDatabaseConfigurationMetadata +{ + [JsonInclude, JsonPropertyName("database")] + public Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfigurationFull Database { get; init; } + [JsonInclude, JsonPropertyName("id")] + public string Id { get; init; } + [JsonInclude, JsonPropertyName("modified_date")] + public long? ModifiedDate { get; init; } + [JsonInclude, JsonPropertyName("modified_date_millis")] + public long? ModifiedDateMillis { get; init; } + [JsonInclude, JsonPropertyName("version")] + public long Version { 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 00000000000..0f8ec6efefe --- /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/Ipinfo.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Ipinfo.g.cs new file mode 100644 index 00000000000..997db6852de --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Ipinfo.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.Ingest; + +public sealed partial class Ipinfo +{ +} + +public sealed partial class IpinfoDescriptor : SerializableDescriptor +{ + internal IpinfoDescriptor(Action configure) => configure.Invoke(this); + + public IpinfoDescriptor() : base() + { + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Local.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Local.g.cs new file mode 100644 index 00000000000..0e9e69c0020 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Local.g.cs @@ -0,0 +1,61 @@ +// 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 Local +{ + [JsonInclude, JsonPropertyName("type")] + public string Type { get; set; } + + public static implicit operator Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfigurationFull(Local local) => Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfigurationFull.Local(local); +} + +public sealed partial class LocalDescriptor : SerializableDescriptor +{ + internal LocalDescriptor(Action configure) => configure.Invoke(this); + + public LocalDescriptor() : base() + { + } + + private string TypeValue { get; set; } + + public LocalDescriptor Type(string type) + { + TypeValue = type; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("type"); + writer.WriteStringValue(TypeValue); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Maxmind.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Maxmind.g.cs index 8adb54ec878..565994e790c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Maxmind.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Maxmind.g.cs @@ -31,6 +31,9 @@ public sealed partial class Maxmind { [JsonInclude, JsonPropertyName("account_id")] public Elastic.Clients.Elasticsearch.Serverless.Id AccountId { get; set; } + + public static implicit operator Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration(Maxmind maxmind) => Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfiguration.Maxmind(maxmind); + public static implicit operator Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfigurationFull(Maxmind maxmind) => Elastic.Clients.Elasticsearch.Serverless.Ingest.DatabaseConfigurationFull.Maxmind(maxmind); } public sealed partial class MaxmindDescriptor : SerializableDescriptor 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 a9e21af1863..f464444d218 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/Ingest/Web.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Web.g.cs new file mode 100644 index 00000000000..6783a58f9d6 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Ingest/Web.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.Ingest; + +public sealed partial class Web +{ +} + +public sealed partial class WebDescriptor : SerializableDescriptor +{ + internal WebDescriptor(Action configure) => configure.Invoke(this); + + public WebDescriptor() : base() + { + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WriteEndObject(); + } +} \ No newline at end of file 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 fb0452abfbd..12e19169c80 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/MachineLearning/AdaptiveAllocationsSettings.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AdaptiveAllocationsSettings.g.cs new file mode 100644 index 00000000000..8ad7a3359a5 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AdaptiveAllocationsSettings.g.cs @@ -0,0 +1,38 @@ +// 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.MachineLearning; + +public sealed partial class AdaptiveAllocationsSettings +{ + [JsonInclude, JsonPropertyName("enabled")] + public bool Enabled { get; init; } + [JsonInclude, JsonPropertyName("max_number_of_allocations")] + public int? MaxNumberOfAllocations { get; init; } + [JsonInclude, JsonPropertyName("min_number_of_allocations")] + public int? MinNumberOfAllocations { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisLimits.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisLimits.g.cs index 2222f2104e5..2f42117df7a 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisLimits.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/AnalysisLimits.g.cs @@ -43,7 +43,7 @@ public sealed partial class AnalysisLimits /// /// [JsonInclude, JsonPropertyName("model_memory_limit")] - public string? ModelMemoryLimit { get; set; } + public Elastic.Clients.Elasticsearch.Serverless.ByteSize? ModelMemoryLimit { get; set; } } public sealed partial class AnalysisLimitsDescriptor : SerializableDescriptor @@ -55,7 +55,7 @@ public AnalysisLimitsDescriptor() : base() } private long? CategorizationExamplesLimitValue { get; set; } - private string? ModelMemoryLimitValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.ByteSize? ModelMemoryLimitValue { get; set; } /// /// @@ -73,7 +73,7 @@ public AnalysisLimitsDescriptor CategorizationExamplesLimit(long? categorization /// The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the xpack.ml.max_model_memory_limit setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of b or kb and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the xpack.ml.max_model_memory_limit setting, an error occurs when you try to create jobs that have model_memory_limit values greater than that setting value. /// /// - public AnalysisLimitsDescriptor ModelMemoryLimit(string? modelMemoryLimit) + public AnalysisLimitsDescriptor ModelMemoryLimit(Elastic.Clients.Elasticsearch.Serverless.ByteSize? modelMemoryLimit) { ModelMemoryLimitValue = modelMemoryLimit; return Self; @@ -88,10 +88,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(CategorizationExamplesLimitValue.Value); } - if (!string.IsNullOrEmpty(ModelMemoryLimitValue)) + if (ModelMemoryLimitValue is not null) { writer.WritePropertyName("model_memory_limit"); - writer.WriteStringValue(ModelMemoryLimitValue); + JsonSerializer.Serialize(writer, ModelMemoryLimitValue, options); } writer.WriteEndObject(); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedStats.g.cs index 5673c68f978..312f0051f07 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedStats.g.cs @@ -70,5 +70,5 @@ public sealed partial class DatafeedStats /// /// [JsonInclude, JsonPropertyName("timing_stats")] - public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DatafeedTimingStats TimingStats { get; init; } + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DatafeedTimingStats? TimingStats { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs index 6c407b4391c..fedc96d9873 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs @@ -44,6 +44,8 @@ public sealed partial class DatafeedTimingStats /// [JsonInclude, JsonPropertyName("bucket_count")] public long BucketCount { get; init; } + [JsonInclude, JsonPropertyName("exponential_average_calculation_context")] + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ExponentialAverageCalculationContext? ExponentialAverageCalculationContext { get; init; } /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs index 83635a8a546..f5ff47be1e7 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs @@ -53,6 +53,8 @@ public sealed partial class DataframeAnalyticsSummary public string Id { get; init; } [JsonInclude, JsonPropertyName("max_num_threads")] public int? MaxNumThreads { get; init; } + [JsonInclude, JsonPropertyName("_meta")] + public IReadOnlyDictionary? Meta { get; init; } [JsonInclude, JsonPropertyName("model_memory_limit")] public string? ModelMemoryLimit { get; init; } [JsonInclude, JsonPropertyName("source")] diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DetectorUpdate.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DetectorUpdate.g.cs new file mode 100644 index 00000000000..8cc5b1413aa --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/DetectorUpdate.g.cs @@ -0,0 +1,312 @@ +// 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.MachineLearning; + +public sealed partial class DetectorUpdate +{ + /// + /// + /// An array of custom rule objects, which enable you to customize the way detectors operate. + /// For example, a rule may dictate to the detector conditions under which results should be skipped. + /// Kibana refers to custom rules as job rules. + /// + /// + [JsonInclude, JsonPropertyName("custom_rules")] + public ICollection? CustomRules { get; set; } + + /// + /// + /// A description of the detector. + /// + /// + [JsonInclude, JsonPropertyName("description")] + public string? Description { get; set; } + + /// + /// + /// A unique identifier for the detector. + /// This identifier is based on the order of the detectors in the analysis_config, starting at zero. + /// + /// + [JsonInclude, JsonPropertyName("detector_index")] + public int DetectorIndex { get; set; } +} + +public sealed partial class DetectorUpdateDescriptor : SerializableDescriptor> +{ + internal DetectorUpdateDescriptor(Action> configure) => configure.Invoke(this); + + public DetectorUpdateDescriptor() : base() + { + } + + private ICollection? CustomRulesValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectionRuleDescriptor CustomRulesDescriptor { get; set; } + private Action> CustomRulesDescriptorAction { get; set; } + private Action>[] CustomRulesDescriptorActions { get; set; } + private string? DescriptionValue { get; set; } + private int DetectorIndexValue { get; set; } + + /// + /// + /// An array of custom rule objects, which enable you to customize the way detectors operate. + /// For example, a rule may dictate to the detector conditions under which results should be skipped. + /// Kibana refers to custom rules as job rules. + /// + /// + public DetectorUpdateDescriptor CustomRules(ICollection? customRules) + { + CustomRulesDescriptor = null; + CustomRulesDescriptorAction = null; + CustomRulesDescriptorActions = null; + CustomRulesValue = customRules; + return Self; + } + + public DetectorUpdateDescriptor CustomRules(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectionRuleDescriptor descriptor) + { + CustomRulesValue = null; + CustomRulesDescriptorAction = null; + CustomRulesDescriptorActions = null; + CustomRulesDescriptor = descriptor; + return Self; + } + + public DetectorUpdateDescriptor CustomRules(Action> configure) + { + CustomRulesValue = null; + CustomRulesDescriptor = null; + CustomRulesDescriptorActions = null; + CustomRulesDescriptorAction = configure; + return Self; + } + + public DetectorUpdateDescriptor CustomRules(params Action>[] configure) + { + CustomRulesValue = null; + CustomRulesDescriptor = null; + CustomRulesDescriptorAction = null; + CustomRulesDescriptorActions = configure; + return Self; + } + + /// + /// + /// A description of the detector. + /// + /// + public DetectorUpdateDescriptor Description(string? description) + { + DescriptionValue = description; + return Self; + } + + /// + /// + /// A unique identifier for the detector. + /// This identifier is based on the order of the detectors in the analysis_config, starting at zero. + /// + /// + public DetectorUpdateDescriptor DetectorIndex(int detectorIndex) + { + DetectorIndexValue = detectorIndex; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (CustomRulesDescriptor is not null) + { + writer.WritePropertyName("custom_rules"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, CustomRulesDescriptor, options); + writer.WriteEndArray(); + } + else if (CustomRulesDescriptorAction is not null) + { + writer.WritePropertyName("custom_rules"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectionRuleDescriptor(CustomRulesDescriptorAction), options); + writer.WriteEndArray(); + } + else if (CustomRulesDescriptorActions is not null) + { + writer.WritePropertyName("custom_rules"); + writer.WriteStartArray(); + foreach (var action in CustomRulesDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectionRuleDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (CustomRulesValue is not null) + { + writer.WritePropertyName("custom_rules"); + JsonSerializer.Serialize(writer, CustomRulesValue, options); + } + + if (!string.IsNullOrEmpty(DescriptionValue)) + { + writer.WritePropertyName("description"); + writer.WriteStringValue(DescriptionValue); + } + + writer.WritePropertyName("detector_index"); + writer.WriteNumberValue(DetectorIndexValue); + writer.WriteEndObject(); + } +} + +public sealed partial class DetectorUpdateDescriptor : SerializableDescriptor +{ + internal DetectorUpdateDescriptor(Action configure) => configure.Invoke(this); + + public DetectorUpdateDescriptor() : base() + { + } + + private ICollection? CustomRulesValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectionRuleDescriptor CustomRulesDescriptor { get; set; } + private Action CustomRulesDescriptorAction { get; set; } + private Action[] CustomRulesDescriptorActions { get; set; } + private string? DescriptionValue { get; set; } + private int DetectorIndexValue { get; set; } + + /// + /// + /// An array of custom rule objects, which enable you to customize the way detectors operate. + /// For example, a rule may dictate to the detector conditions under which results should be skipped. + /// Kibana refers to custom rules as job rules. + /// + /// + public DetectorUpdateDescriptor CustomRules(ICollection? customRules) + { + CustomRulesDescriptor = null; + CustomRulesDescriptorAction = null; + CustomRulesDescriptorActions = null; + CustomRulesValue = customRules; + return Self; + } + + public DetectorUpdateDescriptor CustomRules(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectionRuleDescriptor descriptor) + { + CustomRulesValue = null; + CustomRulesDescriptorAction = null; + CustomRulesDescriptorActions = null; + CustomRulesDescriptor = descriptor; + return Self; + } + + public DetectorUpdateDescriptor CustomRules(Action configure) + { + CustomRulesValue = null; + CustomRulesDescriptor = null; + CustomRulesDescriptorActions = null; + CustomRulesDescriptorAction = configure; + return Self; + } + + public DetectorUpdateDescriptor CustomRules(params Action[] configure) + { + CustomRulesValue = null; + CustomRulesDescriptor = null; + CustomRulesDescriptorAction = null; + CustomRulesDescriptorActions = configure; + return Self; + } + + /// + /// + /// A description of the detector. + /// + /// + public DetectorUpdateDescriptor Description(string? description) + { + DescriptionValue = description; + return Self; + } + + /// + /// + /// A unique identifier for the detector. + /// This identifier is based on the order of the detectors in the analysis_config, starting at zero. + /// + /// + public DetectorUpdateDescriptor DetectorIndex(int detectorIndex) + { + DetectorIndexValue = detectorIndex; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (CustomRulesDescriptor is not null) + { + writer.WritePropertyName("custom_rules"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, CustomRulesDescriptor, options); + writer.WriteEndArray(); + } + else if (CustomRulesDescriptorAction is not null) + { + writer.WritePropertyName("custom_rules"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectionRuleDescriptor(CustomRulesDescriptorAction), options); + writer.WriteEndArray(); + } + else if (CustomRulesDescriptorActions is not null) + { + writer.WritePropertyName("custom_rules"); + writer.WriteStartArray(); + foreach (var action in CustomRulesDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DetectionRuleDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (CustomRulesValue is not null) + { + writer.WritePropertyName("custom_rules"); + JsonSerializer.Serialize(writer, CustomRulesValue, options); + } + + if (!string.IsNullOrEmpty(DescriptionValue)) + { + writer.WritePropertyName("description"); + writer.WriteStringValue(DescriptionValue); + } + + writer.WritePropertyName("detector_index"); + writer.WriteNumberValue(DetectorIndexValue); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ExponentialAverageCalculationContext.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ExponentialAverageCalculationContext.g.cs new file mode 100644 index 00000000000..52d547b338e --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ExponentialAverageCalculationContext.g.cs @@ -0,0 +1,38 @@ +// 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.MachineLearning; + +public sealed partial class ExponentialAverageCalculationContext +{ + [JsonInclude, JsonPropertyName("incremental_metric_value_ms")] + public double IncrementalMetricValueMs { get; init; } + [JsonInclude, JsonPropertyName("latest_timestamp")] + public long? LatestTimestamp { get; init; } + [JsonInclude, JsonPropertyName("previous_exponential_average_ms")] + public double? PreviousExponentialAverageMs { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs index d14b5e81fe6..4ab30dc87a1 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs @@ -69,6 +69,8 @@ public sealed partial class FillMaskInferenceOptions /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? Tokenization { get; set; } + [JsonInclude, JsonPropertyName("vocabulary")] + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Vocabulary Vocabulary { get; set; } public static implicit operator Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigCreate(FillMaskInferenceOptions fillMaskInferenceOptions) => Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigCreate.FillMask(fillMaskInferenceOptions); } @@ -92,6 +94,9 @@ public FillMaskInferenceOptionsDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? TokenizationValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfigDescriptor TokenizationDescriptor { get; set; } private Action TokenizationDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Vocabulary VocabularyValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.VocabularyDescriptor VocabularyDescriptor { get; set; } + private Action VocabularyDescriptorAction { get; set; } /// /// @@ -159,6 +164,30 @@ public FillMaskInferenceOptionsDescriptor Tokenization(Action configure) + { + VocabularyValue = null; + VocabularyDescriptor = null; + VocabularyDescriptorAction = configure; + return Self; + } + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); @@ -196,6 +225,22 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, TokenizationValue, options); } + if (VocabularyDescriptor is not null) + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, VocabularyDescriptor, options); + } + else if (VocabularyDescriptorAction is not null) + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.VocabularyDescriptor(VocabularyDescriptorAction), options); + } + else + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, VocabularyValue, options); + } + writer.WriteEndObject(); } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Limits.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Limits.g.cs index dfd3d33bb75..43e5e559dc6 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Limits.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/Limits.g.cs @@ -30,9 +30,13 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class Limits { [JsonInclude, JsonPropertyName("effective_max_model_memory_limit")] - public string EffectiveMaxModelMemoryLimit { get; init; } + public Elastic.Clients.Elasticsearch.Serverless.ByteSize? EffectiveMaxModelMemoryLimit { get; init; } [JsonInclude, JsonPropertyName("max_model_memory_limit")] - public string? MaxModelMemoryLimit { get; init; } + public Elastic.Clients.Elasticsearch.Serverless.ByteSize? MaxModelMemoryLimit { get; init; } + [JsonInclude, JsonPropertyName("max_single_ml_node_processors")] + public int? MaxSingleMlNodeProcessors { get; init; } [JsonInclude, JsonPropertyName("total_ml_memory")] - public string TotalMlMemory { get; init; } + public Elastic.Clients.Elasticsearch.Serverless.ByteSize TotalMlMemory { get; init; } + [JsonInclude, JsonPropertyName("total_ml_processors")] + public int? TotalMlProcessors { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelPackageConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelPackageConfig.g.cs new file mode 100644 index 00000000000..3152267a8f3 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelPackageConfig.g.cs @@ -0,0 +1,60 @@ +// 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.MachineLearning; + +public sealed partial class ModelPackageConfig +{ + [JsonInclude, JsonPropertyName("create_time")] + public long? CreateTime { get; init; } + [JsonInclude, JsonPropertyName("description")] + public string? Description { get; init; } + [JsonInclude, JsonPropertyName("inference_config")] + public IReadOnlyDictionary? InferenceConfig { get; init; } + [JsonInclude, JsonPropertyName("metadata")] + public IReadOnlyDictionary? Metadata { get; init; } + [JsonInclude, JsonPropertyName("minimum_version")] + public string? MinimumVersion { get; init; } + [JsonInclude, JsonPropertyName("model_repository")] + public string? ModelRepository { get; init; } + [JsonInclude, JsonPropertyName("model_type")] + public string? ModelType { get; init; } + [JsonInclude, JsonPropertyName("packaged_model_id")] + public string PackagedModelId { get; init; } + [JsonInclude, JsonPropertyName("platform_architecture")] + public string? PlatformArchitecture { get; init; } + [JsonInclude, JsonPropertyName("prefix_strings")] + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelPrefixStrings? PrefixStrings { get; init; } + [JsonInclude, JsonPropertyName("sha256")] + public string? Sha256 { get; init; } + [JsonInclude, JsonPropertyName("size")] + public Elastic.Clients.Elasticsearch.Serverless.ByteSize? Size { get; init; } + [JsonInclude, JsonPropertyName("tags")] + public IReadOnlyCollection? Tags { get; init; } + [JsonInclude, JsonPropertyName("vocabulary_file")] + public string? VocabularyFile { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelSizeStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelSizeStats.g.cs index 911913f0982..6a4edf5c573 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelSizeStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/ModelSizeStats.g.cs @@ -55,6 +55,8 @@ public sealed partial class ModelSizeStats public Elastic.Clients.Elasticsearch.Serverless.ByteSize? ModelBytesExceeded { get; init; } [JsonInclude, JsonPropertyName("model_bytes_memory_limit")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? ModelBytesMemoryLimit { get; init; } + [JsonInclude, JsonPropertyName("output_memory_allocator_bytes")] + public Elastic.Clients.Elasticsearch.Serverless.ByteSize? OutputMemoryAllocatorBytes { get; init; } [JsonInclude, JsonPropertyName("peak_model_bytes")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? PeakModelBytes { get; init; } [JsonInclude, JsonPropertyName("rare_category_count")] diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs index 90300b1c97b..260c112a22b 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs @@ -42,6 +42,14 @@ public sealed partial class NlpRobertaTokenizationConfig [JsonInclude, JsonPropertyName("add_prefix_space")] public bool? AddPrefixSpace { get; set; } + /// + /// + /// Should the tokenizer lower case the text + /// + /// + [JsonInclude, JsonPropertyName("do_lower_case")] + public bool? DoLowerCase { get; set; } + /// /// /// Maximum input sequence length for the model @@ -91,6 +99,7 @@ public NlpRobertaTokenizationConfigDescriptor() : base() } private bool? AddPrefixSpaceValue { get; set; } + private bool? DoLowerCaseValue { get; set; } private int? MaxSequenceLengthValue { get; set; } private int? SpanValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationTruncate? TruncateValue { get; set; } @@ -107,6 +116,17 @@ public NlpRobertaTokenizationConfigDescriptor AddPrefixSpace(bool? addPrefixSpac return Self; } + /// + /// + /// Should the tokenizer lower case the text + /// + /// + public NlpRobertaTokenizationConfigDescriptor DoLowerCase(bool? doLowerCase = true) + { + DoLowerCaseValue = doLowerCase; + return Self; + } + /// /// /// Maximum input sequence length for the model @@ -160,6 +180,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteBooleanValue(AddPrefixSpaceValue.Value); } + if (DoLowerCaseValue.HasValue) + { + writer.WritePropertyName("do_lower_case"); + writer.WriteBooleanValue(DoLowerCaseValue.Value); + } + if (MaxSequenceLengthValue.HasValue) { writer.WritePropertyName("max_sequence_length"); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/OverallBucket.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/OverallBucket.g.cs index 9a9557ea98a..76bd6e84c89 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/OverallBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/OverallBucket.g.cs @@ -83,5 +83,5 @@ public sealed partial class OverallBucket /// /// [JsonInclude, JsonPropertyName("timestamp_string")] - public DateTimeOffset TimestampString { get; init; } + public DateTimeOffset? TimestampString { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs index 1ec7785d42c..06a6b317396 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs @@ -57,6 +57,8 @@ public sealed partial class TextEmbeddingInferenceOptions /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? Tokenization { get; set; } + [JsonInclude, JsonPropertyName("vocabulary")] + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Vocabulary Vocabulary { get; set; } public static implicit operator Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigCreate(TextEmbeddingInferenceOptions textEmbeddingInferenceOptions) => Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigCreate.TextEmbedding(textEmbeddingInferenceOptions); } @@ -79,6 +81,9 @@ public TextEmbeddingInferenceOptionsDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? TokenizationValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfigDescriptor TokenizationDescriptor { get; set; } private Action TokenizationDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Vocabulary VocabularyValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.VocabularyDescriptor VocabularyDescriptor { get; set; } + private Action VocabularyDescriptorAction { get; set; } /// /// @@ -131,6 +136,30 @@ public TextEmbeddingInferenceOptionsDescriptor Tokenization(Action configure) + { + VocabularyValue = null; + VocabularyDescriptor = null; + VocabularyDescriptorAction = configure; + return Self; + } + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); @@ -162,6 +191,22 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, TokenizationValue, options); } + if (VocabularyDescriptor is not null) + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, VocabularyDescriptor, options); + } + else if (VocabularyDescriptorAction is not null) + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.VocabularyDescriptor(VocabularyDescriptorAction), options); + } + else + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, VocabularyValue, options); + } + writer.WriteEndObject(); } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs index a99e3f66997..64ae8998c08 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs @@ -49,6 +49,8 @@ public sealed partial class TextExpansionInferenceOptions /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? Tokenization { get; set; } + [JsonInclude, JsonPropertyName("vocabulary")] + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Vocabulary Vocabulary { get; set; } public static implicit operator Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigCreate(TextExpansionInferenceOptions textExpansionInferenceOptions) => Elastic.Clients.Elasticsearch.Serverless.MachineLearning.InferenceConfigCreate.TextExpansion(textExpansionInferenceOptions); } @@ -70,6 +72,9 @@ public TextExpansionInferenceOptionsDescriptor() : base() private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfig? TokenizationValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TokenizationConfigDescriptor TokenizationDescriptor { get; set; } private Action TokenizationDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.Vocabulary VocabularyValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.MachineLearning.VocabularyDescriptor VocabularyDescriptor { get; set; } + private Action VocabularyDescriptorAction { get; set; } /// /// @@ -111,6 +116,30 @@ public TextExpansionInferenceOptionsDescriptor Tokenization(Action configure) + { + VocabularyValue = null; + VocabularyDescriptor = null; + VocabularyDescriptorAction = configure; + return Self; + } + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); @@ -136,6 +165,22 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, TokenizationValue, options); } + if (VocabularyDescriptor is not null) + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, VocabularyDescriptor, options); + } + else if (VocabularyDescriptorAction is not null) + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.Serverless.MachineLearning.VocabularyDescriptor(VocabularyDescriptorAction), options); + } + else + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, VocabularyValue, options); + } + writer.WriteEndObject(); } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TokenizationConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TokenizationConfig.g.cs index 5b609a8d592..fb54aca32fc 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TokenizationConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TokenizationConfig.g.cs @@ -52,6 +52,7 @@ internal TokenizationConfig(string variantName, object variant) internal string VariantName { get; } public static TokenizationConfig Bert(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => new TokenizationConfig("bert", nlpBertTokenizationConfig); + public static TokenizationConfig BertJa(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => new TokenizationConfig("bert_ja", nlpBertTokenizationConfig); public static TokenizationConfig Mpnet(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => new TokenizationConfig("mpnet", nlpBertTokenizationConfig); public static TokenizationConfig Roberta(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpRobertaTokenizationConfig nlpRobertaTokenizationConfig) => new TokenizationConfig("roberta", nlpRobertaTokenizationConfig); @@ -100,6 +101,13 @@ public override TokenizationConfig Read(ref Utf8JsonReader reader, Type typeToCo continue; } + if (propertyName == "bert_ja") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + if (propertyName == "mpnet") { variantValue = JsonSerializer.Deserialize(ref reader, options); @@ -132,6 +140,9 @@ public override void Write(Utf8JsonWriter writer, TokenizationConfig value, Json case "bert": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpBertTokenizationConfig)value.Variant, options); break; + case "bert_ja": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpBertTokenizationConfig)value.Variant, options); + break; case "mpnet": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpBertTokenizationConfig)value.Variant, options); break; @@ -178,6 +189,8 @@ private TokenizationConfigDescriptor Set(object variant, string varia public TokenizationConfigDescriptor Bert(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => Set(nlpBertTokenizationConfig, "bert"); public TokenizationConfigDescriptor Bert(Action configure) => Set(configure, "bert"); + public TokenizationConfigDescriptor BertJa(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => Set(nlpBertTokenizationConfig, "bert_ja"); + public TokenizationConfigDescriptor BertJa(Action configure) => Set(configure, "bert_ja"); public TokenizationConfigDescriptor Mpnet(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => Set(nlpBertTokenizationConfig, "mpnet"); public TokenizationConfigDescriptor Mpnet(Action configure) => Set(configure, "mpnet"); public TokenizationConfigDescriptor Roberta(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpRobertaTokenizationConfig nlpRobertaTokenizationConfig) => Set(nlpRobertaTokenizationConfig, "roberta"); @@ -236,6 +249,8 @@ private TokenizationConfigDescriptor Set(object variant, string variantName) public TokenizationConfigDescriptor Bert(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => Set(nlpBertTokenizationConfig, "bert"); public TokenizationConfigDescriptor Bert(Action configure) => Set(configure, "bert"); + public TokenizationConfigDescriptor BertJa(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => Set(nlpBertTokenizationConfig, "bert_ja"); + public TokenizationConfigDescriptor BertJa(Action configure) => Set(configure, "bert_ja"); public TokenizationConfigDescriptor Mpnet(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => Set(nlpBertTokenizationConfig, "mpnet"); public TokenizationConfigDescriptor Mpnet(Action configure) => Set(configure, "mpnet"); public TokenizationConfigDescriptor Roberta(Elastic.Clients.Elasticsearch.Serverless.MachineLearning.NlpRobertaTokenizationConfig nlpRobertaTokenizationConfig) => Set(nlpRobertaTokenizationConfig, "roberta"); diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs index 23465b606ae..c091d8ae2a9 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelAssignment { + [JsonInclude, JsonPropertyName("adaptive_allocations")] + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AdaptiveAllocationsSettings? AdaptiveAllocations { get; init; } + /// /// /// The overall assignment state. @@ -38,6 +41,8 @@ public sealed partial class TrainedModelAssignment public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DeploymentAssignmentState AssignmentState { get; init; } [JsonInclude, JsonPropertyName("max_assigned_allocations")] public int? MaxAssignedAllocations { get; init; } + [JsonInclude, JsonPropertyName("reason")] + public string? Reason { get; init; } /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs index 8385980e2f8..7a5582dc037 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs @@ -44,7 +44,7 @@ public sealed partial class TrainedModelAssignmentRoutingTable /// /// [JsonInclude, JsonPropertyName("reason")] - public string Reason { get; init; } + public string? Reason { get; init; } /// /// diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs index 95d869c899e..180d3e5b690 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs @@ -35,7 +35,7 @@ public sealed partial class TrainedModelAssignmentTaskParameters /// /// [JsonInclude, JsonPropertyName("cache_size")] - public Elastic.Clients.Elasticsearch.Serverless.ByteSize CacheSize { get; init; } + public Elastic.Clients.Elasticsearch.Serverless.ByteSize? CacheSize { get; init; } /// /// @@ -51,7 +51,7 @@ public sealed partial class TrainedModelAssignmentTaskParameters /// /// [JsonInclude, JsonPropertyName("model_bytes")] - public int ModelBytes { get; init; } + public Elastic.Clients.Elasticsearch.Serverless.ByteSize ModelBytes { get; init; } /// /// @@ -68,6 +68,10 @@ public sealed partial class TrainedModelAssignmentTaskParameters /// [JsonInclude, JsonPropertyName("number_of_allocations")] public int NumberOfAllocations { get; init; } + [JsonInclude, JsonPropertyName("per_allocation_memory_bytes")] + public Elastic.Clients.Elasticsearch.Serverless.ByteSize PerAllocationMemoryBytes { get; init; } + [JsonInclude, JsonPropertyName("per_deployment_memory_bytes")] + public Elastic.Clients.Elasticsearch.Serverless.ByteSize PerDeploymentMemoryBytes { get; init; } [JsonInclude, JsonPropertyName("priority")] public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainingPriority Priority { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs index 9dd9ca46448..8f5496654f3 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs @@ -129,6 +129,8 @@ public sealed partial class TrainedModelConfig /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } + [JsonInclude, JsonPropertyName("model_package")] + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.ModelPackageConfig? ModelPackage { get; init; } [JsonInclude, JsonPropertyName("model_size_bytes")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? ModelSizeBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs index d4ca4f95618..b82df2b6ec2 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs @@ -35,7 +35,17 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("average_inference_time_ms")] - public double AverageInferenceTimeMs { get; init; } + public double? AverageInferenceTimeMs { get; init; } + + /// + /// + /// The average time for each inference call to complete on this node, excluding cache + /// + /// + [JsonInclude, JsonPropertyName("average_inference_time_ms_excluding_cache_hits")] + public double? AverageInferenceTimeMsExcludingCacheHits { get; init; } + [JsonInclude, JsonPropertyName("average_inference_time_ms_last_minute")] + public double? AverageInferenceTimeMsLastMinute { get; init; } /// /// @@ -43,7 +53,11 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("error_count")] - public int ErrorCount { get; init; } + public int? ErrorCount { get; init; } + [JsonInclude, JsonPropertyName("inference_cache_hit_count")] + public long? InferenceCacheHitCount { get; init; } + [JsonInclude, JsonPropertyName("inference_cache_hit_count_last_minute")] + public long? InferenceCacheHitCountLastMinute { get; init; } /// /// @@ -51,7 +65,7 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("inference_count")] - public int InferenceCount { get; init; } + public long? InferenceCount { get; init; } /// /// @@ -59,7 +73,7 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("last_access")] - public long LastAccess { get; init; } + public long? LastAccess { get; init; } /// /// @@ -67,7 +81,7 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("number_of_allocations")] - public int NumberOfAllocations { get; init; } + public int? NumberOfAllocations { get; init; } /// /// @@ -75,7 +89,9 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("number_of_pending_requests")] - public int NumberOfPendingRequests { get; init; } + public int? NumberOfPendingRequests { get; init; } + [JsonInclude, JsonPropertyName("peak_throughput_per_minute")] + public long PeakThroughputPerMinute { get; init; } /// /// @@ -83,7 +99,7 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("rejection_execution_count")] - public int RejectionExecutionCount { get; init; } + public int? RejectionExecutionCount { get; init; } /// /// @@ -99,7 +115,7 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("start_time")] - public long StartTime { get; init; } + public long? StartTime { get; init; } /// /// @@ -107,7 +123,9 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("threads_per_allocation")] - public int ThreadsPerAllocation { get; init; } + public int? ThreadsPerAllocation { get; init; } + [JsonInclude, JsonPropertyName("throughput_last_minute")] + public int ThroughputLastMinute { get; init; } /// /// @@ -115,5 +133,5 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("timeout_count")] - public int TimeoutCount { get; init; } + public int? TimeoutCount { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs index 571b619d95b..7924cefaf6c 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs @@ -29,13 +29,16 @@ namespace Elastic.Clients.Elasticsearch.Serverless.MachineLearning; public sealed partial class TrainedModelDeploymentStats { + [JsonInclude, JsonPropertyName("adaptive_allocations")] + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.AdaptiveAllocationsSettings? AdaptiveAllocations { get; init; } + /// /// /// The detailed allocation status for the deployment. /// /// [JsonInclude, JsonPropertyName("allocation_status")] - public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelDeploymentAllocationStatus AllocationStatus { get; init; } + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainedModelDeploymentAllocationStatus? AllocationStatus { get; init; } [JsonInclude, JsonPropertyName("cache_size")] public Elastic.Clients.Elasticsearch.Serverless.ByteSize? CacheSize { get; init; } @@ -53,7 +56,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("error_count")] - public int ErrorCount { get; init; } + public int? ErrorCount { get; init; } /// /// @@ -61,7 +64,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("inference_count")] - public int InferenceCount { get; init; } + public int? InferenceCount { get; init; } /// /// @@ -86,7 +89,11 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("number_of_allocations")] - public int NumberOfAllocations { get; init; } + public int? NumberOfAllocations { get; init; } + [JsonInclude, JsonPropertyName("peak_throughput_per_minute")] + public long PeakThroughputPerMinute { get; init; } + [JsonInclude, JsonPropertyName("priority")] + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.TrainingPriority Priority { get; init; } /// /// @@ -94,7 +101,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("queue_capacity")] - public int QueueCapacity { get; init; } + public int? QueueCapacity { get; init; } /// /// @@ -103,7 +110,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("reason")] - public string Reason { get; init; } + public string? Reason { get; init; } /// /// @@ -114,7 +121,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("rejected_execution_count")] - public int RejectedExecutionCount { get; init; } + public int? RejectedExecutionCount { get; init; } /// /// @@ -130,7 +137,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("state")] - public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DeploymentAssignmentState State { get; init; } + public Elastic.Clients.Elasticsearch.Serverless.MachineLearning.DeploymentAssignmentState? State { get; init; } /// /// @@ -138,7 +145,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("threads_per_allocation")] - public int ThreadsPerAllocation { get; init; } + public int? ThreadsPerAllocation { get; init; } /// /// @@ -146,5 +153,5 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("timeout_count")] - public int TimeoutCount { get; init; } + public int? TimeoutCount { get; init; } } \ No newline at end of file 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 3010b77459a..30917b79567 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/PassthroughObjectProperty.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/PassthroughObjectProperty.g.cs new file mode 100644 index 00000000000..d7451d3544d --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/PassthroughObjectProperty.g.cs @@ -0,0 +1,452 @@ +// 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.Mapping; + +public sealed partial class PassthroughObjectProperty : IProperty +{ + [JsonInclude, JsonPropertyName("copy_to")] + [JsonConverter(typeof(SingleOrManyFieldsConverter))] + public Elastic.Clients.Elasticsearch.Serverless.Fields? CopyTo { get; set; } + [JsonInclude, JsonPropertyName("dynamic")] + public Elastic.Clients.Elasticsearch.Serverless.Mapping.DynamicMapping? Dynamic { get; set; } + [JsonInclude, JsonPropertyName("enabled")] + public bool? Enabled { get; set; } + [JsonInclude, JsonPropertyName("fields")] + public Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? Fields { get; set; } + [JsonInclude, JsonPropertyName("ignore_above")] + public int? IgnoreAbove { get; set; } + + /// + /// + /// Metadata about the field. + /// + /// + [JsonInclude, JsonPropertyName("meta")] + public IDictionary? Meta { get; set; } + [JsonInclude, JsonPropertyName("priority")] + public int? Priority { get; set; } + [JsonInclude, JsonPropertyName("properties")] + public Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? Properties { get; set; } + [JsonInclude, JsonPropertyName("store")] + public bool? Store { get; set; } + [JsonInclude, JsonPropertyName("time_series_dimension")] + public bool? TimeSeriesDimension { get; set; } + + [JsonInclude, JsonPropertyName("type")] + public string Type => "passthrough"; +} + +public sealed partial class PassthroughObjectPropertyDescriptor : SerializableDescriptor>, IBuildableDescriptor +{ + internal PassthroughObjectPropertyDescriptor(Action> configure) => configure.Invoke(this); + + public PassthroughObjectPropertyDescriptor() : base() + { + } + + private Elastic.Clients.Elasticsearch.Serverless.Fields? CopyToValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Mapping.DynamicMapping? DynamicValue { get; set; } + private bool? EnabledValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? FieldsValue { get; set; } + private int? IgnoreAboveValue { get; set; } + private IDictionary? MetaValue { get; set; } + private int? PriorityValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? PropertiesValue { get; set; } + private bool? StoreValue { get; set; } + private bool? TimeSeriesDimensionValue { get; set; } + + public PassthroughObjectPropertyDescriptor CopyTo(Elastic.Clients.Elasticsearch.Serverless.Fields? copyTo) + { + CopyToValue = copyTo; + return Self; + } + + public PassthroughObjectPropertyDescriptor Dynamic(Elastic.Clients.Elasticsearch.Serverless.Mapping.DynamicMapping? dynamic) + { + DynamicValue = dynamic; + return Self; + } + + public PassthroughObjectPropertyDescriptor Enabled(bool? enabled = true) + { + EnabledValue = enabled; + return Self; + } + + public PassthroughObjectPropertyDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? fields) + { + FieldsValue = fields; + return Self; + } + + public PassthroughObjectPropertyDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Mapping.PropertiesDescriptor descriptor) + { + FieldsValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor Fields(Action> configure) + { + var descriptor = new Elastic.Clients.Elasticsearch.Serverless.Mapping.PropertiesDescriptor(); + configure?.Invoke(descriptor); + FieldsValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor IgnoreAbove(int? ignoreAbove) + { + IgnoreAboveValue = ignoreAbove; + return Self; + } + + /// + /// + /// Metadata about the field. + /// + /// + public PassthroughObjectPropertyDescriptor Meta(Func, FluentDictionary> selector) + { + MetaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + public PassthroughObjectPropertyDescriptor Priority(int? priority) + { + PriorityValue = priority; + return Self; + } + + public PassthroughObjectPropertyDescriptor Properties(Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? properties) + { + PropertiesValue = properties; + return Self; + } + + public PassthroughObjectPropertyDescriptor Properties(Elastic.Clients.Elasticsearch.Serverless.Mapping.PropertiesDescriptor descriptor) + { + PropertiesValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor Properties(Action> configure) + { + var descriptor = new Elastic.Clients.Elasticsearch.Serverless.Mapping.PropertiesDescriptor(); + configure?.Invoke(descriptor); + PropertiesValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor Store(bool? store = true) + { + StoreValue = store; + return Self; + } + + public PassthroughObjectPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) + { + TimeSeriesDimensionValue = timeSeriesDimension; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (CopyToValue is not null) + { + writer.WritePropertyName("copy_to"); + JsonSerializer.Serialize(writer, CopyToValue, options); + } + + if (DynamicValue is not null) + { + writer.WritePropertyName("dynamic"); + JsonSerializer.Serialize(writer, DynamicValue, options); + } + + if (EnabledValue.HasValue) + { + writer.WritePropertyName("enabled"); + writer.WriteBooleanValue(EnabledValue.Value); + } + + if (FieldsValue is not null) + { + writer.WritePropertyName("fields"); + JsonSerializer.Serialize(writer, FieldsValue, options); + } + + if (IgnoreAboveValue.HasValue) + { + writer.WritePropertyName("ignore_above"); + writer.WriteNumberValue(IgnoreAboveValue.Value); + } + + if (MetaValue is not null) + { + writer.WritePropertyName("meta"); + JsonSerializer.Serialize(writer, MetaValue, options); + } + + if (PriorityValue.HasValue) + { + writer.WritePropertyName("priority"); + writer.WriteNumberValue(PriorityValue.Value); + } + + if (PropertiesValue is not null) + { + writer.WritePropertyName("properties"); + JsonSerializer.Serialize(writer, PropertiesValue, options); + } + + if (StoreValue.HasValue) + { + writer.WritePropertyName("store"); + writer.WriteBooleanValue(StoreValue.Value); + } + + if (TimeSeriesDimensionValue.HasValue) + { + writer.WritePropertyName("time_series_dimension"); + writer.WriteBooleanValue(TimeSeriesDimensionValue.Value); + } + + writer.WritePropertyName("type"); + writer.WriteStringValue("passthrough"); + writer.WriteEndObject(); + } + + PassthroughObjectProperty IBuildableDescriptor.Build() => new() + { + CopyTo = CopyToValue, + Dynamic = DynamicValue, + Enabled = EnabledValue, + Fields = FieldsValue, + IgnoreAbove = IgnoreAboveValue, + Meta = MetaValue, + Priority = PriorityValue, + Properties = PropertiesValue, + Store = StoreValue, + TimeSeriesDimension = TimeSeriesDimensionValue + }; +} + +public sealed partial class PassthroughObjectPropertyDescriptor : SerializableDescriptor, IBuildableDescriptor +{ + internal PassthroughObjectPropertyDescriptor(Action configure) => configure.Invoke(this); + + public PassthroughObjectPropertyDescriptor() : base() + { + } + + private Elastic.Clients.Elasticsearch.Serverless.Fields? CopyToValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Mapping.DynamicMapping? DynamicValue { get; set; } + private bool? EnabledValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? FieldsValue { get; set; } + private int? IgnoreAboveValue { get; set; } + private IDictionary? MetaValue { get; set; } + private int? PriorityValue { get; set; } + private Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? PropertiesValue { get; set; } + private bool? StoreValue { get; set; } + private bool? TimeSeriesDimensionValue { get; set; } + + public PassthroughObjectPropertyDescriptor CopyTo(Elastic.Clients.Elasticsearch.Serverless.Fields? copyTo) + { + CopyToValue = copyTo; + return Self; + } + + public PassthroughObjectPropertyDescriptor Dynamic(Elastic.Clients.Elasticsearch.Serverless.Mapping.DynamicMapping? dynamic) + { + DynamicValue = dynamic; + return Self; + } + + public PassthroughObjectPropertyDescriptor Enabled(bool? enabled = true) + { + EnabledValue = enabled; + return Self; + } + + public PassthroughObjectPropertyDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? fields) + { + FieldsValue = fields; + return Self; + } + + public PassthroughObjectPropertyDescriptor Fields(Elastic.Clients.Elasticsearch.Serverless.Mapping.PropertiesDescriptor descriptor) + { + FieldsValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor Fields(Action> configure) + { + var descriptor = new Elastic.Clients.Elasticsearch.Serverless.Mapping.PropertiesDescriptor(); + configure?.Invoke(descriptor); + FieldsValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor IgnoreAbove(int? ignoreAbove) + { + IgnoreAboveValue = ignoreAbove; + return Self; + } + + /// + /// + /// Metadata about the field. + /// + /// + public PassthroughObjectPropertyDescriptor Meta(Func, FluentDictionary> selector) + { + MetaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + public PassthroughObjectPropertyDescriptor Priority(int? priority) + { + PriorityValue = priority; + return Self; + } + + public PassthroughObjectPropertyDescriptor Properties(Elastic.Clients.Elasticsearch.Serverless.Mapping.Properties? properties) + { + PropertiesValue = properties; + return Self; + } + + public PassthroughObjectPropertyDescriptor Properties(Elastic.Clients.Elasticsearch.Serverless.Mapping.PropertiesDescriptor descriptor) + { + PropertiesValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor Properties(Action> configure) + { + var descriptor = new Elastic.Clients.Elasticsearch.Serverless.Mapping.PropertiesDescriptor(); + configure?.Invoke(descriptor); + PropertiesValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor Store(bool? store = true) + { + StoreValue = store; + return Self; + } + + public PassthroughObjectPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) + { + TimeSeriesDimensionValue = timeSeriesDimension; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (CopyToValue is not null) + { + writer.WritePropertyName("copy_to"); + JsonSerializer.Serialize(writer, CopyToValue, options); + } + + if (DynamicValue is not null) + { + writer.WritePropertyName("dynamic"); + JsonSerializer.Serialize(writer, DynamicValue, options); + } + + if (EnabledValue.HasValue) + { + writer.WritePropertyName("enabled"); + writer.WriteBooleanValue(EnabledValue.Value); + } + + if (FieldsValue is not null) + { + writer.WritePropertyName("fields"); + JsonSerializer.Serialize(writer, FieldsValue, options); + } + + if (IgnoreAboveValue.HasValue) + { + writer.WritePropertyName("ignore_above"); + writer.WriteNumberValue(IgnoreAboveValue.Value); + } + + if (MetaValue is not null) + { + writer.WritePropertyName("meta"); + JsonSerializer.Serialize(writer, MetaValue, options); + } + + if (PriorityValue.HasValue) + { + writer.WritePropertyName("priority"); + writer.WriteNumberValue(PriorityValue.Value); + } + + if (PropertiesValue is not null) + { + writer.WritePropertyName("properties"); + JsonSerializer.Serialize(writer, PropertiesValue, options); + } + + if (StoreValue.HasValue) + { + writer.WritePropertyName("store"); + writer.WriteBooleanValue(StoreValue.Value); + } + + if (TimeSeriesDimensionValue.HasValue) + { + writer.WritePropertyName("time_series_dimension"); + writer.WriteBooleanValue(TimeSeriesDimensionValue.Value); + } + + writer.WritePropertyName("type"); + writer.WriteStringValue("passthrough"); + writer.WriteEndObject(); + } + + PassthroughObjectProperty IBuildableDescriptor.Build() => new() + { + CopyTo = CopyToValue, + Dynamic = DynamicValue, + Enabled = EnabledValue, + Fields = FieldsValue, + IgnoreAbove = IgnoreAboveValue, + Meta = MetaValue, + Priority = PriorityValue, + Properties = PropertiesValue, + Store = StoreValue, + TimeSeriesDimension = TimeSeriesDimensionValue + }; +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/Properties.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/Properties.g.cs index f856980eabb..1b9d4985eae 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/Properties.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Mapping/Properties.g.cs @@ -236,6 +236,11 @@ public PropertiesDescriptor() : base(new Properties()) public PropertiesDescriptor Object(Elastic.Clients.Elasticsearch.Serverless.PropertyName propertyName, ObjectProperty objectProperty) => AssignVariant(propertyName, objectProperty); public PropertiesDescriptor Object(Expression> propertyName) => AssignVariant, ObjectProperty>(propertyName, null); public PropertiesDescriptor Object(Expression> propertyName, Action> configure) => AssignVariant, ObjectProperty>(propertyName, configure); + public PropertiesDescriptor PassthroughObject(Elastic.Clients.Elasticsearch.Serverless.PropertyName propertyName) => AssignVariant, PassthroughObjectProperty>(propertyName, null); + public PropertiesDescriptor PassthroughObject(Elastic.Clients.Elasticsearch.Serverless.PropertyName propertyName, Action> configure) => AssignVariant, PassthroughObjectProperty>(propertyName, configure); + public PropertiesDescriptor PassthroughObject(Elastic.Clients.Elasticsearch.Serverless.PropertyName propertyName, PassthroughObjectProperty passthroughObjectProperty) => AssignVariant(propertyName, passthroughObjectProperty); + public PropertiesDescriptor PassthroughObject(Expression> propertyName) => AssignVariant, PassthroughObjectProperty>(propertyName, null); + public PropertiesDescriptor PassthroughObject(Expression> propertyName, Action> configure) => AssignVariant, PassthroughObjectProperty>(propertyName, configure); public PropertiesDescriptor Percolator(Elastic.Clients.Elasticsearch.Serverless.PropertyName propertyName) => AssignVariant, PercolatorProperty>(propertyName, null); public PropertiesDescriptor Percolator(Elastic.Clients.Elasticsearch.Serverless.PropertyName propertyName, Action> configure) => AssignVariant, PercolatorProperty>(propertyName, configure); public PropertiesDescriptor Percolator(Elastic.Clients.Elasticsearch.Serverless.PropertyName propertyName, PercolatorProperty percolatorProperty) => AssignVariant(propertyName, percolatorProperty); @@ -395,6 +400,8 @@ public override IProperty Read(ref Utf8JsonReader reader, Type typeToConvert, Js return JsonSerializer.Deserialize(ref reader, options); case "object": return JsonSerializer.Deserialize(ref reader, options); + case "passthrough": + return JsonSerializer.Deserialize(ref reader, options); case "percolator": return JsonSerializer.Deserialize(ref reader, options); case "point": @@ -542,6 +549,9 @@ public override void Write(Utf8JsonWriter writer, IProperty value, JsonSerialize case "object": JsonSerializer.Serialize(writer, value, typeof(Elastic.Clients.Elasticsearch.Serverless.Mapping.ObjectProperty), options); return; + case "passthrough": + JsonSerializer.Serialize(writer, value, typeof(Elastic.Clients.Elasticsearch.Serverless.Mapping.PassthroughObjectProperty), options); + return; case "percolator": JsonSerializer.Serialize(writer, value, typeof(Elastic.Clients.Elasticsearch.Serverless.Mapping.PercolatorProperty), options); return; 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 814616b3ad7..18ab1659da1 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/Nodes/NodeInfoPath.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeInfoPath.g.cs index b338a0ace56..c176bb5a08f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeInfoPath.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Nodes/NodeInfoPath.g.cs @@ -30,6 +30,7 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Nodes; public sealed partial class NodeInfoPath { [JsonInclude, JsonPropertyName("data")] + [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection? Data { get; init; } [JsonInclude, JsonPropertyName("home")] public string? Home { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateRangeQuery.g.cs index 883b305c719..685edc8185f 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/DateRangeQuery.g.cs @@ -54,12 +54,6 @@ public override DateRangeQuery Read(ref Utf8JsonReader reader, Type typeToConver continue; } - if (property == "from") - { - variant.From = JsonSerializer.Deserialize(ref reader, options); - continue; - } - if (property == "gt") { variant.Gt = JsonSerializer.Deserialize(ref reader, options); @@ -101,12 +95,6 @@ public override DateRangeQuery Read(ref Utf8JsonReader reader, Type typeToConver variant.TimeZone = JsonSerializer.Deserialize(ref reader, options); continue; } - - if (property == "to") - { - variant.To = JsonSerializer.Deserialize(ref reader, options); - continue; - } } } @@ -135,12 +123,6 @@ public override void Write(Utf8JsonWriter writer, DateRangeQuery value, JsonSeri writer.WriteStringValue(value.Format); } - if (value.From is not null) - { - writer.WritePropertyName("from"); - JsonSerializer.Serialize(writer, value.From, options); - } - if (value.Gt is not null) { writer.WritePropertyName("gt"); @@ -183,12 +165,6 @@ public override void Write(Utf8JsonWriter writer, DateRangeQuery value, JsonSeri writer.WriteStringValue(value.TimeZone); } - if (value.To is not null) - { - writer.WritePropertyName("to"); - JsonSerializer.Serialize(writer, value.To, options); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -221,7 +197,6 @@ public DateRangeQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) /// /// public string? Format { get; set; } - public Elastic.Clients.Elasticsearch.Serverless.DateMath? From { get; set; } /// /// @@ -265,7 +240,6 @@ public DateRangeQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) /// /// public string? TimeZone { get; set; } - public Elastic.Clients.Elasticsearch.Serverless.DateMath? To { get; set; } } public sealed partial class DateRangeQueryDescriptor : SerializableDescriptor> @@ -279,7 +253,6 @@ public DateRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } private string? FormatValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.DateMath? FromValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.DateMath? GtValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.DateMath? GteValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.DateMath? LtValue { get; set; } @@ -287,7 +260,6 @@ public DateRangeQueryDescriptor() : base() private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? RelationValue { get; set; } private string? TimeZoneValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.DateMath? ToValue { get; set; } /// /// @@ -332,12 +304,6 @@ public DateRangeQueryDescriptor Format(string? format) return Self; } - public DateRangeQueryDescriptor From(Elastic.Clients.Elasticsearch.Serverless.DateMath? from) - { - FromValue = from; - return Self; - } - /// /// /// Greater than. @@ -410,12 +376,6 @@ public DateRangeQueryDescriptor TimeZone(string? timeZone) return Self; } - public DateRangeQueryDescriptor To(Elastic.Clients.Elasticsearch.Serverless.DateMath? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -435,12 +395,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(FormatValue); } - if (FromValue is not null) - { - writer.WritePropertyName("from"); - JsonSerializer.Serialize(writer, FromValue, options); - } - if (GtValue is not null) { writer.WritePropertyName("gt"); @@ -483,12 +437,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(TimeZoneValue); } - if (ToValue is not null) - { - writer.WritePropertyName("to"); - JsonSerializer.Serialize(writer, ToValue, options); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -505,7 +453,6 @@ public DateRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } private string? FormatValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.DateMath? FromValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.DateMath? GtValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.DateMath? GteValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.DateMath? LtValue { get; set; } @@ -513,7 +460,6 @@ public DateRangeQueryDescriptor() : base() private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? RelationValue { get; set; } private string? TimeZoneValue { get; set; } - private Elastic.Clients.Elasticsearch.Serverless.DateMath? ToValue { get; set; } /// /// @@ -558,12 +504,6 @@ public DateRangeQueryDescriptor Format(string? format) return Self; } - public DateRangeQueryDescriptor From(Elastic.Clients.Elasticsearch.Serverless.DateMath? from) - { - FromValue = from; - return Self; - } - /// /// /// Greater than. @@ -636,12 +576,6 @@ public DateRangeQueryDescriptor TimeZone(string? timeZone) return Self; } - public DateRangeQueryDescriptor To(Elastic.Clients.Elasticsearch.Serverless.DateMath? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -661,12 +595,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(FormatValue); } - if (FromValue is not null) - { - writer.WritePropertyName("from"); - JsonSerializer.Serialize(writer, FromValue, options); - } - if (GtValue is not null) { writer.WritePropertyName("gt"); @@ -709,12 +637,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(TimeZoneValue); } - if (ToValue is not null) - { - writer.WritePropertyName("to"); - JsonSerializer.Serialize(writer, ToValue, options); - } - writer.WriteEndObject(); writer.WriteEndObject(); } 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 afdf01fd760..589de265849 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/NumberRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs index 79bcf0a8336..66640e3d2f5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs @@ -48,12 +48,6 @@ public override NumberRangeQuery Read(ref Utf8JsonReader reader, Type typeToConv continue; } - if (property == "from") - { - variant.From = JsonSerializer.Deserialize(ref reader, options); - continue; - } - if (property == "gt") { variant.Gt = JsonSerializer.Deserialize(ref reader, options); @@ -89,12 +83,6 @@ public override NumberRangeQuery Read(ref Utf8JsonReader reader, Type typeToConv variant.Relation = JsonSerializer.Deserialize(ref reader, options); continue; } - - if (property == "to") - { - variant.To = JsonSerializer.Deserialize(ref reader, options); - continue; - } } } @@ -117,12 +105,6 @@ public override void Write(Utf8JsonWriter writer, NumberRangeQuery value, JsonSe writer.WriteNumberValue(value.Boost.Value); } - if (value.From.HasValue) - { - writer.WritePropertyName("from"); - writer.WriteNumberValue(value.From.Value); - } - if (value.Gt.HasValue) { writer.WritePropertyName("gt"); @@ -159,12 +141,6 @@ public override void Write(Utf8JsonWriter writer, NumberRangeQuery value, JsonSe JsonSerializer.Serialize(writer, value.Relation, options); } - if (value.To.HasValue) - { - writer.WritePropertyName("to"); - writer.WriteNumberValue(value.To.Value); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -190,7 +166,6 @@ public NumberRangeQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } - public double? From { get; set; } /// /// @@ -227,7 +202,6 @@ public NumberRangeQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? Relation { get; set; } - public double? To { get; set; } } public sealed partial class NumberRangeQueryDescriptor : SerializableDescriptor> @@ -240,14 +214,12 @@ public NumberRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } - private double? FromValue { get; set; } private double? GtValue { get; set; } private double? GteValue { get; set; } private double? LtValue { get; set; } private double? LteValue { get; set; } private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? RelationValue { get; set; } - private double? ToValue { get; set; } /// /// @@ -281,12 +253,6 @@ public NumberRangeQueryDescriptor Field(Expression From(double? from) - { - FromValue = from; - return Self; - } - /// /// /// Greater than. @@ -348,12 +314,6 @@ public NumberRangeQueryDescriptor Relation(Elastic.Clients.Elasticsea return Self; } - public NumberRangeQueryDescriptor To(double? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -367,12 +327,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(BoostValue.Value); } - if (FromValue.HasValue) - { - writer.WritePropertyName("from"); - writer.WriteNumberValue(FromValue.Value); - } - if (GtValue.HasValue) { writer.WritePropertyName("gt"); @@ -409,12 +363,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, RelationValue, options); } - if (ToValue.HasValue) - { - writer.WritePropertyName("to"); - writer.WriteNumberValue(ToValue.Value); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -430,14 +378,12 @@ public NumberRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } - private double? FromValue { get; set; } private double? GtValue { get; set; } private double? GteValue { get; set; } private double? LtValue { get; set; } private double? LteValue { get; set; } private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? RelationValue { get; set; } - private double? ToValue { get; set; } /// /// @@ -471,12 +417,6 @@ public NumberRangeQueryDescriptor Field(Expression /// /// Greater than. @@ -538,12 +478,6 @@ public NumberRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverl return Self; } - public NumberRangeQueryDescriptor To(double? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -557,12 +491,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(BoostValue.Value); } - if (FromValue.HasValue) - { - writer.WritePropertyName("from"); - writer.WriteNumberValue(FromValue.Value); - } - if (GtValue.HasValue) { writer.WritePropertyName("gt"); @@ -599,12 +527,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, RelationValue, options); } - if (ToValue.HasValue) - { - writer.WritePropertyName("to"); - writer.WriteNumberValue(ToValue.Value); - } - writer.WriteEndObject(); writer.WriteEndObject(); } 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 dda17d5a3bb..a4fda513598 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/TermRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermRangeQuery.g.cs index c400307d398..538911f2a18 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/TermRangeQuery.g.cs @@ -48,12 +48,6 @@ public override TermRangeQuery Read(ref Utf8JsonReader reader, Type typeToConver continue; } - if (property == "from") - { - variant.From = JsonSerializer.Deserialize(ref reader, options); - continue; - } - if (property == "gt") { variant.Gt = JsonSerializer.Deserialize(ref reader, options); @@ -89,12 +83,6 @@ public override TermRangeQuery Read(ref Utf8JsonReader reader, Type typeToConver variant.Relation = JsonSerializer.Deserialize(ref reader, options); continue; } - - if (property == "to") - { - variant.To = JsonSerializer.Deserialize(ref reader, options); - continue; - } } } @@ -117,12 +105,6 @@ public override void Write(Utf8JsonWriter writer, TermRangeQuery value, JsonSeri writer.WriteNumberValue(value.Boost.Value); } - if (!string.IsNullOrEmpty(value.From)) - { - writer.WritePropertyName("from"); - writer.WriteStringValue(value.From); - } - if (!string.IsNullOrEmpty(value.Gt)) { writer.WritePropertyName("gt"); @@ -159,12 +141,6 @@ public override void Write(Utf8JsonWriter writer, TermRangeQuery value, JsonSeri JsonSerializer.Serialize(writer, value.Relation, options); } - if (!string.IsNullOrEmpty(value.To)) - { - writer.WritePropertyName("to"); - writer.WriteStringValue(value.To); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -190,7 +166,6 @@ public TermRangeQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Serverless.Field Field { get; set; } - public string? From { get; set; } /// /// @@ -227,7 +202,6 @@ public TermRangeQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) /// /// public Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? Relation { get; set; } - public string? To { get; set; } } public sealed partial class TermRangeQueryDescriptor : SerializableDescriptor> @@ -240,14 +214,12 @@ public TermRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } - private string? FromValue { get; set; } private string? GtValue { get; set; } private string? GteValue { get; set; } private string? LtValue { get; set; } private string? LteValue { get; set; } private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? RelationValue { get; set; } - private string? ToValue { get; set; } /// /// @@ -281,12 +253,6 @@ public TermRangeQueryDescriptor Field(Expression From(string? from) - { - FromValue = from; - return Self; - } - /// /// /// Greater than. @@ -348,12 +314,6 @@ public TermRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearc return Self; } - public TermRangeQueryDescriptor To(string? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -367,12 +327,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(BoostValue.Value); } - if (!string.IsNullOrEmpty(FromValue)) - { - writer.WritePropertyName("from"); - writer.WriteStringValue(FromValue); - } - if (!string.IsNullOrEmpty(GtValue)) { writer.WritePropertyName("gt"); @@ -409,12 +363,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, RelationValue, options); } - if (!string.IsNullOrEmpty(ToValue)) - { - writer.WritePropertyName("to"); - writer.WriteStringValue(ToValue); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -430,14 +378,12 @@ public TermRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } - private string? FromValue { get; set; } private string? GtValue { get; set; } private string? GteValue { get; set; } private string? LtValue { get; set; } private string? LteValue { get; set; } private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? RelationValue { get; set; } - private string? ToValue { get; set; } /// /// @@ -471,12 +417,6 @@ public TermRangeQueryDescriptor Field(Expression /// /// Greater than. @@ -538,12 +478,6 @@ public TermRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.Serverles return Self; } - public TermRangeQueryDescriptor To(string? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -557,12 +491,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(BoostValue.Value); } - if (!string.IsNullOrEmpty(FromValue)) - { - writer.WritePropertyName("from"); - writer.WriteStringValue(FromValue); - } - if (!string.IsNullOrEmpty(GtValue)) { writer.WritePropertyName("gt"); @@ -599,12 +527,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, RelationValue, options); } - if (!string.IsNullOrEmpty(ToValue)) - { - writer.WritePropertyName("to"); - writer.WriteStringValue(ToValue); - } - writer.WriteEndObject(); writer.WriteEndObject(); } 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 c40bc83f2ba..ed80e1a50a8 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 c81b812bd62..00000000000 --- 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 d88690d7268..00000000000 --- 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/UntypedRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs index 71c878320d6..4a324ee690e 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs @@ -54,12 +54,6 @@ public override UntypedRangeQuery Read(ref Utf8JsonReader reader, Type typeToCon continue; } - if (property == "from") - { - variant.From = JsonSerializer.Deserialize(ref reader, options); - continue; - } - if (property == "gt") { variant.Gt = JsonSerializer.Deserialize(ref reader, options); @@ -101,12 +95,6 @@ public override UntypedRangeQuery Read(ref Utf8JsonReader reader, Type typeToCon variant.TimeZone = JsonSerializer.Deserialize(ref reader, options); continue; } - - if (property == "to") - { - variant.To = JsonSerializer.Deserialize(ref reader, options); - continue; - } } } @@ -135,12 +123,6 @@ public override void Write(Utf8JsonWriter writer, UntypedRangeQuery value, JsonS writer.WriteStringValue(value.Format); } - if (value.From is not null) - { - writer.WritePropertyName("from"); - JsonSerializer.Serialize(writer, value.From, options); - } - if (value.Gt is not null) { writer.WritePropertyName("gt"); @@ -183,12 +165,6 @@ public override void Write(Utf8JsonWriter writer, UntypedRangeQuery value, JsonS writer.WriteStringValue(value.TimeZone); } - if (value.To is not null) - { - writer.WritePropertyName("to"); - JsonSerializer.Serialize(writer, value.To, options); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -221,7 +197,6 @@ public UntypedRangeQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) /// /// public string? Format { get; set; } - public object? From { get; set; } /// /// @@ -265,7 +240,6 @@ public UntypedRangeQuery(Elastic.Clients.Elasticsearch.Serverless.Field field) /// /// public string? TimeZone { get; set; } - public object? To { get; set; } } public sealed partial class UntypedRangeQueryDescriptor : SerializableDescriptor> @@ -279,7 +253,6 @@ public UntypedRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } private string? FormatValue { get; set; } - private object? FromValue { get; set; } private object? GtValue { get; set; } private object? GteValue { get; set; } private object? LtValue { get; set; } @@ -287,7 +260,6 @@ public UntypedRangeQueryDescriptor() : base() private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? RelationValue { get; set; } private string? TimeZoneValue { get; set; } - private object? ToValue { get; set; } /// /// @@ -332,12 +304,6 @@ public UntypedRangeQueryDescriptor Format(string? format) return Self; } - public UntypedRangeQueryDescriptor From(object? from) - { - FromValue = from; - return Self; - } - /// /// /// Greater than. @@ -410,12 +376,6 @@ public UntypedRangeQueryDescriptor TimeZone(string? timeZone) return Self; } - public UntypedRangeQueryDescriptor To(object? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -435,12 +395,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(FormatValue); } - if (FromValue is not null) - { - writer.WritePropertyName("from"); - JsonSerializer.Serialize(writer, FromValue, options); - } - if (GtValue is not null) { writer.WritePropertyName("gt"); @@ -483,12 +437,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(TimeZoneValue); } - if (ToValue is not null) - { - writer.WritePropertyName("to"); - JsonSerializer.Serialize(writer, ToValue, options); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -505,7 +453,6 @@ public UntypedRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.Field FieldValue { get; set; } private string? FormatValue { get; set; } - private object? FromValue { get; set; } private object? GtValue { get; set; } private object? GteValue { get; set; } private object? LtValue { get; set; } @@ -513,7 +460,6 @@ public UntypedRangeQueryDescriptor() : base() private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.Serverless.QueryDsl.RangeRelation? RelationValue { get; set; } private string? TimeZoneValue { get; set; } - private object? ToValue { get; set; } /// /// @@ -558,12 +504,6 @@ public UntypedRangeQueryDescriptor Format(string? format) return Self; } - public UntypedRangeQueryDescriptor From(object? from) - { - FromValue = from; - return Self; - } - /// /// /// Greater than. @@ -636,12 +576,6 @@ public UntypedRangeQueryDescriptor TimeZone(string? timeZone) return Self; } - public UntypedRangeQueryDescriptor To(object? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -661,12 +595,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(FormatValue); } - if (FromValue is not null) - { - writer.WritePropertyName("from"); - JsonSerializer.Serialize(writer, FromValue, options); - } - if (GtValue is not null) { writer.WritePropertyName("gt"); @@ -709,12 +637,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(TimeZoneValue); } - if (ToValue is not null) - { - writer.WritePropertyName("to"); - JsonSerializer.Serialize(writer, ToValue, options); - } - writer.WriteEndObject(); writer.WriteEndObject(); } 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 7a6599a9d21..00000000000 --- 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/QueryRulesetListItem.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs index 5c37963523b..68c61bb2325 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs @@ -31,7 +31,7 @@ public sealed partial class QueryRulesetListItem { /// /// - /// A map of criteria type to the number of rules of that type + /// A map of criteria type (e.g. exact) to the number of rules of that type /// /// [JsonInclude, JsonPropertyName("rule_criteria_types_counts")] @@ -52,4 +52,12 @@ public sealed partial class QueryRulesetListItem /// [JsonInclude, JsonPropertyName("rule_total_count")] public int RuleTotalCount { get; init; } + + /// + /// + /// A map of rule type (e.g. pinned) to the number of rules of that type + /// + /// + [JsonInclude, JsonPropertyName("rule_type_counts")] + public IReadOnlyDictionary RuleTypeCounts { get; init; } } \ 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 00000000000..1cd9ee2facd --- /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 574be5754ea..100f1f40cc2 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 3c887d29e8e..f6ba60c8271 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 00000000000..d4b7c4c0874 --- /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/Access.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/Access.g.cs new file mode 100644 index 00000000000..85cb5f9fb10 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/Access.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.Security; + +public sealed partial class Access +{ + /// + /// + /// A list of indices permission entries for cross-cluster replication. + /// + /// + [JsonInclude, JsonPropertyName("replication")] + public IReadOnlyCollection? Replication { get; init; } + + /// + /// + /// A list of indices permission entries for cross-cluster search. + /// + /// + [JsonInclude, JsonPropertyName("search")] + public IReadOnlyCollection? Search { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/ApiKey.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/ApiKey.g.cs index c31021053fd..78b78a2e8be 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/ApiKey.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/ApiKey.g.cs @@ -29,13 +29,24 @@ namespace Elastic.Clients.Elasticsearch.Serverless.Security; public sealed partial class ApiKey { + /// + /// + /// The access granted to cross-cluster API keys. + /// 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.Serverless.Security.Access? Access { get; init; } + /// /// /// Creation time for the API key in milliseconds. /// /// [JsonInclude, JsonPropertyName("creation")] - public long? Creation { get; init; } + public long Creation { get; init; } /// /// @@ -60,7 +71,15 @@ public sealed partial class ApiKey /// /// [JsonInclude, JsonPropertyName("invalidated")] - public bool? Invalidated { get; init; } + public bool Invalidated { get; init; } + + /// + /// + /// If the key has been invalidated, invalidation time in milliseconds. + /// + /// + [JsonInclude, JsonPropertyName("invalidation")] + public long? Invalidation { get; init; } /// /// @@ -78,7 +97,7 @@ public sealed partial class ApiKey /// /// [JsonInclude, JsonPropertyName("metadata")] - public IReadOnlyDictionary? Metadata { get; init; } + public IReadOnlyDictionary Metadata { get; init; } /// /// @@ -102,7 +121,7 @@ public sealed partial class ApiKey /// /// [JsonInclude, JsonPropertyName("realm")] - public string? Realm { get; init; } + public string Realm { get; init; } /// /// @@ -120,14 +139,28 @@ public sealed partial class ApiKey /// [JsonInclude, JsonPropertyName("role_descriptors")] public IReadOnlyDictionary? RoleDescriptors { get; init; } + + /// + /// + /// Sorting values when using the sort parameter with the security.query_api_keys API. + /// + /// [JsonInclude, JsonPropertyName("_sort")] public IReadOnlyCollection? Sort { get; init; } + /// + /// + /// The type of the API key (e.g. rest or cross_cluster). + /// + /// + [JsonInclude, JsonPropertyName("type")] + public Elastic.Clients.Elasticsearch.Serverless.Security.ApiKeyType Type { get; init; } + /// /// /// Principal for which this API key was created /// /// [JsonInclude, JsonPropertyName("username")] - public string? Username { get; init; } + public string Username { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/AuthenticateApiKey.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/AuthenticateApiKey.g.cs new file mode 100644 index 00000000000..37074c34dfd --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/AuthenticateApiKey.g.cs @@ -0,0 +1,36 @@ +// 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 AuthenticateApiKey +{ + [JsonInclude, JsonPropertyName("id")] + public string Id { 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/Security/IndicesPrivileges.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/IndicesPrivileges.g.cs index 8bf956852fc..45feac6f03e 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 1d0d895ca52..2c717cdc12d 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/ReplicationAccess.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/ReplicationAccess.g.cs new file mode 100644 index 00000000000..dfcd8cadd9d --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/ReplicationAccess.g.cs @@ -0,0 +1,48 @@ +// 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 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; init; } + + /// + /// + /// A list of indices (or index name patterns) to which the permissions in this entry apply. + /// + /// + [JsonInclude, JsonPropertyName("names")] + [SingleOrManyCollectionConverter(typeof(string))] + public IReadOnlyCollection Names { get; init; } +} \ No newline at end of file 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 00000000000..0058fc7d327 --- /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 f78d20713c7..96d69e55dd4 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 237f24160fb..d12ecb7310e 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 d34a6045e38..34ef826b7ef 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/SearchAccess.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/SearchAccess.g.cs new file mode 100644 index 00000000000..ad56f8bdb5d --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Security/SearchAccess.g.cs @@ -0,0 +1,56 @@ +// 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 SearchAccess +{ + /// + /// + /// The document fields that the owners of the role have read access to. + /// + /// + [JsonInclude, JsonPropertyName("field_security")] + public Elastic.Clients.Elasticsearch.Serverless.Security.FieldSecurity? FieldSecurity { get; init; } + + /// + /// + /// A list of indices (or index name patterns) to which the permissions in this entry apply. + /// + /// + [JsonInclude, JsonPropertyName("names")] + [SingleOrManyCollectionConverter(typeof(string))] + public IReadOnlyCollection Names { get; init; } + + /// + /// + /// 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; init; } +} \ No newline at end of file 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 10deebc1689..3693ef101e1 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/Tasks/ParentTaskInfo.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/ParentTaskInfo.g.cs index 11a125636ed..43a33d43cd5 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/ParentTaskInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/ParentTaskInfo.g.cs @@ -37,6 +37,15 @@ public sealed partial class ParentTaskInfo public bool? Cancelled { get; init; } [JsonInclude, JsonPropertyName("children")] public IReadOnlyCollection? Children { get; init; } + + /// + /// + /// Human readable text that identifies the particular request that the task is performing. + /// For example, it might identify the search request being performed by a search task. + /// Other kinds of tasks have different descriptions, like _reindex which has the source and the destination, or _bulk which just has the number of requests and the destination indices. + /// Many requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request. + /// + /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } [JsonInclude, JsonPropertyName("headers")] @@ -56,7 +65,10 @@ public sealed partial class ParentTaskInfo /// /// - /// Task status information can vary wildly from task to task. + /// The internal status of the task, which varies from task to task. + /// The format also varies. + /// While the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes. + /// Fields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases. /// /// [JsonInclude, JsonPropertyName("status")] diff --git a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/TaskInfo.g.cs b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/TaskInfo.g.cs index e1eaca90fcf..0180c47de17 100644 --- a/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/TaskInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Types/Tasks/TaskInfo.g.cs @@ -35,6 +35,15 @@ public sealed partial class TaskInfo public bool Cancellable { get; init; } [JsonInclude, JsonPropertyName("cancelled")] public bool? Cancelled { get; init; } + + /// + /// + /// Human readable text that identifies the particular request that the task is performing. + /// For example, it might identify the search request being performed by a search task. + /// Other kinds of tasks have different descriptions, like _reindex which has the source and the destination, or _bulk which just has the number of requests and the destination indices. + /// Many requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request. + /// + /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } [JsonInclude, JsonPropertyName("headers")] @@ -54,7 +63,10 @@ public sealed partial class TaskInfo /// /// - /// Task status information can vary wildly from task to task. + /// The internal status of the task, which varies from task to task. + /// The format also varies. + /// While the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes. + /// Fields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases. /// /// [JsonInclude, JsonPropertyName("status")] 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 00000000000..c3ac989c0e2 --- /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 8fced1722fa..9b76bc470f1 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/Core/ElasticsearchClientProductRegistration.cs b/src/Elastic.Clients.Elasticsearch/Core/ElasticsearchClientProductRegistration.cs index 3f00d9bb255..6c5e75b814e 100644 --- a/src/Elastic.Clients.Elasticsearch/Core/ElasticsearchClientProductRegistration.cs +++ b/src/Elastic.Clients.Elasticsearch/Core/ElasticsearchClientProductRegistration.cs @@ -18,7 +18,7 @@ public ElasticsearchClientProductRegistration(Type markerType) : base(markerType /// /// Elastic.Clients.Elasticsearch handles 404 in its , we do not want the low level client throwing /// exceptions - /// when is enabled for 404's. The client is in charge of + /// when is enabled for 404's. The client is in charge of /// composing paths /// so a 404 never signals a wrong URL but a missing entity. /// diff --git a/src/Elastic.Clients.Elasticsearch/Elastic.Clients.Elasticsearch.csproj b/src/Elastic.Clients.Elasticsearch/Elastic.Clients.Elasticsearch.csproj index dcd3c9db9d8..782d0808216 100644 --- a/src/Elastic.Clients.Elasticsearch/Elastic.Clients.Elasticsearch.csproj +++ b/src/Elastic.Clients.Elasticsearch/Elastic.Clients.Elasticsearch.csproj @@ -15,13 +15,13 @@ true true - netstandard2.0;net462;netstandard2.1;net6.0;net8.0 + netstandard2.0;net462;netstandard2.1;net8.0 true true annotations - + diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs index 05feceafbce..31fbe774bcc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs @@ -136,12 +136,15 @@ internal static class ApiUrlLookup 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 IngestDeleteIpLocationDatabase = new ApiUrls(new[] { "_ingest/ip_location/database/{id}" }); internal static ApiUrls IngestDeletePipeline = new ApiUrls(new[] { "_ingest/pipeline/{id}" }); internal static ApiUrls IngestGeoIpStats = new ApiUrls(new[] { "_ingest/geoip/stats" }); internal static ApiUrls IngestGetGeoipDatabase = new ApiUrls(new[] { "_ingest/geoip/database", "_ingest/geoip/database/{id}" }); + internal static ApiUrls IngestGetIpLocationDatabase = new ApiUrls(new[] { "_ingest/ip_location/database", "_ingest/ip_location/database/{id}" }); internal static ApiUrls IngestGetPipeline = new ApiUrls(new[] { "_ingest/pipeline", "_ingest/pipeline/{id}" }); internal static ApiUrls IngestProcessorGrok = new ApiUrls(new[] { "_ingest/processor/grok" }); internal static ApiUrls IngestPutGeoipDatabase = new ApiUrls(new[] { "_ingest/geoip/database/{id}" }); + internal static ApiUrls IngestPutIpLocationDatabase = new ApiUrls(new[] { "_ingest/ip_location/database/{id}" }); internal static ApiUrls IngestPutPipeline = new ApiUrls(new[] { "_ingest/pipeline/{id}" }); internal static ApiUrls IngestSimulate = new ApiUrls(new[] { "_ingest/pipeline/_simulate", "_ingest/pipeline/{id}/_simulate" }); internal static ApiUrls LicenseManagementDelete = new ApiUrls(new[] { "_license" }); @@ -279,6 +282,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 +314,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 +358,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 +377,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" }); @@ -390,6 +397,8 @@ internal static class ApiUrlLookup internal static ApiUrls TasksCancel = new ApiUrls(new[] { "_tasks/_cancel", "_tasks/{task_id}/_cancel" }); internal static ApiUrls TasksGet = new ApiUrls(new[] { "_tasks/{task_id}" }); internal static ApiUrls TasksList = new ApiUrls(new[] { "_tasks" }); + internal static ApiUrls TextStructureFindFieldStructure = new ApiUrls(new[] { "_text_structure/find_field_structure" }); + internal static ApiUrls TextStructureFindMessageStructure = new ApiUrls(new[] { "_text_structure/find_message_structure" }); internal static ApiUrls TextStructureTestGrokPattern = new ApiUrls(new[] { "_text_structure/test_grok_pattern" }); internal static ApiUrls TransformManagementDeleteTransform = new ApiUrls(new[] { "_transform/{transform_id}" }); internal static ApiUrls TransformManagementGetTransform = new ApiUrls(new[] { "_transform/{transform_id}", "_transform" }); 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 15213e6dde6..ed385a30bf7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs @@ -32,12 +32,21 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch; public sealed partial class AsyncSearchStatusRequestParameters : RequestParameters { + /// + /// + /// Specifies how long the async search needs to be available. + /// Ongoing async searches and any saved search results are deleted after this period. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } } /// /// -/// 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. /// /// @@ -54,12 +63,23 @@ public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => internal override bool SupportsBody => false; internal override string OperationName => "async_search.status"; + + /// + /// + /// Specifies how long the async search needs to be available. + /// Ongoing async searches and any saved search results are deleted after this period. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } } /// /// -/// 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. /// /// @@ -79,6 +99,8 @@ public AsyncSearchStatusRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : internal override string OperationName => "async_search.status"; + public AsyncSearchStatusRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration? keepAlive) => Qs("keep_alive", keepAlive); + public AsyncSearchStatusRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { RouteValues.Required("id", id); @@ -92,8 +114,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. /// /// @@ -113,6 +137,8 @@ public AsyncSearchStatusRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : internal override string OperationName => "async_search.status"; + public AsyncSearchStatusRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration? keepAlive) => Qs("keep_alive", keepAlive); + public AsyncSearchStatusRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id) { RouteValues.Required("id", id); 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 335427c3133..e59001fda74 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 7014f6ae88d..c2884fe1b43 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 070370fb9a5..db47e9c2ee2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/SubmitAsyncSearchRequest.g.cs @@ -110,14 +110,6 @@ public sealed partial class SubmitAsyncSearchRequestParameters : RequestParamete /// public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - /// - /// - /// Specifies how long the async search needs to be available. - /// Ongoing async searches and any saved search results are deleted after this period. - /// - /// - public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } - /// /// /// If true, results are stored for later retrieval when the search completes within the wait_for_completion_timeout. @@ -138,7 +130,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); } /// /// @@ -149,24 +140,23 @@ public sealed partial class SubmitAsyncSearchRequestParameters : RequestParamete /// /// - /// The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. + /// Query in the Lucene query string syntax /// /// - public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } + public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// /// - /// Query in the Lucene query string syntax + /// Specify if request cache should be used for this request or not, defaults to true /// /// - public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } + public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// /// - /// Specify if request cache should be used for this request or not, defaults to true + /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response /// /// - public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// @@ -175,7 +165,6 @@ public sealed partial class SubmitAsyncSearchRequestParameters : RequestParamete /// /// public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } - public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// /// @@ -652,10 +641,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. /// /// @@ -767,15 +762,6 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - /// - /// - /// Specifies how long the async search needs to be available. - /// Ongoing async searches and any saved search results are deleted after this period. - /// - /// - [JsonIgnore] - public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q("keep_alive"); set => Q("keep_alive", value); } - /// /// /// If true, results are stored for later retrieval when the search completes within the wait_for_completion_timeout. @@ -799,8 +785,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); } /// /// @@ -812,28 +796,26 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) /// /// - /// The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped. + /// Query in the Lucene query string syntax /// /// [JsonIgnore] - public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } + public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } /// /// - /// Query in the Lucene query string syntax + /// Specify if request cache should be used for this request or not, defaults to true /// /// [JsonIgnore] - public string? QueryLuceneSyntax { get => Q("q"); set => Q("q", value); } + public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } /// /// - /// Specify if request cache should be used for this request or not, defaults to true + /// Indicates whether hits.total should be rendered as an integer or an object in the rest search response /// /// [JsonIgnore] - public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } - [JsonIgnore] public bool? RestTotalHitsAsInt { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } /// @@ -843,8 +825,6 @@ public SubmitAsyncSearchRequest(Elastic.Clients.Elasticsearch.Indices? indices) /// [JsonIgnore] public Elastic.Clients.Elasticsearch.Routing? Routing { get => Q("routing"); set => Q("routing", value); } - [JsonIgnore] - public Elastic.Clients.Elasticsearch.Duration? Scroll { get => Q("scroll"); set => Q("scroll", value); } /// /// @@ -1145,10 +1125,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. /// /// @@ -1183,18 +1169,14 @@ public SubmitAsyncSearchRequestDescriptor() public SubmitAsyncSearchRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public SubmitAsyncSearchRequestDescriptor IgnoreThrottled(bool? ignoreThrottled = true) => Qs("ignore_throttled", ignoreThrottled); public SubmitAsyncSearchRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public SubmitAsyncSearchRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration? keepAlive) => Qs("keep_alive", keepAlive); 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); public SubmitAsyncSearchRequestDescriptor RequestCache(bool? requestCache = true) => Qs("request_cache", requestCache); public SubmitAsyncSearchRequestDescriptor RestTotalHitsAsInt(bool? restTotalHitsAsInt = true) => Qs("rest_total_hits_as_int", restTotalHitsAsInt); public SubmitAsyncSearchRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) => Qs("routing", routing); - public SubmitAsyncSearchRequestDescriptor Scroll(Elastic.Clients.Elasticsearch.Duration? scroll) => Qs("scroll", scroll); public SubmitAsyncSearchRequestDescriptor SearchType(Elastic.Clients.Elasticsearch.SearchType? searchType) => Qs("search_type", searchType); public SubmitAsyncSearchRequestDescriptor SourceExcludes(Elastic.Clients.Elasticsearch.Fields? sourceExcludes) => Qs("_source_excludes", sourceExcludes); public SubmitAsyncSearchRequestDescriptor SourceIncludes(Elastic.Clients.Elasticsearch.Fields? sourceIncludes) => Qs("_source_includes", sourceIncludes); @@ -2264,10 +2246,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. /// /// @@ -2302,18 +2290,14 @@ public SubmitAsyncSearchRequestDescriptor() public SubmitAsyncSearchRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public SubmitAsyncSearchRequestDescriptor IgnoreThrottled(bool? ignoreThrottled = true) => Qs("ignore_throttled", ignoreThrottled); public SubmitAsyncSearchRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); - public SubmitAsyncSearchRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration? keepAlive) => Qs("keep_alive", keepAlive); 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); public SubmitAsyncSearchRequestDescriptor RequestCache(bool? requestCache = true) => Qs("request_cache", requestCache); public SubmitAsyncSearchRequestDescriptor RestTotalHitsAsInt(bool? restTotalHitsAsInt = true) => Qs("rest_total_hits_as_int", restTotalHitsAsInt); public SubmitAsyncSearchRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) => Qs("routing", routing); - public SubmitAsyncSearchRequestDescriptor Scroll(Elastic.Clients.Elasticsearch.Duration? scroll) => Qs("scroll", scroll); public SubmitAsyncSearchRequestDescriptor SearchType(Elastic.Clients.Elasticsearch.SearchType? searchType) => Qs("search_type", searchType); public SubmitAsyncSearchRequestDescriptor SourceExcludes(Elastic.Clients.Elasticsearch.Fields? sourceExcludes) => Qs("_source_excludes", sourceExcludes); public SubmitAsyncSearchRequestDescriptor SourceIncludes(Elastic.Clients.Elasticsearch.Fields? sourceIncludes) => Qs("_source_includes", sourceIncludes); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/BulkRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/BulkRequest.g.cs index c845dcfd97d..6e2ebd29f2a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/BulkRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/BulkRequest.g.cs @@ -32,6 +32,13 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class BulkRequestParameters : RequestParameters { + /// + /// + /// If true, the response will include the ingest pipelines that were executed for each index or create. + /// + /// + public bool? ListExecutedPipelines { get => Q("list_executed_pipelines"); set => Q("list_executed_pipelines", value); } + /// /// /// ID of the pipeline to use to preprocess incoming documents. @@ -56,6 +63,13 @@ public sealed partial class BulkRequestParameters : RequestParameters /// public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } + /// + /// + /// If true, the request's actions must target a data stream (existing or to-be-created). + /// + /// + public bool? RequireDataStream { get => Q("require_data_stream"); set => Q("require_data_stream", value); } + /// /// /// Custom value used to route operations to a specific shard. @@ -125,6 +139,14 @@ public BulkRequest(Elastic.Clients.Elasticsearch.IndexName? index) : base(r => r internal override string OperationName => "bulk"; + /// + /// + /// If true, the response will include the ingest pipelines that were executed for each index or create. + /// + /// + [JsonIgnore] + public bool? ListExecutedPipelines { get => Q("list_executed_pipelines"); set => Q("list_executed_pipelines", value); } + /// /// /// ID of the pipeline to use to preprocess incoming documents. @@ -152,6 +174,14 @@ public BulkRequest(Elastic.Clients.Elasticsearch.IndexName? index) : base(r => r [JsonIgnore] public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } + /// + /// + /// If true, the request's actions must target a data stream (existing or to-be-created). + /// + /// + [JsonIgnore] + public bool? RequireDataStream { get => Q("require_data_stream"); set => Q("require_data_stream", value); } + /// /// /// Custom value used to route operations to a specific shard. @@ -229,9 +259,11 @@ public BulkRequestDescriptor() : this(typeof(TDocument)) internal override string OperationName => "bulk"; + public BulkRequestDescriptor ListExecutedPipelines(bool? listExecutedPipelines = true) => Qs("list_executed_pipelines", listExecutedPipelines); public BulkRequestDescriptor Pipeline(string? pipeline) => Qs("pipeline", pipeline); public BulkRequestDescriptor Refresh(Elastic.Clients.Elasticsearch.Refresh? refresh) => Qs("refresh", refresh); public BulkRequestDescriptor RequireAlias(bool? requireAlias = true) => Qs("require_alias", requireAlias); + public BulkRequestDescriptor RequireDataStream(bool? requireDataStream = true) => Qs("require_data_stream", requireDataStream); public BulkRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) => Qs("routing", routing); public BulkRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? source) => Qs("_source", source); public BulkRequestDescriptor SourceExcludes(Elastic.Clients.Elasticsearch.Fields? sourceExcludes) => Qs("_source_excludes", sourceExcludes); @@ -279,9 +311,11 @@ public BulkRequestDescriptor() internal override string OperationName => "bulk"; + public BulkRequestDescriptor ListExecutedPipelines(bool? listExecutedPipelines = true) => Qs("list_executed_pipelines", listExecutedPipelines); public BulkRequestDescriptor Pipeline(string? pipeline) => Qs("pipeline", pipeline); public BulkRequestDescriptor Refresh(Elastic.Clients.Elasticsearch.Refresh? refresh) => Qs("refresh", refresh); public BulkRequestDescriptor RequireAlias(bool? requireAlias = true) => Qs("require_alias", requireAlias); + public BulkRequestDescriptor RequireDataStream(bool? requireDataStream = true) => Qs("require_data_stream", requireDataStream); public BulkRequestDescriptor Routing(Elastic.Clients.Elasticsearch.Routing? routing) => Qs("routing", routing); public BulkRequestDescriptor Source(Elastic.Clients.Elasticsearch.Core.Search.SourceConfigParam? source) => Qs("_source", source); public BulkRequestDescriptor SourceExcludes(Elastic.Clients.Elasticsearch.Fields? sourceExcludes) => Qs("_source_excludes", sourceExcludes); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClearScrollRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ClearScrollRequest.g.cs index 44a39a87f99..156d7b50847 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 9b343cb2798..4bc64124f7a 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/Cluster/AllocationExplainRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/AllocationExplainRequest.g.cs index de7f7b38f23..23e668b1bcd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/AllocationExplainRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/AllocationExplainRequest.g.cs @@ -49,7 +49,11 @@ public sealed partial class AllocationExplainRequestParameters : RequestParamete /// /// -/// Provides explanations for shard allocations in the cluster. +/// Explain the shard allocations. +/// Get explanations for shard allocations in the cluster. +/// For unassigned shards, it provides an explanation for why the shard is unassigned. +/// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. +/// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// /// public sealed partial class AllocationExplainRequest : PlainRequest @@ -113,7 +117,11 @@ public sealed partial class AllocationExplainRequest : PlainRequest /// -/// Provides explanations for shard allocations in the cluster. +/// Explain the shard allocations. +/// Get explanations for shard allocations in the cluster. +/// For unassigned shards, it provides an explanation for why the shard is unassigned. +/// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. +/// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// /// public sealed partial class AllocationExplainRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs index 537d7315cc5..f9395e795b6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs @@ -51,8 +51,8 @@ public sealed partial class ClusterStatsRequestParameters : RequestParameters /// /// -/// 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). +/// Get cluster statistics. +/// Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// /// public sealed partial class ClusterStatsRequest : PlainRequest @@ -94,8 +94,8 @@ public ClusterStatsRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId) : base /// /// -/// 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). +/// Get cluster statistics. +/// Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). /// /// public sealed partial class ClusterStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteVotingConfigExclusionsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteVotingConfigExclusionsRequest.g.cs index d873078ca6b..b666916f7c7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteVotingConfigExclusionsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/DeleteVotingConfigExclusionsRequest.g.cs @@ -47,7 +47,8 @@ public sealed partial class DeleteVotingConfigExclusionsRequestParameters : Requ /// /// -/// Clears cluster voting config exclusions. +/// Clear cluster voting config exclusions. +/// Remove master-eligible nodes from the voting configuration exclusion list. /// /// public sealed partial class DeleteVotingConfigExclusionsRequest : PlainRequest @@ -76,7 +77,8 @@ public sealed partial class DeleteVotingConfigExclusionsRequest : PlainRequest /// -/// Clears cluster voting config exclusions. +/// Clear cluster voting config exclusions. +/// Remove master-eligible nodes from the voting configuration exclusion list. /// /// public sealed partial class DeleteVotingConfigExclusionsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs index 34fd028b7ed..c4fc5d41325 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs @@ -65,7 +65,7 @@ public sealed partial class GetClusterSettingsRequestParameters : RequestParamet /// /// -/// Returns cluster-wide settings. +/// Get cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// /// @@ -116,7 +116,7 @@ public sealed partial class GetClusterSettingsRequest : PlainRequest /// -/// Returns cluster-wide settings. +/// Get cluster-wide settings. /// By default, it returns only settings that have been explicitly defined. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/HealthRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/HealthRequest.g.cs index faa130ea035..07c6a721bf8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/HealthRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/HealthRequest.g.cs @@ -112,8 +112,18 @@ public sealed partial class HealthRequestParameters : RequestParameters /// /// -/// 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. +/// Get the cluster health status. +/// 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. Green means that all shards are allocated. +/// The index level status is controlled by the worst shard status. +/// +/// +/// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. +/// The cluster status is controlled by the worst index status. /// /// public sealed partial class HealthRequest : PlainRequest @@ -225,8 +235,18 @@ public HealthRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => /// /// -/// 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. +/// Get the cluster health status. +/// 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. Green means that all shards are allocated. +/// The index level status is controlled by the worst shard status. +/// +/// +/// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. +/// The cluster status is controlled by the worst index status. /// /// public sealed partial class HealthRequestDescriptor : RequestDescriptor, HealthRequestParameters> @@ -274,8 +294,18 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. -/// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. +/// Get the cluster health status. +/// 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. Green means that all shards are allocated. +/// The index level status is controlled by the worst shard status. +/// +/// +/// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. +/// The cluster status is controlled by the worst index status. /// /// public sealed partial class HealthRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs index bc8b02c27af..ed40db21041 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs @@ -51,9 +51,12 @@ public sealed partial class PendingTasksRequestParameters : RequestParameters /// /// -/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. +/// Get the pending cluster tasks. +/// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. +/// +/// /// NOTE: This API returns a list of any pending updates to the cluster state. -/// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. +/// 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. /// /// @@ -88,9 +91,12 @@ public sealed partial class PendingTasksRequest : PlainRequest /// -/// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. +/// Get the pending cluster tasks. +/// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. +/// +/// /// NOTE: This API returns a list of any pending updates to the cluster state. -/// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. +/// 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. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PostVotingConfigExclusionsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PostVotingConfigExclusionsRequest.g.cs index 484e1d1d922..75da7c39dae 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PostVotingConfigExclusionsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PostVotingConfigExclusionsRequest.g.cs @@ -61,7 +61,27 @@ public sealed partial class PostVotingConfigExclusionsRequestParameters : Reques /// /// -/// Updates the cluster voting config exclusions by node ids or node names. +/// Update voting configuration exclusions. +/// Update the cluster voting config exclusions by node IDs or node names. +/// By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. +/// If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. +/// The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. +/// It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. +/// +/// +/// Clusters should have no voting configuration exclusions in normal operation. +/// Once the excluded nodes have stopped, clear the voting configuration exclusions with DELETE /_cluster/voting_config_exclusions. +/// This API waits for the nodes to be fully removed from the cluster before it returns. +/// If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use DELETE /_cluster/voting_config_exclusions?wait_for_removal=false to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. +/// +/// +/// A response to POST /_cluster/voting_config_exclusions with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling DELETE /_cluster/voting_config_exclusions. +/// If the call to POST /_cluster/voting_config_exclusions fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. +/// In that case, you may safely retry the call. +/// +/// +/// NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. +/// They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. /// /// public sealed partial class PostVotingConfigExclusionsRequest : PlainRequest @@ -106,7 +126,27 @@ public sealed partial class PostVotingConfigExclusionsRequest : PlainRequest /// -/// Updates the cluster voting config exclusions by node ids or node names. +/// Update voting configuration exclusions. +/// Update the cluster voting config exclusions by node IDs or node names. +/// By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. +/// If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. +/// The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. +/// It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. +/// +/// +/// Clusters should have no voting configuration exclusions in normal operation. +/// Once the excluded nodes have stopped, clear the voting configuration exclusions with DELETE /_cluster/voting_config_exclusions. +/// This API waits for the nodes to be fully removed from the cluster before it returns. +/// If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use DELETE /_cluster/voting_config_exclusions?wait_for_removal=false to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. +/// +/// +/// A response to POST /_cluster/voting_config_exclusions with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling DELETE /_cluster/voting_config_exclusions. +/// If the call to POST /_cluster/voting_config_exclusions fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. +/// In that case, you may safely retry the call. +/// +/// +/// NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. +/// They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. /// /// public sealed partial class PostVotingConfigExclusionsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CountRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CountRequest.g.cs index 93b2d7c8823..a6dcb0989ca 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CountRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CountRequest.g.cs @@ -143,7 +143,8 @@ public sealed partial class CountRequestParameters : RequestParameters /// /// -/// Returns number of documents matching a query. +/// Count search results. +/// Get the number of documents matching a query. /// /// public partial class CountRequest : PlainRequest @@ -297,7 +298,8 @@ public CountRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => /// /// -/// Returns number of documents matching a query. +/// Count search results. +/// Get the number of documents matching a query. /// /// public sealed partial class CountRequestDescriptor : RequestDescriptor, CountRequestParameters> @@ -399,7 +401,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns number of documents matching a query. +/// Count search results. +/// Get the number of documents matching a query. /// /// public sealed partial class CountRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/CcrStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/CcrStatsRequest.g.cs index 8430cab1866..0c05bca66b6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/CcrStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/CcrStatsRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class CcrStatsRequestParameters : RequestParameters /// /// -/// Gets all stats related to cross-cluster replication. +/// Get cross-cluster replication stats. +/// This API returns stats about auto-following and the same shard-level stats as the get follower stats API. /// /// public sealed partial class CcrStatsRequest : PlainRequest @@ -52,7 +53,8 @@ public sealed partial class CcrStatsRequest : PlainRequest /// -/// Gets all stats related to cross-cluster replication. +/// Get cross-cluster replication stats. +/// This API returns stats about auto-following and the same shard-level stats as the get follower stats API. /// /// public sealed partial class CcrStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/DeleteAutoFollowPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/DeleteAutoFollowPatternRequest.g.cs index 7236742d6fc..838922632ca 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/DeleteAutoFollowPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/DeleteAutoFollowPatternRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class DeleteAutoFollowPatternRequestParameters : RequestPa /// /// -/// Deletes auto-follow patterns. +/// Delete auto-follow patterns. +/// Delete a collection of cross-cluster replication auto-follow patterns. /// /// public sealed partial class DeleteAutoFollowPatternRequest : PlainRequest @@ -56,7 +57,8 @@ public DeleteAutoFollowPatternRequest(Elastic.Clients.Elasticsearch.Name name) : /// /// -/// Deletes auto-follow patterns. +/// Delete auto-follow patterns. +/// Delete a collection of cross-cluster replication auto-follow patterns. /// /// public sealed partial class DeleteAutoFollowPatternRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowInfoRequest.g.cs index 484ffbdbd3f..75a456deb2a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowInfoRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class FollowInfoRequestParameters : RequestParameters /// /// -/// Retrieves information about all follower indices, including parameters and status for each follower index +/// Get follower information. +/// Get information about all cross-cluster replication follower indices. +/// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. /// /// public sealed partial class FollowInfoRequest : PlainRequest @@ -56,7 +58,9 @@ public FollowInfoRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r /// /// -/// Retrieves information about all follower indices, including parameters and status for each follower index +/// Get follower information. +/// Get information about all cross-cluster replication follower indices. +/// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. /// /// public sealed partial class FollowInfoRequestDescriptor : RequestDescriptor, FollowInfoRequestParameters> @@ -92,7 +96,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieves information about all follower indices, including parameters and status for each follower index +/// Get follower information. +/// Get information about all cross-cluster replication follower indices. +/// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. /// /// public sealed partial class FollowInfoRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowRequest.g.cs index 34e1fcbab09..713e143d421 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); } @@ -42,7 +45,9 @@ public sealed partial class FollowRequestParameters : RequestParameters /// /// -/// Creates a new follower index configured to follow the referenced leader index. +/// Create a follower. +/// Create a cross-cluster replication follower index that follows a specific leader index. +/// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index. /// /// public sealed partial class FollowRequest : PlainRequest @@ -61,40 +66,138 @@ 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; } } /// /// -/// Creates a new follower index configured to follow the referenced leader index. +/// Create a follower. +/// Create a cross-cluster replication follower index that follows a specific leader index. +/// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index. /// /// public sealed partial class FollowRequestDescriptor : RequestDescriptor, FollowRequestParameters> @@ -125,100 +228,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 +451,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 +469,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 +481,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 +493,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(); @@ -291,7 +517,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Creates a new follower index configured to follow the referenced leader index. +/// Create a follower. +/// Create a cross-cluster replication follower index that follows a specific leader index. +/// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index. /// /// public sealed partial class FollowRequestDescriptor : RequestDescriptor @@ -318,100 +546,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 +769,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 +787,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 +799,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 +811,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/CrossClusterReplication/FollowStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowStatsRequest.g.cs index 84c37c5ef8f..a08fd5c57f4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/FollowStatsRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class FollowStatsRequestParameters : RequestParameters /// /// -/// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. +/// Get follower stats. +/// Get cross-cluster replication follower stats. +/// The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices. /// /// public sealed partial class FollowStatsRequest : PlainRequest @@ -56,7 +58,9 @@ public FollowStatsRequest(Elastic.Clients.Elasticsearch.Indices indices) : base( /// /// -/// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. +/// Get follower stats. +/// Get cross-cluster replication follower stats. +/// The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices. /// /// public sealed partial class FollowStatsRequestDescriptor : RequestDescriptor, FollowStatsRequestParameters> @@ -92,7 +96,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. +/// Get follower stats. +/// Get cross-cluster replication follower stats. +/// The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices. /// /// public sealed partial class FollowStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ForgetFollowerRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ForgetFollowerRequest.g.cs index 534aade2b25..83afef716e7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ForgetFollowerRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ForgetFollowerRequest.g.cs @@ -36,7 +36,20 @@ public sealed partial class ForgetFollowerRequestParameters : RequestParameters /// /// -/// Removes the follower retention leases from the leader. +/// Forget a follower. +/// Remove the cross-cluster replication follower retention leases from the leader. +/// +/// +/// A following index takes out retention leases on its leader index. +/// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. +/// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. +/// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. +/// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. +/// This API exists to enable manually removing the leases when the unfollow API is unable to do so. +/// +/// +/// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. +/// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. /// /// public sealed partial class ForgetFollowerRequest : PlainRequest @@ -65,7 +78,20 @@ public ForgetFollowerRequest(Elastic.Clients.Elasticsearch.IndexName index) : ba /// /// -/// Removes the follower retention leases from the leader. +/// Forget a follower. +/// Remove the cross-cluster replication follower retention leases from the leader. +/// +/// +/// A following index takes out retention leases on its leader index. +/// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. +/// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. +/// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. +/// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. +/// This API exists to enable manually removing the leases when the unfollow API is unable to do so. +/// +/// +/// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. +/// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. /// /// public sealed partial class ForgetFollowerRequestDescriptor : RequestDescriptor, ForgetFollowerRequestParameters> @@ -156,7 +182,20 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Removes the follower retention leases from the leader. +/// Forget a follower. +/// Remove the cross-cluster replication follower retention leases from the leader. +/// +/// +/// A following index takes out retention leases on its leader index. +/// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. +/// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. +/// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. +/// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. +/// This API exists to enable manually removing the leases when the unfollow API is unable to do so. +/// +/// +/// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. +/// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. /// /// public sealed partial class ForgetFollowerRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/GetAutoFollowPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/GetAutoFollowPatternRequest.g.cs index e8792e31dfc..0d67104509e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/GetAutoFollowPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/GetAutoFollowPatternRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetAutoFollowPatternRequestParameters : RequestParam /// /// -/// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. +/// Get auto-follow patterns. +/// Get cross-cluster replication auto-follow patterns. /// /// public sealed partial class GetAutoFollowPatternRequest : PlainRequest @@ -60,7 +61,8 @@ public GetAutoFollowPatternRequest(Elastic.Clients.Elasticsearch.Name? name) : b /// /// -/// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. +/// Get auto-follow patterns. +/// Get cross-cluster replication auto-follow patterns. /// /// public sealed partial class GetAutoFollowPatternRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseAutoFollowPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseAutoFollowPatternRequest.g.cs index b1ea27244a0..6d1d06ba408 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseAutoFollowPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseAutoFollowPatternRequest.g.cs @@ -36,7 +36,15 @@ public sealed partial class PauseAutoFollowPatternRequestParameters : RequestPar /// /// -/// Pauses an auto-follow pattern +/// Pause an auto-follow pattern. +/// Pause a cross-cluster replication auto-follow pattern. +/// When the API returns, the auto-follow pattern is inactive. +/// New indices that are created on the remote cluster and match the auto-follow patterns are ignored. +/// +/// +/// You can resume auto-following with the resume auto-follow pattern API. +/// When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. +/// Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. /// /// public sealed partial class PauseAutoFollowPatternRequest : PlainRequest @@ -56,7 +64,15 @@ public PauseAutoFollowPatternRequest(Elastic.Clients.Elasticsearch.Name name) : /// /// -/// Pauses an auto-follow pattern +/// Pause an auto-follow pattern. +/// Pause a cross-cluster replication auto-follow pattern. +/// When the API returns, the auto-follow pattern is inactive. +/// New indices that are created on the remote cluster and match the auto-follow patterns are ignored. +/// +/// +/// You can resume auto-following with the resume auto-follow pattern API. +/// When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. +/// Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. /// /// public sealed partial class PauseAutoFollowPatternRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseFollowRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseFollowRequest.g.cs index 1464d4bff6e..ba974a7ce62 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseFollowRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PauseFollowRequest.g.cs @@ -36,7 +36,11 @@ public sealed partial class PauseFollowRequestParameters : RequestParameters /// /// -/// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. +/// Pause a follower. +/// Pause a cross-cluster replication follower index. +/// The follower index will not fetch any additional operations from the leader index. +/// You can resume following with the resume follower API. +/// You can pause and resume a follower index to change the configuration of the following task. /// /// public sealed partial class PauseFollowRequest : PlainRequest @@ -56,7 +60,11 @@ public PauseFollowRequest(Elastic.Clients.Elasticsearch.IndexName index) : base( /// /// -/// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. +/// Pause a follower. +/// Pause a cross-cluster replication follower index. +/// The follower index will not fetch any additional operations from the leader index. +/// You can resume following with the resume follower API. +/// You can pause and resume a follower index to change the configuration of the following task. /// /// public sealed partial class PauseFollowRequestDescriptor : RequestDescriptor, PauseFollowRequestParameters> @@ -92,7 +100,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. +/// Pause a follower. +/// Pause a cross-cluster replication follower index. +/// The follower index will not fetch any additional operations from the leader index. +/// You can resume following with the resume follower API. +/// You can pause and resume a follower index to change the configuration of the following task. /// /// public sealed partial class PauseFollowRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PutAutoFollowPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PutAutoFollowPatternRequest.g.cs index a5386b3ba9f..0d2b49c3377 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PutAutoFollowPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/PutAutoFollowPatternRequest.g.cs @@ -36,7 +36,14 @@ public sealed partial class PutAutoFollowPatternRequestParameters : RequestParam /// /// -/// Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. +/// Create or update auto-follow patterns. +/// Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. +/// Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. +/// Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. +/// +/// +/// This API can also be used to update auto-follow patterns. +/// NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. /// /// public sealed partial class PutAutoFollowPatternRequest : PlainRequest @@ -176,7 +183,14 @@ public PutAutoFollowPatternRequest(Elastic.Clients.Elasticsearch.Name name) : ba /// /// -/// 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. +/// Create or update auto-follow patterns. +/// Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. +/// Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. +/// Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. +/// +/// +/// This API can also be used to update auto-follow patterns. +/// NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. /// /// public sealed partial class PutAutoFollowPatternRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeAutoFollowPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeAutoFollowPatternRequest.g.cs index ef1b17de9f6..33dd4afe9a4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeAutoFollowPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeAutoFollowPatternRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class ResumeAutoFollowPatternRequestParameters : RequestPa /// /// -/// Resumes an auto-follow pattern that has been paused +/// Resume an auto-follow pattern. +/// Resume a cross-cluster replication auto-follow pattern that was paused. +/// The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. +/// Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. /// /// public sealed partial class ResumeAutoFollowPatternRequest : PlainRequest @@ -56,7 +59,10 @@ public ResumeAutoFollowPatternRequest(Elastic.Clients.Elasticsearch.Name name) : /// /// -/// Resumes an auto-follow pattern that has been paused +/// Resume an auto-follow pattern. +/// Resume a cross-cluster replication auto-follow pattern that was paused. +/// The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. +/// Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. /// /// public sealed partial class ResumeAutoFollowPatternRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeFollowRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeFollowRequest.g.cs index 358d2d08210..ab0686ccb90 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeFollowRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/ResumeFollowRequest.g.cs @@ -36,7 +36,11 @@ public sealed partial class ResumeFollowRequestParameters : RequestParameters /// /// -/// Resumes a follower index that has been paused +/// Resume a follower. +/// Resume a cross-cluster replication follower index that was paused. +/// The follower index could have been paused with the pause follower API. +/// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. +/// When this API returns, the follower index will resume fetching operations from the leader index. /// /// public sealed partial class ResumeFollowRequest : PlainRequest @@ -77,7 +81,11 @@ public ResumeFollowRequest(Elastic.Clients.Elasticsearch.IndexName index) : base /// /// -/// Resumes a follower index that has been paused +/// Resume a follower. +/// Resume a cross-cluster replication follower index that was paused. +/// The follower index could have been paused with the pause follower API. +/// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. +/// When this API returns, the follower index will resume fetching operations from the leader index. /// /// public sealed partial class ResumeFollowRequestDescriptor : RequestDescriptor, ResumeFollowRequestParameters> @@ -246,7 +254,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Resumes a follower index that has been paused +/// Resume a follower. +/// Resume a cross-cluster replication follower index that was paused. +/// The follower index could have been paused with the pause follower API. +/// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. +/// When this API returns, the follower index will resume fetching operations from the leader index. /// /// public sealed partial class ResumeFollowRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/UnfollowRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/UnfollowRequest.g.cs index ff19808d599..ab1fab0076b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/UnfollowRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/CrossClusterReplication/UnfollowRequest.g.cs @@ -36,7 +36,13 @@ public sealed partial class UnfollowRequestParameters : RequestParameters /// /// -/// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. +/// Unfollow an index. +/// Convert a cross-cluster replication follower index to a regular index. +/// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. +/// The follower index must be paused and closed before you call the unfollow API. +/// +/// +/// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// /// public sealed partial class UnfollowRequest : PlainRequest @@ -56,7 +62,13 @@ public UnfollowRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r = /// /// -/// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. +/// Unfollow an index. +/// Convert a cross-cluster replication follower index to a regular index. +/// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. +/// The follower index must be paused and closed before you call the unfollow API. +/// +/// +/// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// /// public sealed partial class UnfollowRequestDescriptor : RequestDescriptor, UnfollowRequestParameters> @@ -92,7 +104,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. +/// Unfollow an index. +/// Convert a cross-cluster replication follower index to a regular index. +/// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. +/// The follower index must be paused and closed before you call the unfollow API. +/// +/// +/// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// /// public sealed partial class UnfollowRequestDescriptor : RequestDescriptor 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 d7bfa075bab..651b65cef03 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 e425b31cccf..2b09f0d917c 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/Enrich/ExecutePolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs index ca8c85f9433..daa404fd68f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs @@ -42,7 +42,8 @@ public sealed partial class ExecutePolicyRequestParameters : RequestParameters /// /// -/// Creates the enrich index for an existing enrich policy. +/// Run an enrich policy. +/// Create the enrich index for an existing enrich policy. /// /// public sealed partial class ExecutePolicyRequest : PlainRequest @@ -70,7 +71,8 @@ public ExecutePolicyRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => /// /// -/// Creates the enrich index for an existing enrich policy. +/// Run an enrich policy. +/// Create the enrich index for an existing enrich policy. /// /// public sealed partial class ExecutePolicyRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteRequest.g.cs index ab14e281da1..ab270a990cd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlDeleteRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class EqlDeleteRequestParameters : RequestParameters /// /// -/// Deletes an async EQL search or a stored synchronous EQL search. +/// Delete an async EQL search. +/// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// @@ -57,7 +58,8 @@ public EqlDeleteRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requi /// /// -/// Deletes an async EQL search or a stored synchronous EQL search. +/// Delete an async EQL search. +/// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// @@ -90,7 +92,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes an async EQL search or a stored synchronous EQL search. +/// Delete an async EQL search. +/// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetRequest.g.cs index 1d8a84c00ad..bb6b31ce705 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetRequest.g.cs @@ -51,7 +51,8 @@ public sealed partial class EqlGetRequestParameters : RequestParameters /// /// -/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// Get async EQL search results. +/// Get the current status and available results for an async EQL search or a stored synchronous EQL search. /// /// public sealed partial class EqlGetRequest : PlainRequest @@ -89,7 +90,8 @@ public EqlGetRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required /// /// -/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// Get async EQL search results. +/// Get the current status and available results for an async EQL search or a stored synchronous EQL search. /// /// public sealed partial class EqlGetRequestDescriptor : RequestDescriptor, EqlGetRequestParameters> @@ -124,7 +126,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. +/// Get async EQL search results. +/// Get the current status and available results for an async EQL search or a stored synchronous EQL search. /// /// public sealed partial class EqlGetRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetResponse.g.cs index b808cd86302..ccdd1f5ef9d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlGetResponse.g.cs @@ -60,6 +60,14 @@ public sealed partial class EqlGetResponse : ElasticsearchResponse [JsonInclude, JsonPropertyName("is_running")] public bool? IsRunning { get; init; } + /// + /// + /// Contains information about shard failures (if any), in case allow_partial_search_results=true + /// + /// + [JsonInclude, JsonPropertyName("shard_failures")] + public IReadOnlyCollection? ShardFailures { get; init; } + /// /// /// If true, the request timed out before completion. 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 c5e18996c7c..5f88564f66a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchRequest.g.cs @@ -45,7 +45,9 @@ public sealed partial class EqlSearchRequestParameters : RequestParameters /// /// -/// Returns results matching a query expressed in Event Query Language (EQL) +/// Get EQL search results. +/// Returns search results for an Event Query Language (EQL) query. +/// EQL assumes each document in a data stream or index corresponds to an event. /// /// public sealed partial class EqlSearchRequest : PlainRequest @@ -74,6 +76,10 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r /// [JsonIgnore] public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } + [JsonInclude, JsonPropertyName("allow_partial_search_results")] + public bool? AllowPartialSearchResults { get; set; } + [JsonInclude, JsonPropertyName("allow_partial_sequence_results")] + public bool? AllowPartialSequenceResults { get; set; } [JsonInclude, JsonPropertyName("case_sensitive")] public bool? CaseSensitive { get; set; } @@ -115,6 +121,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. @@ -156,7 +172,9 @@ public EqlSearchRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r /// /// -/// Returns results matching a query expressed in Event Query Language (EQL) +/// Get EQL search results. +/// Returns search results for an Event Query Language (EQL) query. +/// EQL assumes each document in a data stream or index corresponds to an event. /// /// public sealed partial class EqlSearchRequestDescriptor : RequestDescriptor, EqlSearchRequestParameters> @@ -189,6 +207,8 @@ public EqlSearchRequestDescriptor Indices(Elastic.Clients.Elasticsear return Self; } + private bool? AllowPartialSearchResultsValue { get; set; } + private bool? AllowPartialSequenceResultsValue { get; set; } private bool? CaseSensitiveValue { get; set; } private Elastic.Clients.Elasticsearch.Field? EventCategoryFieldValue { get; set; } private int? FetchSizeValue { get; set; } @@ -202,6 +222,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; } @@ -210,6 +231,18 @@ public EqlSearchRequestDescriptor Indices(Elastic.Clients.Elasticsear private Elastic.Clients.Elasticsearch.Field? TimestampFieldValue { get; set; } private Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeoutValue { get; set; } + public EqlSearchRequestDescriptor AllowPartialSearchResults(bool? allowPartialSearchResults = true) + { + AllowPartialSearchResultsValue = allowPartialSearchResults; + return Self; + } + + public EqlSearchRequestDescriptor AllowPartialSequenceResults(bool? allowPartialSequenceResults = true) + { + AllowPartialSequenceResultsValue = allowPartialSequenceResults; + return Self; + } + public EqlSearchRequestDescriptor CaseSensitive(bool? caseSensitive = true) { CaseSensitiveValue = caseSensitive; @@ -354,6 +387,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. @@ -463,6 +509,18 @@ public EqlSearchRequestDescriptor WaitForCompletionTimeout(Elastic.Cl protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); + if (AllowPartialSearchResultsValue.HasValue) + { + writer.WritePropertyName("allow_partial_search_results"); + writer.WriteBooleanValue(AllowPartialSearchResultsValue.Value); + } + + if (AllowPartialSequenceResultsValue.HasValue) + { + writer.WritePropertyName("allow_partial_sequence_results"); + writer.WriteBooleanValue(AllowPartialSequenceResultsValue.Value); + } + if (CaseSensitiveValue.HasValue) { writer.WritePropertyName("case_sensitive"); @@ -551,6 +609,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) @@ -595,7 +659,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns results matching a query expressed in Event Query Language (EQL) +/// Get EQL search results. +/// Returns search results for an Event Query Language (EQL) query. +/// EQL assumes each document in a data stream or index corresponds to an event. /// /// public sealed partial class EqlSearchRequestDescriptor : RequestDescriptor @@ -624,6 +690,8 @@ public EqlSearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices return Self; } + private bool? AllowPartialSearchResultsValue { get; set; } + private bool? AllowPartialSequenceResultsValue { get; set; } private bool? CaseSensitiveValue { get; set; } private Elastic.Clients.Elasticsearch.Field? EventCategoryFieldValue { get; set; } private int? FetchSizeValue { get; set; } @@ -637,6 +705,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; } @@ -645,6 +714,18 @@ public EqlSearchRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices private Elastic.Clients.Elasticsearch.Field? TimestampFieldValue { get; set; } private Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeoutValue { get; set; } + public EqlSearchRequestDescriptor AllowPartialSearchResults(bool? allowPartialSearchResults = true) + { + AllowPartialSearchResultsValue = allowPartialSearchResults; + return Self; + } + + public EqlSearchRequestDescriptor AllowPartialSequenceResults(bool? allowPartialSequenceResults = true) + { + AllowPartialSequenceResultsValue = allowPartialSequenceResults; + return Self; + } + public EqlSearchRequestDescriptor CaseSensitive(bool? caseSensitive = true) { CaseSensitiveValue = caseSensitive; @@ -789,6 +870,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. @@ -898,6 +992,18 @@ public EqlSearchRequestDescriptor WaitForCompletionTimeout(Elastic.Clients.Elast protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); + if (AllowPartialSearchResultsValue.HasValue) + { + writer.WritePropertyName("allow_partial_search_results"); + writer.WriteBooleanValue(AllowPartialSearchResultsValue.Value); + } + + if (AllowPartialSequenceResultsValue.HasValue) + { + writer.WritePropertyName("allow_partial_sequence_results"); + writer.WriteBooleanValue(AllowPartialSequenceResultsValue.Value); + } + if (CaseSensitiveValue.HasValue) { writer.WritePropertyName("case_sensitive"); @@ -986,6 +1092,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/Eql/EqlSearchResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchResponse.g.cs index 1f4602dc9b6..720dbc35012 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/EqlSearchResponse.g.cs @@ -60,6 +60,14 @@ public sealed partial class EqlSearchResponse : ElasticsearchResponse [JsonInclude, JsonPropertyName("is_running")] public bool? IsRunning { get; init; } + /// + /// + /// Contains information about shard failures (if any), in case allow_partial_search_results=true + /// + /// + [JsonInclude, JsonPropertyName("shard_failures")] + public IReadOnlyCollection? ShardFailures { get; init; } + /// /// /// If true, the request timed out before completion. diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusRequest.g.cs index 7137b3d8f1a..faba4187dbb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Eql/GetEqlStatusRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetEqlStatusRequestParameters : RequestParameters /// /// -/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// Get the async EQL status. +/// Get the current status for an async EQL search or a stored synchronous EQL search without returning results. /// /// public sealed partial class GetEqlStatusRequest : PlainRequest @@ -56,7 +57,8 @@ public GetEqlStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Re /// /// -/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// Get the async EQL status. +/// Get the current status for an async EQL search or a stored synchronous EQL search without returning results. /// /// public sealed partial class GetEqlStatusRequestDescriptor : RequestDescriptor, GetEqlStatusRequestParameters> @@ -88,7 +90,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. +/// Get the async EQL status. +/// Get the current status for an async EQL search or a stored synchronous EQL search without returning results. /// /// public sealed partial class GetEqlStatusRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Esql/EsqlQueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Esql/EsqlQueryRequest.g.cs index 969deddec05..1947cab2686 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Esql/EsqlQueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Esql/EsqlQueryRequest.g.cs @@ -57,7 +57,8 @@ public sealed partial class EsqlQueryRequestParameters : RequestParameters /// /// -/// Executes an ES|QL request +/// Run an ES|QL query. +/// Get search results for an ES|QL (Elasticsearch query language) query. /// /// public sealed partial class EsqlQueryRequest : PlainRequest @@ -143,7 +144,8 @@ public sealed partial class EsqlQueryRequest : PlainRequest /// -/// Executes an ES|QL request +/// Run an ES|QL query. +/// Get search results for an ES|QL (Elasticsearch query language) query. /// /// public sealed partial class EsqlQueryRequestDescriptor : RequestDescriptor, EsqlQueryRequestParameters> @@ -308,7 +310,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Executes an ES|QL request +/// Run an ES|QL query. +/// Get search results for an ES|QL (Elasticsearch query language) query. /// /// public sealed partial class EsqlQueryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/GetFeaturesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/GetFeaturesRequest.g.cs index 4514119121a..ec3b39f037f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/GetFeaturesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/GetFeaturesRequest.g.cs @@ -36,7 +36,18 @@ public sealed partial class GetFeaturesRequestParameters : RequestParameters /// /// -/// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot +/// Get the features. +/// Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. +/// You can use this API to determine which feature states to include when taking a snapshot. +/// By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. +/// +/// +/// A feature state includes one or more system indices necessary for a given feature to function. +/// In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. +/// +/// +/// The features listed by this API are a combination of built-in features and features defined by plugins. +/// In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. /// /// public sealed partial class GetFeaturesRequest : PlainRequest @@ -52,7 +63,18 @@ public sealed partial class GetFeaturesRequest : PlainRequest /// -/// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot +/// Get the features. +/// Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. +/// You can use this API to determine which feature states to include when taking a snapshot. +/// By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. +/// +/// +/// A feature state includes one or more system indices necessary for a given feature to function. +/// In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. +/// +/// +/// The features listed by this API are a combination of built-in features and features defined by plugins. +/// In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. /// /// public sealed partial class GetFeaturesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/ResetFeaturesRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/ResetFeaturesRequest.g.cs index 5002a2fd25b..5a4891114bd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/ResetFeaturesRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Features/ResetFeaturesRequest.g.cs @@ -36,7 +36,29 @@ public sealed partial class ResetFeaturesRequestParameters : RequestParameters /// /// -/// Resets the internal state of features, usually by deleting system indices +/// Reset the features. +/// Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. +/// +/// +/// WARNING: Intended for development and testing use only. Do not reset features on a production cluster. +/// +/// +/// Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. +/// This deletes all state information stored in system indices. +/// +/// +/// The response code is HTTP 200 if the state is successfully reset for all features. +/// It is HTTP 500 if the reset operation failed for any feature. +/// +/// +/// Note that select features might provide a way to reset particular system indices. +/// Using this API resets all features, both those that are built-in and implemented as plugins. +/// +/// +/// To list the features that will be affected, use the get features API. +/// +/// +/// IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. /// /// public sealed partial class ResetFeaturesRequest : PlainRequest @@ -52,7 +74,29 @@ public sealed partial class ResetFeaturesRequest : PlainRequest /// -/// Resets the internal state of features, usually by deleting system indices +/// Reset the features. +/// Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. +/// +/// +/// WARNING: Intended for development and testing use only. Do not reset features on a production cluster. +/// +/// +/// Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. +/// This deletes all state information stored in system indices. +/// +/// +/// The response code is HTTP 200 if the state is successfully reset for all features. +/// It is HTTP 500 if the reset operation failed for any feature. +/// +/// +/// Note that select features might provide a way to reset particular system indices. +/// Using this API resets all features, both those that are built-in and implemented as plugins. +/// +/// +/// To list the features that will be affected, use the get features API. +/// +/// +/// IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. /// /// public sealed partial class ResetFeaturesRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/FieldCapsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/FieldCapsRequest.g.cs index 4ff7e9fbd9c..40ca0aa9140 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 57912b0d588..4364f3b5fe8 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 fe59cc63faf..eb6c1779d1b 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/Graph/ExploreRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Graph/ExploreRequest.g.cs index 64eec4febf9..9a575d572f9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Graph/ExploreRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Graph/ExploreRequest.g.cs @@ -51,7 +51,12 @@ public sealed partial class ExploreRequestParameters : RequestParameters /// /// -/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// Explore graph analytics. +/// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. +/// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. +/// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. +/// Subsequent requests enable you to spider out from one more vertices of interest. +/// You can exclude vertices that have already been returned. /// /// public sealed partial class ExploreRequest : PlainRequest @@ -121,7 +126,12 @@ public ExploreRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r => /// /// -/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// Explore graph analytics. +/// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. +/// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. +/// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. +/// Subsequent requests enable you to spider out from one more vertices of interest. +/// You can exclude vertices that have already been returned. /// /// public sealed partial class ExploreRequestDescriptor : RequestDescriptor, ExploreRequestParameters> @@ -383,7 +393,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. +/// Explore graph analytics. +/// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. +/// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. +/// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. +/// Subsequent requests enable you to spider out from one more vertices of interest. +/// You can exclude vertices that have already been returned. /// /// public sealed partial class ExploreRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/HealthReportRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/HealthReportRequest.g.cs index c11068c9549..1e319f394cf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/HealthReportRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/HealthReportRequest.g.cs @@ -56,7 +56,29 @@ public sealed partial class HealthReportRequestParameters : RequestParameters /// /// -/// Returns the health of the cluster. +/// Get the cluster health. +/// Get a report with the health status of an Elasticsearch cluster. +/// The report contains a list of indicators that compose Elasticsearch functionality. +/// +/// +/// Each indicator has a health status of: green, unknown, yellow or red. +/// The indicator will provide an explanation and metadata describing the reason for its current health status. +/// +/// +/// The cluster’s status is controlled by the worst indicator status. +/// +/// +/// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. +/// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. +/// +/// +/// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. +/// The root cause and remediation steps are encapsulated in a diagnosis. +/// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. +/// +/// +/// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. +/// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// public sealed partial class HealthReportRequest : PlainRequest @@ -104,7 +126,29 @@ public HealthReportRequest(IReadOnlyCollection? feature) : base(r => r.O /// /// -/// Returns the health of the cluster. +/// Get the cluster health. +/// Get a report with the health status of an Elasticsearch cluster. +/// The report contains a list of indicators that compose Elasticsearch functionality. +/// +/// +/// Each indicator has a health status of: green, unknown, yellow or red. +/// The indicator will provide an explanation and metadata describing the reason for its current health status. +/// +/// +/// The cluster’s status is controlled by the worst indicator status. +/// +/// +/// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. +/// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. +/// +/// +/// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. +/// The root cause and remediation steps are encapsulated in a diagnosis. +/// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. +/// +/// +/// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. +/// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// public sealed partial class HealthReportRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/DeleteLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/DeleteLifecycleRequest.g.cs index edd1ee6ec59..aac721e8e18 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/DeleteLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/DeleteLifecycleRequest.g.cs @@ -49,7 +49,8 @@ public sealed partial class DeleteLifecycleRequestParameters : RequestParameters /// /// -/// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. +/// Delete a lifecycle policy. +/// You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. /// /// public sealed partial class DeleteLifecycleRequest : PlainRequest @@ -85,7 +86,8 @@ public DeleteLifecycleRequest(Elastic.Clients.Elasticsearch.Name name) : base(r /// /// -/// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. +/// Delete a lifecycle policy. +/// You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. /// /// public sealed partial class DeleteLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetIlmStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetIlmStatusRequest.g.cs index 0bff6514e2c..7ca469ce9c7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetIlmStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetIlmStatusRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetIlmStatusRequestParameters : RequestParameters /// /// -/// Retrieves the current index lifecycle management (ILM) status. +/// Get the ILM status. +/// Get the current index lifecycle management status. /// /// public sealed partial class GetIlmStatusRequest : PlainRequest @@ -52,7 +53,8 @@ public sealed partial class GetIlmStatusRequest : PlainRequest /// -/// Retrieves the current index lifecycle management (ILM) status. +/// Get the ILM status. +/// Get the current index lifecycle management status. /// /// public sealed partial class GetIlmStatusRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetLifecycleRequest.g.cs index 79d2688e50f..c2d33b459fc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/GetLifecycleRequest.g.cs @@ -49,7 +49,7 @@ public sealed partial class GetLifecycleRequestParameters : RequestParameters /// /// -/// Retrieves a lifecycle policy. +/// Get lifecycle policies. /// /// public sealed partial class GetLifecycleRequest : PlainRequest @@ -89,7 +89,7 @@ public GetLifecycleRequest(Elastic.Clients.Elasticsearch.Name? name) : base(r => /// /// -/// Retrieves a lifecycle policy. +/// Get lifecycle policies. /// /// public sealed partial class GetLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MigrateToDataTiersRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MigrateToDataTiersRequest.g.cs index 6fa5fe33b0f..111adb650af 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MigrateToDataTiersRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MigrateToDataTiersRequest.g.cs @@ -43,10 +43,36 @@ public sealed partial class MigrateToDataTiersRequestParameters : RequestParamet /// /// -/// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and -/// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ +/// Migrate to data tiers routing. +/// Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. +/// Optionally, delete one legacy index template. /// Using node roles enables ILM to automatically move the indices between data tiers. /// +/// +/// Migrating away from custom node attributes routing can be manually performed. +/// This API provides an automated way of performing three out of the four manual steps listed in the migration guide: +/// +/// +/// +/// +/// Stop setting the custom hot attribute on new indices. +/// +/// +/// +/// +/// Remove custom allocation settings from existing ILM policies. +/// +/// +/// +/// +/// Replace custom allocation settings from existing indices with the corresponding tier preference. +/// +/// +/// +/// +/// ILM must be stopped before performing the migration. +/// Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED. +/// /// public sealed partial class MigrateToDataTiersRequest : PlainRequest { @@ -74,10 +100,36 @@ public sealed partial class MigrateToDataTiersRequest : PlainRequest /// -/// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and -/// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ +/// Migrate to data tiers routing. +/// Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. +/// Optionally, delete one legacy index template. /// Using node roles enables ILM to automatically move the indices between data tiers. /// +/// +/// Migrating away from custom node attributes routing can be manually performed. +/// This API provides an automated way of performing three out of the four manual steps listed in the migration guide: +/// +/// +/// +/// +/// Stop setting the custom hot attribute on new indices. +/// +/// +/// +/// +/// Remove custom allocation settings from existing ILM policies. +/// +/// +/// +/// +/// Replace custom allocation settings from existing indices with the corresponding tier preference. +/// +/// +/// +/// +/// ILM must be stopped before performing the migration. +/// Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED. +/// /// public sealed partial class MigrateToDataTiersRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MoveToStepRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MoveToStepRequest.g.cs index 69e36b217a1..e69e5d40c39 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MoveToStepRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/MoveToStepRequest.g.cs @@ -36,7 +36,23 @@ public sealed partial class MoveToStepRequestParameters : RequestParameters /// /// -/// Manually moves an index into the specified step and executes that step. +/// Move to a lifecycle step. +/// Manually move an index into a specific step in the lifecycle policy and run that step. +/// +/// +/// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. +/// +/// +/// You must specify both the current step and the step to be executed in the body of the request. +/// The request will fail if the current step does not match the step currently running for the index +/// This is to prevent the index from being moved from an unexpected step into the next step. +/// +/// +/// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. +/// If only the phase is specified, the index will move to the first step of the first action in the target phase. +/// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. +/// Only actions specified in the ILM policy are considered valid. +/// An index cannot move to a step that is not part of its policy. /// /// public sealed partial class MoveToStepRequest : PlainRequest @@ -61,7 +77,23 @@ public MoveToStepRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r /// /// -/// Manually moves an index into the specified step and executes that step. +/// Move to a lifecycle step. +/// Manually move an index into a specific step in the lifecycle policy and run that step. +/// +/// +/// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. +/// +/// +/// You must specify both the current step and the step to be executed in the body of the request. +/// The request will fail if the current step does not match the step currently running for the index +/// This is to prevent the index from being moved from an unexpected step into the next step. +/// +/// +/// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. +/// If only the phase is specified, the index will move to the first step of the first action in the target phase. +/// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. +/// Only actions specified in the ILM policy are considered valid. +/// An index cannot move to a step that is not part of its policy. /// /// public sealed partial class MoveToStepRequestDescriptor : RequestDescriptor, MoveToStepRequestParameters> @@ -186,7 +218,23 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Manually moves an index into the specified step and executes that step. +/// Move to a lifecycle step. +/// Manually move an index into a specific step in the lifecycle policy and run that step. +/// +/// +/// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. +/// +/// +/// You must specify both the current step and the step to be executed in the body of the request. +/// The request will fail if the current step does not match the step currently running for the index +/// This is to prevent the index from being moved from an unexpected step into the next step. +/// +/// +/// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. +/// If only the phase is specified, the index will move to the first step of the first action in the target phase. +/// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. +/// Only actions specified in the ILM policy are considered valid. +/// An index cannot move to a step that is not part of its policy. /// /// public sealed partial class MoveToStepRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/PutLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/PutLifecycleRequest.g.cs index 8fa6cf4d75e..3b17d1e0c82 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/PutLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/PutLifecycleRequest.g.cs @@ -49,7 +49,11 @@ public sealed partial class PutLifecycleRequestParameters : RequestParameters /// /// -/// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. +/// Create or update a lifecycle policy. +/// If the specified policy exists, it is replaced and the policy version is incremented. +/// +/// +/// NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. /// /// public sealed partial class PutLifecycleRequest : PlainRequest @@ -87,7 +91,11 @@ public PutLifecycleRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => /// /// -/// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. +/// Create or update a lifecycle policy. +/// If the specified policy exists, it is replaced and the policy version is incremented. +/// +/// +/// NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. /// /// public sealed partial class PutLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RemovePolicyRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RemovePolicyRequest.g.cs index 4c6f67d3930..9c0c9c4438b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RemovePolicyRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RemovePolicyRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class RemovePolicyRequestParameters : RequestParameters /// /// -/// Removes the assigned lifecycle policy and stops managing the specified index +/// Remove policies from an index. +/// Remove the assigned lifecycle policies from an index or a data stream's backing indices. +/// It also stops managing the indices. /// /// public sealed partial class RemovePolicyRequest : PlainRequest @@ -56,7 +58,9 @@ public RemovePolicyRequest(Elastic.Clients.Elasticsearch.IndexName index) : base /// /// -/// Removes the assigned lifecycle policy and stops managing the specified index +/// Remove policies from an index. +/// Remove the assigned lifecycle policies from an index or a data stream's backing indices. +/// It also stops managing the indices. /// /// public sealed partial class RemovePolicyRequestDescriptor : RequestDescriptor, RemovePolicyRequestParameters> @@ -92,7 +96,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Removes the assigned lifecycle policy and stops managing the specified index +/// Remove policies from an index. +/// Remove the assigned lifecycle policies from an index or a data stream's backing indices. +/// It also stops managing the indices. /// /// public sealed partial class RemovePolicyRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RetryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RetryRequest.g.cs index 479a61db7d4..7ffff1bb01e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RetryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/RetryRequest.g.cs @@ -36,7 +36,10 @@ public sealed partial class RetryRequestParameters : RequestParameters /// /// -/// Retries executing the policy for an index that is in the ERROR step. +/// Retry a policy. +/// Retry running the lifecycle policy for an index that is in the ERROR step. +/// The API sets the policy back to the step where the error occurred and runs the step. +/// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// public sealed partial class RetryRequest : PlainRequest @@ -56,7 +59,10 @@ public RetryRequest(Elastic.Clients.Elasticsearch.IndexName index) : base(r => r /// /// -/// Retries executing the policy for an index that is in the ERROR step. +/// Retry a policy. +/// Retry running the lifecycle policy for an index that is in the ERROR step. +/// The API sets the policy back to the step where the error occurred and runs the step. +/// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// public sealed partial class RetryRequestDescriptor : RequestDescriptor, RetryRequestParameters> @@ -92,7 +98,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retries executing the policy for an index that is in the ERROR step. +/// Retry a policy. +/// Retry running the lifecycle policy for an index that is in the ERROR step. +/// The API sets the policy back to the step where the error occurred and runs the step. +/// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// public sealed partial class RetryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StartIlmRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StartIlmRequest.g.cs index 01bd491b281..9458140d79e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StartIlmRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StartIlmRequest.g.cs @@ -38,7 +38,10 @@ public sealed partial class StartIlmRequestParameters : RequestParameters /// /// -/// Start the index lifecycle management (ILM) plugin. +/// Start the ILM plugin. +/// Start the index lifecycle management plugin if it is currently stopped. +/// ILM is started automatically when the cluster is formed. +/// Restarting ILM is necessary only when it has been stopped using the stop ILM API. /// /// public sealed partial class StartIlmRequest : PlainRequest @@ -59,7 +62,10 @@ public sealed partial class StartIlmRequest : PlainRequest /// -/// Start the index lifecycle management (ILM) plugin. +/// Start the ILM plugin. +/// Start the index lifecycle management plugin if it is currently stopped. +/// ILM is started automatically when the cluster is formed. +/// Restarting ILM is necessary only when it has been stopped using the stop ILM API. /// /// public sealed partial class StartIlmRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StopIlmRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StopIlmRequest.g.cs index 212c9d3b480..900918996e5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StopIlmRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexLifecycleManagement/StopIlmRequest.g.cs @@ -38,7 +38,13 @@ public sealed partial class StopIlmRequestParameters : RequestParameters /// /// -/// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin +/// Stop the ILM plugin. +/// Halt all lifecycle management operations and stop the index lifecycle management plugin. +/// This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. +/// +/// +/// The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. +/// Use the get ILM status API to check whether ILM is running. /// /// public sealed partial class StopIlmRequest : PlainRequest @@ -59,7 +65,13 @@ public sealed partial class StopIlmRequest : PlainRequest /// -/// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin +/// Stop the ILM plugin. +/// Halt all lifecycle management operations and stop the index lifecycle management plugin. +/// This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. +/// +/// +/// The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. +/// Use the get ILM status API to check whether ILM is running. /// /// public sealed partial class StopIlmRequestDescriptor : 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 03931786cec..0a17e30d21c 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/ClearCacheRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs index 86e5c341aa0..86ff0cc74bc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ClearCacheRequest.g.cs @@ -89,8 +89,9 @@ public sealed partial class ClearCacheRequestParameters : RequestParameters /// /// -/// Clears the caches of one or more indices. -/// For data streams, the API clears the caches of the stream’s backing indices. +/// Clear the cache. +/// Clear the cache of one or more indices. +/// For data streams, the API clears the caches of the stream's backing indices. /// /// public sealed partial class ClearCacheRequest : PlainRequest @@ -175,8 +176,9 @@ public ClearCacheRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base( /// /// -/// Clears the caches of one or more indices. -/// For data streams, the API clears the caches of the stream’s backing indices. +/// Clear the cache. +/// Clear the cache of one or more indices. +/// For data streams, the API clears the caches of the stream's backing indices. /// /// public sealed partial class ClearCacheRequestDescriptor : RequestDescriptor, ClearCacheRequestParameters> @@ -220,8 +222,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Clears the caches of one or more indices. -/// For data streams, the API clears the caches of the stream’s backing indices. +/// Clear the cache. +/// Clear the cache of one or more indices. +/// For data streams, the API clears the caches of the stream's backing indices. /// /// public sealed partial class ClearCacheRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloneIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloneIndexRequest.g.cs index cf76a309e5d..e6c9e2e8529 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloneIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloneIndexRequest.g.cs @@ -59,8 +59,60 @@ public sealed partial class CloneIndexRequestParameters : RequestParameters /// /// -/// Clones an existing index. +/// Clone an index. +/// Clone an existing index into a new index. +/// Each original primary shard is cloned into a new primary shard in the new index. /// +/// +/// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. +/// The API also does not copy index metadata from the original index. +/// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. +/// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. +/// +/// +/// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. +/// To set the number of replicas in the resulting index, configure these settings in the clone request. +/// +/// +/// Cloning works as follows: +/// +/// +/// +/// +/// First, it creates a new target index with the same definition as the source index. +/// +/// +/// +/// +/// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. +/// +/// +/// +/// +/// Finally, it recovers the target index as though it were a closed index which had just been re-opened. +/// +/// +/// +/// +/// IMPORTANT: Indices can only be cloned if they meet the following requirements: +/// +/// +/// +/// +/// The target index must not exist. +/// +/// +/// +/// +/// The source index must have the same number of primary shards as the target index. +/// +/// +/// +/// +/// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. +/// +/// +/// /// public sealed partial class CloneIndexRequest : PlainRequest { @@ -122,8 +174,60 @@ public CloneIndexRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic. /// /// -/// Clones an existing index. +/// Clone an index. +/// Clone an existing index into a new index. +/// Each original primary shard is cloned into a new primary shard in the new index. +/// +/// +/// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. +/// The API also does not copy index metadata from the original index. +/// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. +/// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. +/// +/// +/// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. +/// To set the number of replicas in the resulting index, configure these settings in the clone request. +/// +/// +/// Cloning works as follows: +/// +/// +/// +/// +/// First, it creates a new target index with the same definition as the source index. +/// +/// +/// +/// +/// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. /// +/// +/// +/// +/// Finally, it recovers the target index as though it were a closed index which had just been re-opened. +/// +/// +/// +/// +/// IMPORTANT: Indices can only be cloned if they meet the following requirements: +/// +/// +/// +/// +/// The target index must not exist. +/// +/// +/// +/// +/// The source index must have the same number of primary shards as the target index. +/// +/// +/// +/// +/// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. +/// +/// +/// /// public sealed partial class CloneIndexRequestDescriptor : RequestDescriptor, CloneIndexRequestParameters> { @@ -207,8 +311,60 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Clones an existing index. +/// Clone an index. +/// Clone an existing index into a new index. +/// Each original primary shard is cloned into a new primary shard in the new index. +/// +/// +/// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. +/// The API also does not copy index metadata from the original index. +/// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. +/// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. +/// +/// +/// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. +/// To set the number of replicas in the resulting index, configure these settings in the clone request. +/// +/// +/// Cloning works as follows: +/// +/// +/// +/// +/// First, it creates a new target index with the same definition as the source index. +/// +/// +/// +/// +/// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. +/// +/// +/// +/// +/// Finally, it recovers the target index as though it were a closed index which had just been re-opened. +/// +/// +/// +/// +/// IMPORTANT: Indices can only be cloned if they meet the following requirements: +/// +/// +/// +/// +/// The target index must not exist. +/// +/// +/// +/// +/// The source index must have the same number of primary shards as the target index. +/// +/// +/// +/// +/// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. /// +/// +/// /// public sealed partial class CloneIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs index ad1323dcb15..e531c9a51b4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/CloseIndexRequest.g.cs @@ -84,7 +84,28 @@ public sealed partial class CloseIndexRequestParameters : RequestParameters /// /// -/// Closes an index. +/// Close an index. +/// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. +/// It is not possible to index documents or to search for documents in a closed index. +/// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. +/// +/// +/// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. +/// The shards will then go through the normal recovery process. +/// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. +/// +/// +/// You can open and close multiple indices. +/// An error is thrown if the request explicitly refers to a missing index. +/// This behaviour can be turned off using the ignore_unavailable=true parameter. +/// +/// +/// By default, you must explicitly name the indices you are opening or closing. +/// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. +/// +/// +/// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. +/// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// /// public sealed partial class CloseIndexRequest : PlainRequest @@ -159,7 +180,28 @@ public CloseIndexRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r /// /// -/// Closes an index. +/// Close an index. +/// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. +/// It is not possible to index documents or to search for documents in a closed index. +/// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. +/// +/// +/// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. +/// The shards will then go through the normal recovery process. +/// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. +/// +/// +/// You can open and close multiple indices. +/// An error is thrown if the request explicitly refers to a missing index. +/// This behaviour can be turned off using the ignore_unavailable=true parameter. +/// +/// +/// By default, you must explicitly name the indices you are opening or closing. +/// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. +/// +/// +/// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. +/// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// /// public sealed partial class CloseIndexRequestDescriptor : RequestDescriptor, CloseIndexRequestParameters> @@ -202,7 +244,28 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Closes an index. +/// Close an index. +/// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. +/// It is not possible to index documents or to search for documents in a closed index. +/// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. +/// +/// +/// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. +/// The shards will then go through the normal recovery process. +/// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. +/// +/// +/// You can open and close multiple indices. +/// An error is thrown if the request explicitly refers to a missing index. +/// This behaviour can be turned off using the ignore_unavailable=true parameter. +/// +/// +/// By default, you must explicitly name the indices you are opening or closing. +/// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. +/// +/// +/// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. +/// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// /// public sealed partial class CloseIndexRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DiskUsageRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DiskUsageRequest.g.cs index 868a32e7540..f72d916026c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DiskUsageRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DiskUsageRequest.g.cs @@ -76,7 +76,10 @@ public sealed partial class DiskUsageRequestParameters : RequestParameters /// /// -/// Analyzes the disk usage of each field of an index or data stream. +/// Analyze the index disk usage. +/// Analyze the disk usage of each field of an index or data stream. +/// This API might not support indices created in previous Elasticsearch versions. +/// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. /// /// public sealed partial class DiskUsageRequest : PlainRequest @@ -142,7 +145,10 @@ public DiskUsageRequest(Elastic.Clients.Elasticsearch.Indices indices) : base(r /// /// -/// Analyzes the disk usage of each field of an index or data stream. +/// Analyze the index disk usage. +/// Analyze the disk usage of each field of an index or data stream. +/// This API might not support indices created in previous Elasticsearch versions. +/// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. /// /// public sealed partial class DiskUsageRequestDescriptor : RequestDescriptor, DiskUsageRequestParameters> @@ -184,7 +190,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Analyzes the disk usage of each field of an index or data stream. +/// Analyze the index disk usage. +/// Analyze the disk usage of each field of an index or data stream. +/// This API might not support indices created in previous Elasticsearch versions. +/// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. /// /// public sealed partial class DiskUsageRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DownsampleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DownsampleRequest.g.cs index 8bb12324403..0685bdc4ac9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DownsampleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/DownsampleRequest.g.cs @@ -36,7 +36,15 @@ public sealed partial class DownsampleRequestParameters : RequestParameters /// /// -/// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. +/// Downsample an index. +/// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. +/// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. +/// All documents within an hour interval are summarized and stored as a single document in the downsample index. +/// +/// +/// NOTE: Only indices in a time series data stream are supported. +/// Neither field nor document level security can be defined on the source index. +/// The source index must be read only (index.blocks.write: true). /// /// public sealed partial class DownsampleRequest : PlainRequest, ISelfSerializable @@ -64,7 +72,15 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op /// /// -/// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. +/// Downsample an index. +/// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. +/// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. +/// All documents within an hour interval are summarized and stored as a single document in the downsample index. +/// +/// +/// NOTE: Only indices in a time series data stream are supported. +/// Neither field nor document level security can be defined on the source index. +/// The source index must be read only (index.blocks.write: true). /// /// public sealed partial class DownsampleRequestDescriptor : RequestDescriptor, DownsampleRequestParameters> @@ -128,7 +144,15 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. +/// Downsample an index. +/// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. +/// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. +/// All documents within an hour interval are summarized and stored as a single document in the downsample index. +/// +/// +/// NOTE: Only indices in a time series data stream are supported. +/// Neither field nor document level security can be defined on the source index. +/// The source index must be read only (index.blocks.write: true). /// /// public sealed partial class DownsampleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs index 6edfd5890c7..ee84ea82590 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsAliasRequest.g.cs @@ -59,10 +59,11 @@ public sealed partial class ExistsAliasRequestParameters : RequestParameters /// /// - /// If true, the request retrieves information from the local node only. + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. /// /// - public bool? Local { get => Q("local"); set => Q("local", value); } + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// @@ -119,11 +120,12 @@ public ExistsAliasRequest(Elastic.Clients.Elasticsearch.Indices? indices, Elasti /// /// - /// If true, the request retrieves information from the local node only. + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. /// /// [JsonIgnore] - public bool? Local { get => Q("local"); set => Q("local", value); } + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// @@ -155,7 +157,7 @@ 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 MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public ExistsAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -203,7 +205,7 @@ 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 MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public ExistsAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs index b31c22348c0..0fafea15669 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExistsIndexTemplateRequest.g.cs @@ -42,7 +42,8 @@ public sealed partial class ExistsIndexTemplateRequestParameters : RequestParame /// /// -/// Returns information about whether a particular index template exists. +/// Check index templates. +/// Check whether index templates exist. /// /// public sealed partial class ExistsIndexTemplateRequest : PlainRequest @@ -70,7 +71,8 @@ public ExistsIndexTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : bas /// /// -/// Returns information about whether a particular index template exists. +/// Check index templates. +/// Check whether index templates exist. /// /// public sealed partial class ExistsIndexTemplateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs index 003d68a2ff8..5eab5eca85d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ExplainDataLifecycleRequest.g.cs @@ -50,7 +50,7 @@ public sealed partial class ExplainDataLifecycleRequestParameters : RequestParam /// /// /// Get the status for a data stream lifecycle. -/// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// public sealed partial class ExplainDataLifecycleRequest : PlainRequest @@ -87,7 +87,7 @@ public ExplainDataLifecycleRequest(Elastic.Clients.Elasticsearch.Indices indices /// /// /// Get the status for a data stream lifecycle. -/// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// public sealed partial class ExplainDataLifecycleRequestDescriptor : RequestDescriptor, ExplainDataLifecycleRequestParameters> @@ -127,7 +127,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// /// Get the status for a data stream lifecycle. -/// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. +/// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// public sealed partial class ExplainDataLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FieldUsageStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FieldUsageStatsRequest.g.cs index aa7d0b31120..32d5670584b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FieldUsageStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FieldUsageStatsRequest.g.cs @@ -91,7 +91,10 @@ public sealed partial class FieldUsageStatsRequestParameters : RequestParameters /// /// -/// Returns field usage information for each shard and field of an index. +/// Get field usage stats. +/// Get field usage information for each shard and field of an index. +/// Field usage statistics are automatically captured when queries are running on a cluster. +/// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// public sealed partial class FieldUsageStatsRequest : PlainRequest @@ -174,7 +177,10 @@ public FieldUsageStatsRequest(Elastic.Clients.Elasticsearch.Indices indices) : b /// /// -/// Returns field usage information for each shard and field of an index. +/// Get field usage stats. +/// Get field usage information for each shard and field of an index. +/// Field usage statistics are automatically captured when queries are running on a cluster. +/// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// public sealed partial class FieldUsageStatsRequestDescriptor : RequestDescriptor, FieldUsageStatsRequestParameters> @@ -218,7 +224,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns field usage information for each shard and field of an index. +/// Get field usage stats. +/// Get field usage information for each shard and field of an index. +/// Field usage statistics are automatically captured when queries are running on a cluster. +/// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// public sealed partial class FieldUsageStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FlushRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FlushRequest.g.cs index 5282d97d911..c11cb3fc5ee 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FlushRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/FlushRequest.g.cs @@ -75,7 +75,19 @@ public sealed partial class FlushRequestParameters : RequestParameters /// /// -/// Flushes one or more data streams or indices. +/// Flush data streams or indices. +/// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. +/// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. +/// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. +/// +/// +/// After each operation has been flushed it is permanently stored in the Lucene index. +/// This may mean that there is no need to maintain an additional copy of it in the transaction log. +/// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. +/// +/// +/// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. +/// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// /// public sealed partial class FlushRequest : PlainRequest @@ -144,7 +156,19 @@ public FlushRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r => /// /// -/// Flushes one or more data streams or indices. +/// Flush data streams or indices. +/// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. +/// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. +/// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. +/// +/// +/// After each operation has been flushed it is permanently stored in the Lucene index. +/// This may mean that there is no need to maintain an additional copy of it in the transaction log. +/// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. +/// +/// +/// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. +/// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// /// public sealed partial class FlushRequestDescriptor : RequestDescriptor, FlushRequestParameters> @@ -186,7 +210,19 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Flushes one or more data streams or indices. +/// Flush data streams or indices. +/// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. +/// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. +/// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. +/// +/// +/// After each operation has been flushed it is permanently stored in the Lucene index. +/// This may mean that there is no need to maintain an additional copy of it in the transaction log. +/// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. +/// +/// +/// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. +/// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// /// public sealed partial class FlushRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs index 160e35dd659..9059a333f91 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ForcemergeRequest.g.cs @@ -84,7 +84,21 @@ public sealed partial class ForcemergeRequestParameters : RequestParameters /// /// -/// Performs the force merge operation on one or more indices. +/// Force a merge. +/// Perform the force merge operation on the shards of one or more indices. +/// For data streams, the API forces a merge on the shards of the stream's backing indices. +/// +/// +/// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. +/// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. +/// +/// +/// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). +/// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". +/// These soft-deleted documents are automatically cleaned up during regular segment merges. +/// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. +/// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. +/// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// public sealed partial class ForcemergeRequest : PlainRequest @@ -164,7 +178,21 @@ public ForcemergeRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base( /// /// -/// Performs the force merge operation on one or more indices. +/// Force a merge. +/// Perform the force merge operation on the shards of one or more indices. +/// For data streams, the API forces a merge on the shards of the stream's backing indices. +/// +/// +/// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. +/// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. +/// +/// +/// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). +/// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". +/// These soft-deleted documents are automatically cleaned up during regular segment merges. +/// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. +/// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. +/// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// public sealed partial class ForcemergeRequestDescriptor : RequestDescriptor, ForcemergeRequestParameters> @@ -208,7 +236,21 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Performs the force merge operation on one or more indices. +/// Force a merge. +/// Perform the force merge operation on the shards of one or more indices. +/// For data streams, the API forces a merge on the shards of the stream's backing indices. +/// +/// +/// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. +/// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. +/// +/// +/// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). +/// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". +/// These soft-deleted documents are automatically cleaned up during regular segment merges. +/// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. +/// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. +/// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// public sealed partial class ForcemergeRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs index cf9ce0876a7..0b66e257a11 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/GetAliasRequest.g.cs @@ -59,10 +59,11 @@ public sealed partial class GetAliasRequestParameters : RequestParameters /// /// - /// If true, the request retrieves information from the local node only. + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. /// /// - public bool? Local { get => Q("local"); set => Q("local", value); } + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// @@ -127,11 +128,12 @@ public GetAliasRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r /// /// - /// If true, the request retrieves information from the local node only. + /// Period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. /// /// [JsonIgnore] - public bool? Local { get => Q("local"); set => Q("local", value); } + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } } /// @@ -163,7 +165,7 @@ 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 MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public GetAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { @@ -211,7 +213,7 @@ 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 MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); public GetAliasRequestDescriptor Indices(Elastic.Clients.Elasticsearch.Indices? indices) { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs index 769cde5a63f..ec9c41d2b62 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/IndicesStatsRequest.g.cs @@ -100,8 +100,20 @@ public sealed partial class IndicesStatsRequestParameters : RequestParameters /// /// -/// Returns statistics for one or more indices. -/// For data streams, the API retrieves statistics for the stream’s backing indices. +/// Get index statistics. +/// For data streams, the API retrieves statistics for the stream's backing indices. +/// +/// +/// By default, the returned statistics are index-level with primaries and total aggregations. +/// primaries are the values for only the primary shards. +/// total are the accumulated values for both primary and replica shards. +/// +/// +/// To get shard-level statistics, set the level parameter to shards. +/// +/// +/// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. +/// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// public sealed partial class IndicesStatsRequest : PlainRequest @@ -207,8 +219,20 @@ public IndicesStatsRequest(Elastic.Clients.Elasticsearch.Indices? indices, Elast /// /// -/// Returns statistics for one or more indices. -/// For data streams, the API retrieves statistics for the stream’s backing indices. +/// Get index statistics. +/// For data streams, the API retrieves statistics for the stream's backing indices. +/// +/// +/// By default, the returned statistics are index-level with primaries and total aggregations. +/// primaries are the values for only the primary shards. +/// total are the accumulated values for both primary and replica shards. +/// +/// +/// To get shard-level statistics, set the level parameter to shards. +/// +/// +/// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. +/// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// public sealed partial class IndicesStatsRequestDescriptor : RequestDescriptor, IndicesStatsRequestParameters> @@ -260,8 +284,20 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns statistics for one or more indices. -/// For data streams, the API retrieves statistics for the stream’s backing indices. +/// Get index statistics. +/// For data streams, the API retrieves statistics for the stream's backing indices. +/// +/// +/// By default, the returned statistics are index-level with primaries and total aggregations. +/// primaries are the values for only the primary shards. +/// total are the accumulated values for both primary and replica shards. +/// +/// +/// To get shard-level statistics, set the level parameter to shards. +/// +/// +/// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. +/// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// public sealed partial class IndicesStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PromoteDataStreamRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PromoteDataStreamRequest.g.cs index b5755cc4508..1ba3ecb759f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PromoteDataStreamRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PromoteDataStreamRequest.g.cs @@ -42,7 +42,19 @@ public sealed partial class PromoteDataStreamRequestParameters : RequestParamete /// /// -/// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream +/// Promote a data stream. +/// Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. +/// +/// +/// With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. +/// These data streams can't be rolled over in the local cluster. +/// These replicated data streams roll over only if the upstream data stream rolls over. +/// In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. +/// +/// +/// NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. +/// If this is missing, the data stream will not be able to roll over until a matching index template is created. +/// This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. /// /// public sealed partial class PromoteDataStreamRequest : PlainRequest @@ -70,7 +82,19 @@ public PromoteDataStreamRequest(Elastic.Clients.Elasticsearch.IndexName name) : /// /// -/// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream +/// Promote a data stream. +/// Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. +/// +/// +/// With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. +/// These data streams can't be rolled over in the local cluster. +/// These replicated data streams roll over only if the upstream data stream rolls over. +/// In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. +/// +/// +/// NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. +/// If this is missing, the data stream will not be able to roll over until a matching index template is created. +/// This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. /// /// public sealed partial class PromoteDataStreamRequestDescriptor : RequestDescriptor 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 34af04025ab..85d023869c7 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/PutTemplateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs index ada658f2136..6c14ce93433 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/PutTemplateRequest.g.cs @@ -54,6 +54,19 @@ public sealed partial class PutTemplateRequestParameters : RequestParameters /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. +/// +/// +/// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. +/// +/// +/// Composable templates always take precedence over legacy templates. +/// If no composable template matches a new index, matching legacy templates are applied according to their order. +/// +/// +/// Index templates are only applied during index creation. +/// Changes to index templates do not affect existing indices. +/// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// public sealed partial class PutTemplateRequest : PlainRequest @@ -151,6 +164,19 @@ public PutTemplateRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => r /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. +/// +/// +/// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. +/// +/// +/// Composable templates always take precedence over legacy templates. +/// If no composable template matches a new index, matching legacy templates are applied according to their order. +/// +/// +/// Index templates are only applied during index creation. +/// Changes to index templates do not affect existing indices. +/// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// public sealed partial class PutTemplateRequestDescriptor : RequestDescriptor, PutTemplateRequestParameters> @@ -366,6 +392,19 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. +/// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. +/// +/// +/// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. +/// +/// +/// Composable templates always take precedence over legacy templates. +/// If no composable template matches a new index, matching legacy templates are applied according to their order. +/// +/// +/// Index templates are only applied during index creation. +/// Changes to index templates do not affect existing indices. +/// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// public sealed partial class PutTemplateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RecoveryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RecoveryRequest.g.cs index 5cf865ecb08..fa16870effe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RecoveryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/RecoveryRequest.g.cs @@ -49,8 +49,56 @@ public sealed partial class RecoveryRequestParameters : RequestParameters /// /// -/// Returns information about ongoing and completed shard recoveries for one or more indices. -/// For data streams, the API returns information for the stream’s backing indices. +/// Get index recovery information. +/// Get information about ongoing and completed shard recoveries for one or more indices. +/// For data streams, the API returns information for the stream's backing indices. +/// +/// +/// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. +/// When a shard recovery completes, the recovered shard is available for search and indexing. +/// +/// +/// Recovery automatically occurs during the following processes: +/// +/// +/// +/// +/// When creating an index for the first time. +/// +/// +/// +/// +/// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. +/// +/// +/// +/// +/// Creation of new replica shard copies from the primary. +/// +/// +/// +/// +/// Relocation of a shard copy to a different node in the same cluster. +/// +/// +/// +/// +/// A snapshot restore operation. +/// +/// +/// +/// +/// A clone, shrink, or split operation. +/// +/// +/// +/// +/// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. +/// +/// +/// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. +/// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. +/// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// public sealed partial class RecoveryRequest : PlainRequest @@ -90,8 +138,56 @@ public RecoveryRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base(r /// /// -/// Returns information about ongoing and completed shard recoveries for one or more indices. -/// For data streams, the API returns information for the stream’s backing indices. +/// Get index recovery information. +/// Get information about ongoing and completed shard recoveries for one or more indices. +/// For data streams, the API returns information for the stream's backing indices. +/// +/// +/// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. +/// When a shard recovery completes, the recovered shard is available for search and indexing. +/// +/// +/// Recovery automatically occurs during the following processes: +/// +/// +/// +/// +/// When creating an index for the first time. +/// +/// +/// +/// +/// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. +/// +/// +/// +/// +/// Creation of new replica shard copies from the primary. +/// +/// +/// +/// +/// Relocation of a shard copy to a different node in the same cluster. +/// +/// +/// +/// +/// A snapshot restore operation. +/// +/// +/// +/// +/// A clone, shrink, or split operation. +/// +/// +/// +/// +/// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. +/// +/// +/// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. +/// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. +/// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// public sealed partial class RecoveryRequestDescriptor : RequestDescriptor, RecoveryRequestParameters> @@ -130,8 +226,56 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns information about ongoing and completed shard recoveries for one or more indices. -/// For data streams, the API returns information for the stream’s backing indices. +/// Get index recovery information. +/// Get information about ongoing and completed shard recoveries for one or more indices. +/// For data streams, the API returns information for the stream's backing indices. +/// +/// +/// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. +/// When a shard recovery completes, the recovered shard is available for search and indexing. +/// +/// +/// Recovery automatically occurs during the following processes: +/// +/// +/// +/// +/// When creating an index for the first time. +/// +/// +/// +/// +/// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. +/// +/// +/// +/// +/// Creation of new replica shard copies from the primary. +/// +/// +/// +/// +/// Relocation of a shard copy to a different node in the same cluster. +/// +/// +/// +/// +/// A snapshot restore operation. +/// +/// +/// +/// +/// A clone, shrink, or split operation. +/// +/// +/// +/// +/// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. +/// +/// +/// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. +/// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. +/// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// public sealed partial class RecoveryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ReloadSearchAnalyzersRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ReloadSearchAnalyzersRequest.g.cs index 7f89b7399f3..736815127c6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ReloadSearchAnalyzersRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ReloadSearchAnalyzersRequest.g.cs @@ -56,7 +56,23 @@ public sealed partial class ReloadSearchAnalyzersRequestParameters : RequestPara /// /// -/// Reloads an index's search analyzers and their resources. +/// Reload search analyzers. +/// Reload an index's search analyzers and their resources. +/// For data streams, the API reloads search analyzers and resources for the stream's backing indices. +/// +/// +/// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. +/// +/// +/// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. +/// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. +/// +/// +/// NOTE: This API does not perform a reload for each shard of an index. +/// Instead, it performs a reload for each node containing index shards. +/// As a result, the total shard count returned by the API can differ from the number of index shards. +/// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. +/// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// public sealed partial class ReloadSearchAnalyzersRequest : PlainRequest @@ -100,7 +116,23 @@ public ReloadSearchAnalyzersRequest(Elastic.Clients.Elasticsearch.Indices indice /// /// -/// Reloads an index's search analyzers and their resources. +/// Reload search analyzers. +/// Reload an index's search analyzers and their resources. +/// For data streams, the API reloads search analyzers and resources for the stream's backing indices. +/// +/// +/// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. +/// +/// +/// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. +/// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. +/// +/// +/// NOTE: This API does not perform a reload for each shard of an index. +/// Instead, it performs a reload for each node containing index shards. +/// As a result, the total shard count returned by the API can differ from the number of index shards. +/// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. +/// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// public sealed partial class ReloadSearchAnalyzersRequestDescriptor : RequestDescriptor, ReloadSearchAnalyzersRequestParameters> @@ -140,7 +172,23 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Reloads an index's search analyzers and their resources. +/// Reload search analyzers. +/// Reload an index's search analyzers and their resources. +/// For data streams, the API reloads search analyzers and resources for the stream's backing indices. +/// +/// +/// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. +/// +/// +/// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. +/// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. +/// +/// +/// NOTE: This API does not perform a reload for each shard of an index. +/// Instead, it performs a reload for each node containing index shards. +/// As a result, the total shard count returned by the API can differ from the number of index shards. +/// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. +/// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// public sealed partial class ReloadSearchAnalyzersRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveClusterRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveClusterRequest.g.cs index 102ce4a8078..3081c88ff9d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveClusterRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveClusterRequest.g.cs @@ -68,10 +68,47 @@ public sealed partial class ResolveClusterRequestParameters : RequestParameters /// /// -/// Resolves the specified index expressions to return information about each cluster, including -/// the local cluster, if included. +/// Resolve the cluster. +/// Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. /// Multiple patterns and remote clusters are supported. /// +/// +/// This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. +/// +/// +/// You use the same index expression with this endpoint as you would for cross-cluster search. +/// Index and cluster exclusions are also supported with this endpoint. +/// +/// +/// For each cluster in the index expression, information is returned about: +/// +/// +/// +/// +/// Whether the querying ("local") cluster is currently connected to each remote cluster in the index expression scope. +/// +/// +/// +/// +/// Whether each remote cluster is configured with skip_unavailable as true or false. +/// +/// +/// +/// +/// Whether there are any indices, aliases, or data streams on that cluster that match the index expression. +/// +/// +/// +/// +/// Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). +/// +/// +/// +/// +/// Cluster version information, including the Elasticsearch server version. +/// +/// +/// /// public sealed partial class ResolveClusterRequest : PlainRequest { @@ -127,10 +164,47 @@ public ResolveClusterRequest(Elastic.Clients.Elasticsearch.Names name) : base(r /// /// -/// Resolves the specified index expressions to return information about each cluster, including -/// the local cluster, if included. +/// Resolve the cluster. +/// Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. /// Multiple patterns and remote clusters are supported. /// +/// +/// This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. +/// +/// +/// You use the same index expression with this endpoint as you would for cross-cluster search. +/// Index and cluster exclusions are also supported with this endpoint. +/// +/// +/// For each cluster in the index expression, information is returned about: +/// +/// +/// +/// +/// Whether the querying ("local") cluster is currently connected to each remote cluster in the index expression scope. +/// +/// +/// +/// +/// Whether each remote cluster is configured with skip_unavailable as true or false. +/// +/// +/// +/// +/// Whether there are any indices, aliases, or data streams on that cluster that match the index expression. +/// +/// +/// +/// +/// Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). +/// +/// +/// +/// +/// Cluster version information, including the Elasticsearch server version. +/// +/// +/// /// public sealed partial class ResolveClusterRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs index cfd7db16957..453bca1e4ff 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ResolveIndexRequest.g.cs @@ -61,7 +61,8 @@ public sealed partial class ResolveIndexRequestParameters : RequestParameters /// /// -/// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. +/// Resolve indices. +/// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// @@ -111,7 +112,8 @@ public ResolveIndexRequest(Elastic.Clients.Elasticsearch.Names name) : base(r => /// /// -/// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. +/// Resolve indices. +/// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// 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 6d61bb45be9..935d749c917 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SegmentsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SegmentsRequest.g.cs @@ -56,19 +56,13 @@ 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); } } /// /// -/// Returns low-level information about the Lucene segments in index shards. -/// For data streams, the API returns information about the stream’s backing indices. +/// Get index segments. +/// Get low-level information about the Lucene segments in index shards. +/// For data streams, the API returns information about the stream's backing indices. /// /// public sealed partial class SegmentsRequest : PlainRequest @@ -116,20 +110,13 @@ 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); } } /// /// -/// Returns low-level information about the Lucene segments in index shards. -/// For data streams, the API returns information about the stream’s backing indices. +/// Get index segments. +/// Get low-level information about the Lucene segments in index shards. +/// For data streams, the API returns information about the stream's backing indices. /// /// public sealed partial class SegmentsRequestDescriptor : RequestDescriptor, SegmentsRequestParameters> @@ -155,7 +142,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) { @@ -170,8 +156,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns low-level information about the Lucene segments in index shards. -/// For data streams, the API returns information about the stream’s backing indices. +/// Get index segments. +/// Get low-level information about the Lucene segments in index shards. +/// For data streams, the API returns information about the stream's backing indices. /// /// public sealed partial class SegmentsRequestDescriptor : RequestDescriptor @@ -197,7 +184,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/IndexManagement/ShardStoresRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShardStoresRequest.g.cs index 48be4cb8727..7214e3d289d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShardStoresRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShardStoresRequest.g.cs @@ -66,8 +66,37 @@ public sealed partial class ShardStoresRequestParameters : RequestParameters /// /// -/// Retrieves store information about replica shards in one or more indices. -/// For data streams, the API retrieves store information for the stream’s backing indices. +/// Get index shard stores. +/// Get store information about replica shards in one or more indices. +/// For data streams, the API retrieves store information for the stream's backing indices. +/// +/// +/// The index shard stores API returns the following information: +/// +/// +/// +/// +/// The node on which each replica shard exists. +/// +/// +/// +/// +/// The allocation ID for each replica shard. +/// +/// +/// +/// +/// A unique ID for each replica shard. +/// +/// +/// +/// +/// Any errors encountered while opening the shard index or from an earlier failure. +/// +/// +/// +/// +/// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// public sealed partial class ShardStoresRequest : PlainRequest @@ -126,8 +155,37 @@ public ShardStoresRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base /// /// -/// Retrieves store information about replica shards in one or more indices. -/// For data streams, the API retrieves store information for the stream’s backing indices. +/// Get index shard stores. +/// Get store information about replica shards in one or more indices. +/// For data streams, the API retrieves store information for the stream's backing indices. +/// +/// +/// The index shard stores API returns the following information: +/// +/// +/// +/// +/// The node on which each replica shard exists. +/// +/// +/// +/// +/// The allocation ID for each replica shard. +/// +/// +/// +/// +/// A unique ID for each replica shard. +/// +/// +/// +/// +/// Any errors encountered while opening the shard index or from an earlier failure. +/// +/// +/// +/// +/// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// public sealed partial class ShardStoresRequestDescriptor : RequestDescriptor, ShardStoresRequestParameters> @@ -168,8 +226,37 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieves store information about replica shards in one or more indices. -/// For data streams, the API retrieves store information for the stream’s backing indices. +/// Get index shard stores. +/// Get store information about replica shards in one or more indices. +/// For data streams, the API retrieves store information for the stream's backing indices. +/// +/// +/// The index shard stores API returns the following information: +/// +/// +/// +/// +/// The node on which each replica shard exists. +/// +/// +/// +/// +/// The allocation ID for each replica shard. +/// +/// +/// +/// +/// A unique ID for each replica shard. +/// +/// +/// +/// +/// Any errors encountered while opening the shard index or from an earlier failure. +/// +/// +/// +/// +/// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// public sealed partial class ShardStoresRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShrinkIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShrinkIndexRequest.g.cs index 3d2cd74e288..ad7eb567dd7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShrinkIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/ShrinkIndexRequest.g.cs @@ -59,8 +59,92 @@ public sealed partial class ShrinkIndexRequestParameters : RequestParameters /// /// -/// Shrinks an existing index into a new index with fewer primary shards. +/// Shrink an index. +/// Shrink an index into a new index with fewer primary shards. /// +/// +/// Before you can shrink an index: +/// +/// +/// +/// +/// The index must be read-only. +/// +/// +/// +/// +/// A copy of every shard in the index must reside on the same node. +/// +/// +/// +/// +/// The index must have a green health status. +/// +/// +/// +/// +/// To make shard allocation easier, we recommend you also remove the index's replica shards. +/// You can later re-add replica shards as part of the shrink operation. +/// +/// +/// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. +/// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. +/// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard +/// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. +/// +/// +/// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. +/// +/// +/// A shrink operation: +/// +/// +/// +/// +/// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. +/// +/// +/// +/// +/// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. +/// +/// +/// +/// +/// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. +/// +/// +/// +/// +/// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: +/// +/// +/// +/// +/// The target index must not exist. +/// +/// +/// +/// +/// The source index must have more primary shards than the target index. +/// +/// +/// +/// +/// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. +/// +/// +/// +/// +/// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. +/// +/// +/// +/// +/// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. +/// +/// +/// /// public sealed partial class ShrinkIndexRequest : PlainRequest { @@ -123,8 +207,92 @@ public ShrinkIndexRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic /// /// -/// Shrinks an existing index into a new index with fewer primary shards. +/// Shrink an index. +/// Shrink an index into a new index with fewer primary shards. +/// +/// +/// Before you can shrink an index: +/// +/// +/// +/// +/// The index must be read-only. +/// +/// +/// +/// +/// A copy of every shard in the index must reside on the same node. +/// +/// +/// +/// +/// The index must have a green health status. +/// +/// +/// +/// +/// To make shard allocation easier, we recommend you also remove the index's replica shards. +/// You can later re-add replica shards as part of the shrink operation. +/// +/// +/// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. +/// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. +/// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard +/// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. +/// +/// +/// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. +/// +/// +/// A shrink operation: +/// +/// +/// +/// +/// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. +/// +/// +/// +/// +/// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. +/// +/// +/// +/// +/// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. +/// +/// +/// +/// +/// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: +/// +/// +/// +/// +/// The target index must not exist. +/// +/// +/// +/// +/// The source index must have more primary shards than the target index. +/// +/// +/// +/// +/// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. /// +/// +/// +/// +/// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. +/// +/// +/// +/// +/// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. +/// +/// +/// /// public sealed partial class ShrinkIndexRequestDescriptor : RequestDescriptor, ShrinkIndexRequestParameters> { @@ -205,8 +373,92 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Shrinks an existing index into a new index with fewer primary shards. +/// Shrink an index. +/// Shrink an index into a new index with fewer primary shards. +/// +/// +/// Before you can shrink an index: +/// +/// +/// +/// +/// The index must be read-only. +/// +/// +/// +/// +/// A copy of every shard in the index must reside on the same node. +/// +/// +/// +/// +/// The index must have a green health status. +/// +/// +/// +/// +/// To make shard allocation easier, we recommend you also remove the index's replica shards. +/// You can later re-add replica shards as part of the shrink operation. +/// +/// +/// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. +/// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. +/// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard +/// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. +/// +/// +/// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. +/// +/// +/// A shrink operation: +/// +/// +/// +/// +/// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. +/// +/// +/// +/// +/// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. +/// +/// +/// +/// +/// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. +/// +/// +/// +/// +/// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: +/// +/// +/// +/// +/// The target index must not exist. +/// +/// +/// +/// +/// The source index must have more primary shards than the target index. +/// +/// +/// +/// +/// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. +/// +/// +/// +/// +/// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. +/// +/// +/// +/// +/// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. /// +/// +/// /// public sealed partial class ShrinkIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SplitIndexRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SplitIndexRequest.g.cs index 6b5c04c3f37..de7ea89236b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SplitIndexRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/IndexManagement/SplitIndexRequest.g.cs @@ -59,8 +59,81 @@ public sealed partial class SplitIndexRequestParameters : RequestParameters /// /// -/// Splits an existing index into a new index with more primary shards. +/// Split an index. +/// Split an index into a new index with more primary shards. /// +/// +/// +/// +/// Before you can split an index: +/// +/// +/// +/// +/// The index must be read-only. +/// +/// +/// +/// +/// The cluster health status must be green. +/// +/// +/// +/// +/// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. +/// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. +/// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. +/// +/// +/// A split operation: +/// +/// +/// +/// +/// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. +/// +/// +/// +/// +/// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. +/// +/// +/// +/// +/// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. +/// +/// +/// +/// +/// Recovers the target index as though it were a closed index which had just been re-opened. +/// +/// +/// +/// +/// IMPORTANT: Indices can only be split if they satisfy the following requirements: +/// +/// +/// +/// +/// The target index must not exist. +/// +/// +/// +/// +/// The source index must have fewer primary shards than the target index. +/// +/// +/// +/// +/// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. +/// +/// +/// +/// +/// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. +/// +/// +/// /// public sealed partial class SplitIndexRequest : PlainRequest { @@ -122,8 +195,81 @@ public SplitIndexRequest(Elastic.Clients.Elasticsearch.IndexName index, Elastic. /// /// -/// Splits an existing index into a new index with more primary shards. +/// Split an index. +/// Split an index into a new index with more primary shards. +/// +/// +/// +/// +/// Before you can split an index: +/// +/// +/// +/// +/// The index must be read-only. +/// +/// +/// +/// +/// The cluster health status must be green. +/// +/// +/// +/// +/// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. +/// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. +/// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. +/// +/// +/// A split operation: +/// +/// +/// +/// +/// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. +/// +/// +/// +/// +/// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. /// +/// +/// +/// +/// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. +/// +/// +/// +/// +/// Recovers the target index as though it were a closed index which had just been re-opened. +/// +/// +/// +/// +/// IMPORTANT: Indices can only be split if they satisfy the following requirements: +/// +/// +/// +/// +/// The target index must not exist. +/// +/// +/// +/// +/// The source index must have fewer primary shards than the target index. +/// +/// +/// +/// +/// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. +/// +/// +/// +/// +/// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. +/// +/// +/// /// public sealed partial class SplitIndexRequestDescriptor : RequestDescriptor, SplitIndexRequestParameters> { @@ -203,8 +349,81 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Splits an existing index into a new index with more primary shards. +/// Split an index. +/// Split an index into a new index with more primary shards. +/// +/// +/// +/// +/// Before you can split an index: +/// +/// +/// +/// +/// The index must be read-only. +/// +/// +/// +/// +/// The cluster health status must be green. +/// +/// +/// +/// +/// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. +/// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. +/// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. +/// +/// +/// A split operation: +/// +/// +/// +/// +/// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. +/// +/// +/// +/// +/// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. +/// +/// +/// +/// +/// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. +/// +/// +/// +/// +/// Recovers the target index as though it were a closed index which had just been re-opened. +/// +/// +/// +/// +/// IMPORTANT: Indices can only be split if they satisfy the following requirements: +/// +/// +/// +/// +/// The target index must not exist. +/// +/// +/// +/// +/// The source index must have fewer primary shards than the target index. +/// +/// +/// +/// +/// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. +/// +/// +/// +/// +/// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. /// +/// +/// /// public sealed partial class SplitIndexRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/PutInferenceRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/PutInferenceRequest.g.cs index c2bd7ed809f..2b49b107239 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/PutInferenceRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Inference/PutInferenceRequest.g.cs @@ -36,7 +36,17 @@ public sealed partial class PutInferenceRequestParameters : RequestParameters /// /// -/// Create an inference endpoint +/// Create an inference endpoint. +/// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. +/// After creating the endpoint, wait for the model deployment to complete before using it. +/// To verify the deployment status, use the get trained model statistics API. +/// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". +/// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. +/// +/// +/// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. +/// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. +/// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// public sealed partial class PutInferenceRequest : PlainRequest, ISelfSerializable @@ -68,7 +78,17 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op /// /// -/// Create an inference endpoint +/// Create an inference endpoint. +/// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. +/// After creating the endpoint, wait for the model deployment to complete before using it. +/// To verify the deployment status, use the get trained model statistics API. +/// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". +/// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. +/// +/// +/// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. +/// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. +/// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// public sealed partial class PutInferenceRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeleteGeoipDatabaseRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeleteGeoipDatabaseRequest.g.cs index 41d1afff03f..26a49ab502d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeleteGeoipDatabaseRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeleteGeoipDatabaseRequest.g.cs @@ -50,7 +50,8 @@ public sealed partial class DeleteGeoipDatabaseRequestParameters : RequestParame /// /// -/// Deletes a geoip database configuration. +/// Delete GeoIP database configurations. +/// Delete one or more IP geolocation database configurations. /// /// public sealed partial class DeleteGeoipDatabaseRequest : PlainRequest @@ -87,7 +88,8 @@ public DeleteGeoipDatabaseRequest(Elastic.Clients.Elasticsearch.Ids id) : base(r /// /// -/// Deletes a geoip database configuration. +/// Delete GeoIP database configurations. +/// Delete one or more IP geolocation database configurations. /// /// public sealed partial class DeleteGeoipDatabaseRequestDescriptor : RequestDescriptor, DeleteGeoipDatabaseRequestParameters> @@ -122,7 +124,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes a geoip database configuration. +/// Delete GeoIP database configurations. +/// Delete one or more IP geolocation database configurations. /// /// public sealed partial class DeleteGeoipDatabaseRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeleteIpLocationDatabaseRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeleteIpLocationDatabaseRequest.g.cs new file mode 100644 index 00000000000..c59c95fc2ab --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeleteIpLocationDatabaseRequest.g.cs @@ -0,0 +1,162 @@ +// 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.Ingest; + +public sealed partial class DeleteIpLocationDatabaseRequestParameters : RequestParameters +{ + /// + /// + /// The period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// The period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } +} + +/// +/// +/// Delete IP geolocation database configurations. +/// +/// +public sealed partial class DeleteIpLocationDatabaseRequest : PlainRequest +{ + public DeleteIpLocationDatabaseRequest(Elastic.Clients.Elasticsearch.Ids id) : base(r => r.Required("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestDeleteIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE; + + internal override bool SupportsBody => false; + + internal override string OperationName => "ingest.delete_ip_location_database"; + + /// + /// + /// The period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// The period to wait for a response. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } +} + +/// +/// +/// Delete IP geolocation database configurations. +/// +/// +public sealed partial class DeleteIpLocationDatabaseRequestDescriptor : RequestDescriptor, DeleteIpLocationDatabaseRequestParameters> +{ + internal DeleteIpLocationDatabaseRequestDescriptor(Action> configure) => configure.Invoke(this); + + public DeleteIpLocationDatabaseRequestDescriptor(Elastic.Clients.Elasticsearch.Ids id) : base(r => r.Required("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestDeleteIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE; + + internal override bool SupportsBody => false; + + internal override string OperationName => "ingest.delete_ip_location_database"; + + public DeleteIpLocationDatabaseRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public DeleteIpLocationDatabaseRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) => Qs("timeout", timeout); + + public DeleteIpLocationDatabaseRequestDescriptor Id(Elastic.Clients.Elasticsearch.Ids id) + { + RouteValues.Required("id", id); + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + } +} + +/// +/// +/// Delete IP geolocation database configurations. +/// +/// +public sealed partial class DeleteIpLocationDatabaseRequestDescriptor : RequestDescriptor +{ + internal DeleteIpLocationDatabaseRequestDescriptor(Action configure) => configure.Invoke(this); + + public DeleteIpLocationDatabaseRequestDescriptor(Elastic.Clients.Elasticsearch.Ids id) : base(r => r.Required("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestDeleteIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE; + + internal override bool SupportsBody => false; + + internal override string OperationName => "ingest.delete_ip_location_database"; + + public DeleteIpLocationDatabaseRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public DeleteIpLocationDatabaseRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) => Qs("timeout", timeout); + + public DeleteIpLocationDatabaseRequestDescriptor Id(Elastic.Clients.Elasticsearch.Ids id) + { + RouteValues.Required("id", id); + 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/Ingest/DeleteIpLocationDatabaseResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeleteIpLocationDatabaseResponse.g.cs new file mode 100644 index 00000000000..d221599c779 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeleteIpLocationDatabaseResponse.g.cs @@ -0,0 +1,38 @@ +// 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.Ingest; + +public sealed partial class DeleteIpLocationDatabaseResponse : ElasticsearchResponse +{ + /// + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// + [JsonInclude, JsonPropertyName("acknowledged")] + public bool Acknowledged { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineRequest.g.cs index a4b9affd9a7..bae10014caa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/DeletePipelineRequest.g.cs @@ -51,7 +51,8 @@ public sealed partial class DeletePipelineRequestParameters : RequestParameters /// /// -/// Deletes one or more existing ingest pipeline. +/// Delete pipelines. +/// Delete one or more ingest pipelines. /// /// public sealed partial class DeletePipelineRequest : PlainRequest @@ -89,7 +90,8 @@ public DeletePipelineRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r. /// /// -/// Deletes one or more existing ingest pipeline. +/// Delete pipelines. +/// Delete one or more ingest pipelines. /// /// public sealed partial class DeletePipelineRequestDescriptor : RequestDescriptor, DeletePipelineRequestParameters> @@ -124,7 +126,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes one or more existing ingest pipeline. +/// Delete pipelines. +/// Delete one or more ingest pipelines. /// /// public sealed partial class DeletePipelineRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs index 501f501e8ed..7ca7d51ee62 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GeoIpStatsRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GeoIpStatsRequestParameters : RequestParameters /// /// -/// Gets download statistics for GeoIP2 databases used with the geoip processor. +/// Get GeoIP statistics. +/// Get download statistics for GeoIP2 databases that are used with the GeoIP processor. /// /// public sealed partial class GeoIpStatsRequest : PlainRequest @@ -52,7 +53,8 @@ public sealed partial class GeoIpStatsRequest : PlainRequest /// -/// Gets download statistics for GeoIP2 databases used with the geoip processor. +/// Get GeoIP statistics. +/// Get download statistics for GeoIP2 databases that are used with the GeoIP processor. /// /// public sealed partial class GeoIpStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetGeoipDatabaseRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetGeoipDatabaseRequest.g.cs index d3b04df573b..b118dfd90f7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetGeoipDatabaseRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetGeoipDatabaseRequest.g.cs @@ -43,7 +43,8 @@ public sealed partial class GetGeoipDatabaseRequestParameters : RequestParameter /// /// -/// Returns information about one or more geoip database configurations. +/// Get GeoIP database configurations. +/// Get information about one or more IP geolocation database configurations. /// /// public sealed partial class GetGeoipDatabaseRequest : PlainRequest @@ -76,7 +77,8 @@ public GetGeoipDatabaseRequest(Elastic.Clients.Elasticsearch.Ids? id) : base(r = /// /// -/// Returns information about one or more geoip database configurations. +/// Get GeoIP database configurations. +/// Get information about one or more IP geolocation database configurations. /// /// public sealed partial class GetGeoipDatabaseRequestDescriptor : RequestDescriptor, GetGeoipDatabaseRequestParameters> @@ -114,7 +116,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns information about one or more geoip database configurations. +/// Get GeoIP database configurations. +/// Get information about one or more IP geolocation database configurations. /// /// public sealed partial class GetGeoipDatabaseRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetIpLocationDatabaseRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetIpLocationDatabaseRequest.g.cs new file mode 100644 index 00000000000..ebded8be3a5 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetIpLocationDatabaseRequest.g.cs @@ -0,0 +1,153 @@ +// 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.Ingest; + +public sealed partial class GetIpLocationDatabaseRequestParameters : RequestParameters +{ + /// + /// + /// The period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } +} + +/// +/// +/// Get IP geolocation database configurations. +/// +/// +public sealed partial class GetIpLocationDatabaseRequest : PlainRequest +{ + public GetIpLocationDatabaseRequest() + { + } + + public GetIpLocationDatabaseRequest(Elastic.Clients.Elasticsearch.Ids? id) : base(r => r.Optional("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestGetIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.GET; + + internal override bool SupportsBody => false; + + internal override string OperationName => "ingest.get_ip_location_database"; + + /// + /// + /// The period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } +} + +/// +/// +/// Get IP geolocation database configurations. +/// +/// +public sealed partial class GetIpLocationDatabaseRequestDescriptor : RequestDescriptor, GetIpLocationDatabaseRequestParameters> +{ + internal GetIpLocationDatabaseRequestDescriptor(Action> configure) => configure.Invoke(this); + + public GetIpLocationDatabaseRequestDescriptor(Elastic.Clients.Elasticsearch.Ids? id) : base(r => r.Optional("id", id)) + { + } + + public GetIpLocationDatabaseRequestDescriptor() + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestGetIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.GET; + + internal override bool SupportsBody => false; + + internal override string OperationName => "ingest.get_ip_location_database"; + + public GetIpLocationDatabaseRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + + public GetIpLocationDatabaseRequestDescriptor Id(Elastic.Clients.Elasticsearch.Ids? id) + { + RouteValues.Optional("id", id); + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + } +} + +/// +/// +/// Get IP geolocation database configurations. +/// +/// +public sealed partial class GetIpLocationDatabaseRequestDescriptor : RequestDescriptor +{ + internal GetIpLocationDatabaseRequestDescriptor(Action configure) => configure.Invoke(this); + + public GetIpLocationDatabaseRequestDescriptor(Elastic.Clients.Elasticsearch.Ids? id) : base(r => r.Optional("id", id)) + { + } + + public GetIpLocationDatabaseRequestDescriptor() + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestGetIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.GET; + + internal override bool SupportsBody => false; + + internal override string OperationName => "ingest.get_ip_location_database"; + + public GetIpLocationDatabaseRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + + public GetIpLocationDatabaseRequestDescriptor Id(Elastic.Clients.Elasticsearch.Ids? id) + { + RouteValues.Optional("id", id); + 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/Ingest/GetIpLocationDatabaseResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetIpLocationDatabaseResponse.g.cs new file mode 100644 index 00000000000..4e185a14181 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetIpLocationDatabaseResponse.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.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.Ingest; + +public sealed partial class GetIpLocationDatabaseResponse : ElasticsearchResponse +{ + [JsonInclude, JsonPropertyName("databases")] + public IReadOnlyCollection Databases { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetPipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetPipelineRequest.g.cs index 5eaf34e810c..39ca9bc7147 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetPipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/GetPipelineRequest.g.cs @@ -50,7 +50,8 @@ public sealed partial class GetPipelineRequestParameters : RequestParameters /// /// -/// Returns information about one or more ingest pipelines. +/// Get pipelines. +/// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// @@ -92,7 +93,8 @@ public GetPipelineRequest(Elastic.Clients.Elasticsearch.Id? id) : base(r => r.Op /// /// -/// Returns information about one or more ingest pipelines. +/// Get pipelines. +/// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// @@ -132,7 +134,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns information about one or more ingest pipelines. +/// Get pipelines. +/// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs index ed765789494..32a9e9194d4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/ProcessorGrokRequest.g.cs @@ -36,8 +36,9 @@ public sealed partial class ProcessorGrokRequestParameters : RequestParameters /// /// -/// Extracts structured fields out of a single text field within a document. -/// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. +/// Run a grok processor. +/// Extract structured fields out of a single text field within a document. +/// You must 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. /// /// @@ -54,8 +55,9 @@ public sealed partial class ProcessorGrokRequest : PlainRequest /// -/// Extracts structured fields out of a single text field within a document. -/// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. +/// Run a grok processor. +/// Extract structured fields out of a single text field within a document. +/// You must 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. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutGeoipDatabaseRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutGeoipDatabaseRequest.g.cs index ae65f9eae29..8d0e30805a5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutGeoipDatabaseRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutGeoipDatabaseRequest.g.cs @@ -50,7 +50,8 @@ public sealed partial class PutGeoipDatabaseRequestParameters : RequestParameter /// /// -/// Returns information about one or more geoip database configurations. +/// Create or update a GeoIP database configuration. +/// Refer to the create or update IP geolocation database configuration API. /// /// public sealed partial class PutGeoipDatabaseRequest : PlainRequest @@ -104,7 +105,8 @@ public PutGeoipDatabaseRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => /// /// -/// Returns information about one or more geoip database configurations. +/// Create or update a GeoIP database configuration. +/// Refer to the create or update IP geolocation database configuration API. /// /// public sealed partial class PutGeoipDatabaseRequestDescriptor : RequestDescriptor, PutGeoipDatabaseRequestParameters> @@ -205,7 +207,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns information about one or more geoip database configurations. +/// Create or update a GeoIP database configuration. +/// Refer to the create or update IP geolocation database configuration API. /// /// public sealed partial class PutGeoipDatabaseRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutIpLocationDatabaseRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutIpLocationDatabaseRequest.g.cs new file mode 100644 index 00000000000..49a39028b0f --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutIpLocationDatabaseRequest.g.cs @@ -0,0 +1,221 @@ +// 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.Ingest; + +public sealed partial class PutIpLocationDatabaseRequestParameters : RequestParameters +{ + /// + /// + /// The period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. + /// If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. + /// A value of -1 indicates that the request should never time out. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } +} + +/// +/// +/// Create or update an IP geolocation database configuration. +/// +/// +public sealed partial class PutIpLocationDatabaseRequest : PlainRequest, ISelfSerializable +{ + public PutIpLocationDatabaseRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id)) + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestPutIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; + + internal override bool SupportsBody => true; + + internal override string OperationName => "ingest.put_ip_location_database"; + + /// + /// + /// The period to wait for a connection to the master node. + /// If no response is received before the timeout expires, the request fails and returns an error. + /// A value of -1 indicates that the request should never time out. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q("master_timeout"); set => Q("master_timeout", value); } + + /// + /// + /// The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. + /// If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. + /// A value of -1 indicates that the request should never time out. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration Configuration { get; set; } + + void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + JsonSerializer.Serialize(writer, Configuration, options); + } +} + +/// +/// +/// Create or update an IP geolocation database configuration. +/// +/// +public sealed partial class PutIpLocationDatabaseRequestDescriptor : RequestDescriptor, PutIpLocationDatabaseRequestParameters> +{ + internal PutIpLocationDatabaseRequestDescriptor(Action> configure) => configure.Invoke(this); + public PutIpLocationDatabaseRequestDescriptor(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id)) => ConfigurationValue = configuration; + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestPutIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; + + internal override bool SupportsBody => true; + + internal override string OperationName => "ingest.put_ip_location_database"; + + public PutIpLocationDatabaseRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public PutIpLocationDatabaseRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) => Qs("timeout", timeout); + + public PutIpLocationDatabaseRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id) + { + RouteValues.Required("id", id); + return Self; + } + + private Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration ConfigurationValue { get; set; } + private Elastic.Clients.Elasticsearch.Ingest.DatabaseConfigurationDescriptor ConfigurationDescriptor { get; set; } + private Action ConfigurationDescriptorAction { get; set; } + + public PutIpLocationDatabaseRequestDescriptor Configuration(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration configuration) + { + ConfigurationDescriptor = null; + ConfigurationDescriptorAction = null; + ConfigurationValue = configuration; + return Self; + } + + public PutIpLocationDatabaseRequestDescriptor Configuration(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfigurationDescriptor descriptor) + { + ConfigurationValue = null; + ConfigurationDescriptorAction = null; + ConfigurationDescriptor = descriptor; + return Self; + } + + public PutIpLocationDatabaseRequestDescriptor Configuration(Action configure) + { + ConfigurationValue = null; + ConfigurationDescriptor = null; + ConfigurationDescriptorAction = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + JsonSerializer.Serialize(writer, ConfigurationValue, options); + } +} + +/// +/// +/// Create or update an IP geolocation database configuration. +/// +/// +public sealed partial class PutIpLocationDatabaseRequestDescriptor : RequestDescriptor +{ + internal PutIpLocationDatabaseRequestDescriptor(Action configure) => configure.Invoke(this); + public PutIpLocationDatabaseRequestDescriptor(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id)) => ConfigurationValue = configuration; + + internal override ApiUrls ApiUrls => ApiUrlLookup.IngestPutIpLocationDatabase; + + protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; + + internal override bool SupportsBody => true; + + internal override string OperationName => "ingest.put_ip_location_database"; + + public PutIpLocationDatabaseRequestDescriptor MasterTimeout(Elastic.Clients.Elasticsearch.Duration? masterTimeout) => Qs("master_timeout", masterTimeout); + public PutIpLocationDatabaseRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) => Qs("timeout", timeout); + + public PutIpLocationDatabaseRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id) + { + RouteValues.Required("id", id); + return Self; + } + + private Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration ConfigurationValue { get; set; } + private Elastic.Clients.Elasticsearch.Ingest.DatabaseConfigurationDescriptor ConfigurationDescriptor { get; set; } + private Action ConfigurationDescriptorAction { get; set; } + + public PutIpLocationDatabaseRequestDescriptor Configuration(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration configuration) + { + ConfigurationDescriptor = null; + ConfigurationDescriptorAction = null; + ConfigurationValue = configuration; + return Self; + } + + public PutIpLocationDatabaseRequestDescriptor Configuration(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfigurationDescriptor descriptor) + { + ConfigurationValue = null; + ConfigurationDescriptorAction = null; + ConfigurationDescriptor = descriptor; + return Self; + } + + public PutIpLocationDatabaseRequestDescriptor Configuration(Action configure) + { + ConfigurationValue = null; + ConfigurationDescriptor = null; + ConfigurationDescriptorAction = configure; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + JsonSerializer.Serialize(writer, ConfigurationValue, options); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutIpLocationDatabaseResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutIpLocationDatabaseResponse.g.cs new file mode 100644 index 00000000000..3d865e894d1 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutIpLocationDatabaseResponse.g.cs @@ -0,0 +1,38 @@ +// 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.Ingest; + +public sealed partial class PutIpLocationDatabaseResponse : ElasticsearchResponse +{ + /// + /// + /// For a successful response, this value is always true. On failure, an exception is returned instead. + /// + /// + [JsonInclude, JsonPropertyName("acknowledged")] + public bool Acknowledged { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineRequest.g.cs index 22764cade99..2cf636c625b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/PutPipelineRequest.g.cs @@ -56,7 +56,7 @@ public sealed partial class PutPipelineRequestParameters : RequestParameters /// /// -/// Creates or updates an ingest pipeline. +/// Create or update a pipeline. /// Changes made using this API take effect immediately. /// /// @@ -150,7 +150,7 @@ public PutPipelineRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Req /// /// -/// Creates or updates an ingest pipeline. +/// Create or update a pipeline. /// Changes made using this API take effect immediately. /// /// @@ -415,7 +415,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Creates or updates an ingest pipeline. +/// Create or update a pipeline. /// Changes made using this API take effect immediately. /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/SimulateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/SimulateRequest.g.cs index 33233c4c413..945801158d6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/SimulateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Ingest/SimulateRequest.g.cs @@ -42,7 +42,9 @@ public sealed partial class SimulateRequestParameters : RequestParameters /// /// -/// Executes an ingest pipeline against a set of provided documents. +/// Simulate a pipeline. +/// Run an ingest pipeline against a set of provided documents. +/// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// public sealed partial class SimulateRequest : PlainRequest @@ -92,7 +94,9 @@ public SimulateRequest(Elastic.Clients.Elasticsearch.Id? id) : base(r => r.Optio /// /// -/// Executes an ingest pipeline against a set of provided documents. +/// Simulate a pipeline. +/// Run an ingest pipeline against a set of provided documents. +/// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// public sealed partial class SimulateRequestDescriptor : RequestDescriptor, SimulateRequestParameters> @@ -259,7 +263,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Executes an ingest pipeline against a set of provided documents. +/// Simulate a pipeline. +/// Run an ingest pipeline against a set of provided documents. +/// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// public sealed partial class SimulateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/DeleteLicenseRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/DeleteLicenseRequest.g.cs index d07145501fa..4f61497c928 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/DeleteLicenseRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/DeleteLicenseRequest.g.cs @@ -36,7 +36,11 @@ public sealed partial class DeleteLicenseRequestParameters : RequestParameters /// /// -/// Deletes licensing information for the cluster +/// Delete the license. +/// When the license expires, your subscription level reverts to Basic. +/// +/// +/// If the operator privileges feature is enabled, only operator users can use this API. /// /// public sealed partial class DeleteLicenseRequest : PlainRequest @@ -52,7 +56,11 @@ public sealed partial class DeleteLicenseRequest : PlainRequest /// -/// Deletes licensing information for the cluster +/// Delete the license. +/// When the license expires, your subscription level reverts to Basic. +/// +/// +/// If the operator privileges feature is enabled, only operator users can use this API. /// /// public sealed partial class DeleteLicenseRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetBasicStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetBasicStatusRequest.g.cs index 471bcd0d8f8..038af0d7d54 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetBasicStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetBasicStatusRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class GetBasicStatusRequestParameters : RequestParameters /// /// -/// Retrieves information about the status of the basic license. +/// Get the basic license status. /// /// public sealed partial class GetBasicStatusRequest : PlainRequest @@ -52,7 +52,7 @@ public sealed partial class GetBasicStatusRequest : PlainRequest /// -/// Retrieves information about the status of the basic license. +/// Get the basic license status. /// /// public sealed partial class GetBasicStatusRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs index c77c0ac3ff6..7cf79fc8f49 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetLicenseRequest.g.cs @@ -43,8 +43,11 @@ public sealed partial class GetLicenseRequestParameters : RequestParameters /// /// /// Get license information. -/// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. -/// For more information about the different types of licenses, refer to Elastic Stack subscriptions. +/// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. +/// +/// +/// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. +/// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// public sealed partial class GetLicenseRequest : PlainRequest @@ -69,8 +72,11 @@ public sealed partial class GetLicenseRequest : PlainRequest /// /// Get license information. -/// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. -/// For more information about the different types of licenses, refer to Elastic Stack subscriptions. +/// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. +/// +/// +/// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. +/// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// public sealed partial class GetLicenseRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetTrialStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetTrialStatusRequest.g.cs index 9f57933b122..45d709baff7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetTrialStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/GetTrialStatusRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class GetTrialStatusRequestParameters : RequestParameters /// /// -/// Retrieves information about the status of the trial license. +/// Get the trial status. /// /// public sealed partial class GetTrialStatusRequest : PlainRequest @@ -52,7 +52,7 @@ public sealed partial class GetTrialStatusRequest : PlainRequest /// -/// Retrieves information about the status of the trial license. +/// Get the trial status. /// /// public sealed partial class GetTrialStatusRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostRequest.g.cs index e61bdbf3057..44625e7feaa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostRequest.g.cs @@ -42,7 +42,15 @@ public sealed partial class PostRequestParameters : RequestParameters /// /// -/// Updates the license for the cluster. +/// Update the license. +/// You can update your license at runtime without shutting down your nodes. +/// License updates take effect immediately. +/// If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. +/// You must then re-submit the API request with the acknowledge parameter set to true. +/// +/// +/// NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. +/// If the operator privileges feature is enabled, only operator users can use this API. /// /// public sealed partial class PostRequest : PlainRequest @@ -76,7 +84,15 @@ public sealed partial class PostRequest : PlainRequest /// /// -/// Updates the license for the cluster. +/// Update the license. +/// You can update your license at runtime without shutting down your nodes. +/// License updates take effect immediately. +/// If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. +/// You must then re-submit the API request with the acknowledge parameter set to true. +/// +/// +/// NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. +/// If the operator privileges feature is enabled, only operator users can use this API. /// /// public sealed partial class PostRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartBasicRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartBasicRequest.g.cs index 510341acd4c..f08108f337c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartBasicRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartBasicRequest.g.cs @@ -42,8 +42,18 @@ public sealed partial class PostStartBasicRequestParameters : RequestParameters /// /// -/// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. -/// To check the status of your basic license, use the following API: Get basic status. +/// Start a basic license. +/// Start an indefinite basic license, which gives access to all the basic features. +/// +/// +/// NOTE: In order to start a basic license, you must not currently have a basic license. +/// +/// +/// If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. +/// You must then re-submit the API request with the acknowledge parameter set to true. +/// +/// +/// To check the status of your basic license, use the get basic license API. /// /// public sealed partial class PostStartBasicRequest : PlainRequest @@ -67,8 +77,18 @@ public sealed partial class PostStartBasicRequest : PlainRequest /// -/// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. -/// To check the status of your basic license, use the following API: Get basic status. +/// Start a basic license. +/// Start an indefinite basic license, which gives access to all the basic features. +/// +/// +/// NOTE: In order to start a basic license, you must not currently have a basic license. +/// +/// +/// If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. +/// You must then re-submit the API request with the acknowledge parameter set to true. +/// +/// +/// To check the status of your basic license, use the get basic license API. /// /// public sealed partial class PostStartBasicRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartTrialRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartTrialRequest.g.cs index 27880c8d610..e15c0abbf0f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartTrialRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/LicenseManagement/PostStartTrialRequest.g.cs @@ -43,7 +43,15 @@ public sealed partial class PostStartTrialRequestParameters : RequestParameters /// /// -/// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. +/// Start a trial. +/// Start a 30-day trial, which gives access to all subscription features. +/// +/// +/// NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. +/// For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. +/// +/// +/// To check the status of your trial, use the get trial status API. /// /// public sealed partial class PostStartTrialRequest : PlainRequest @@ -69,7 +77,15 @@ public sealed partial class PostStartTrialRequest : PlainRequest /// -/// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. +/// Start a trial. +/// Start a 30-day trial, which gives access to all subscription features. +/// +/// +/// NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. +/// For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. +/// +/// +/// To check the status of your trial, use the get trial status API. /// /// public sealed partial class PostStartTrialRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/MlInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/MlInfoRequest.g.cs index 56f1d889562..a09c2cbfe9b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/MlInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/MlInfoRequest.g.cs @@ -36,8 +36,8 @@ public sealed partial class MlInfoRequestParameters : RequestParameters /// /// -/// Return ML defaults and limits. -/// Returns defaults and limits used by machine learning. +/// Get machine learning information. +/// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -59,8 +59,8 @@ public sealed partial class MlInfoRequest : PlainRequest /// -/// Return ML defaults and limits. -/// Returns defaults and limits used by machine learning. +/// Get machine learning information. +/// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs index 045933cc5be..f62f35e8c15 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDataFrameAnalyticsRequest.g.cs @@ -143,6 +143,8 @@ public PutDataFrameAnalyticsRequest(Elastic.Clients.Elasticsearch.Id id) : base( /// [JsonInclude, JsonPropertyName("max_num_threads")] public int? MaxNumThreads { get; set; } + [JsonInclude, JsonPropertyName("_meta")] + public IDictionary? Meta { get; set; } /// /// @@ -209,6 +211,7 @@ public PutDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elas private Action> DestDescriptorAction { get; set; } private IDictionary>>? HeadersValue { get; set; } private int? MaxNumThreadsValue { get; set; } + private IDictionary? MetaValue { get; set; } private string? ModelMemoryLimitValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsSource SourceValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsSourceDescriptor SourceDescriptor { get; set; } @@ -380,6 +383,12 @@ public PutDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxN return Self; } + public PutDataFrameAnalyticsRequestDescriptor Meta(Func, FluentDictionary> selector) + { + MetaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + /// /// /// The approximate maximum amount of memory resources that are permitted for @@ -505,6 +514,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(MaxNumThreadsValue.Value); } + if (MetaValue is not null) + { + writer.WritePropertyName("_meta"); + JsonSerializer.Serialize(writer, MetaValue, options); + } + if (!string.IsNullOrEmpty(ModelMemoryLimitValue)) { writer.WritePropertyName("model_memory_limit"); @@ -579,6 +594,7 @@ public PutDataFrameAnalyticsRequestDescriptor Id(Elastic.Clients.Elasticsearch.I private Action DestDescriptorAction { get; set; } private IDictionary>>? HeadersValue { get; set; } private int? MaxNumThreadsValue { get; set; } + private IDictionary? MetaValue { get; set; } private string? ModelMemoryLimitValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsSource SourceValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.DataframeAnalyticsSourceDescriptor SourceDescriptor { get; set; } @@ -750,6 +766,12 @@ public PutDataFrameAnalyticsRequestDescriptor MaxNumThreads(int? maxNumThreads) return Self; } + public PutDataFrameAnalyticsRequestDescriptor Meta(Func, FluentDictionary> selector) + { + MetaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + /// /// /// The approximate maximum amount of memory resources that are permitted for @@ -875,6 +897,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(MaxNumThreadsValue.Value); } + if (MetaValue is not null) + { + writer.WritePropertyName("_meta"); + JsonSerializer.Serialize(writer, MetaValue, options); + } + if (!string.IsNullOrEmpty(ModelMemoryLimitValue)) { writer.WritePropertyName("model_memory_limit"); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDataFrameAnalyticsResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDataFrameAnalyticsResponse.g.cs index 099dad14f57..f09a4e42769 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDataFrameAnalyticsResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDataFrameAnalyticsResponse.g.cs @@ -46,6 +46,8 @@ public sealed partial class PutDataFrameAnalyticsResponse : ElasticsearchRespons public string Id { get; init; } [JsonInclude, JsonPropertyName("max_num_threads")] public int MaxNumThreads { get; init; } + [JsonInclude, JsonPropertyName("_meta")] + public IReadOnlyDictionary? Meta { get; init; } [JsonInclude, JsonPropertyName("model_memory_limit")] public string ModelMemoryLimit { get; init; } [JsonInclude, JsonPropertyName("source")] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs index 11705264497..f73cd9f69fd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutDatafeedRequest.g.cs @@ -68,7 +68,7 @@ public override PutDatafeedRequest Read(ref Utf8JsonReader reader, Type typeToCo if (reader.TokenType == JsonTokenType.PropertyName) { var property = reader.GetString(); - if (property == "aggregations") + if (property == "aggregations" || property == "aggs") { variant.Aggregations = JsonSerializer.Deserialize?>(ref reader, options); continue; @@ -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/MachineLearning/PutJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutJobRequest.g.cs index 8d6db8d33c0..7810b59710c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutJobRequest.g.cs @@ -32,6 +32,55 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class PutJobRequestParameters : RequestParameters { + /// + /// + /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the + /// _all string or when no indices are specified. + /// + /// + public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } + + /// + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + /// whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: + /// + /// + /// + /// + /// all: Match any data stream or index, including hidden ones. + /// + /// + /// + /// + /// closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + /// + /// + /// + /// + /// hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. + /// + /// + /// + /// + /// none: Wildcard patterns are not accepted. + /// + /// + /// + /// + /// open: Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// + /// + /// + public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } + + /// + /// + /// If true, unavailable indices (missing or closed) are ignored. + /// + /// + public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } } /// @@ -54,6 +103,59 @@ public PutJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Requi internal override string OperationName => "ml.put_job"; + /// + /// + /// If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the + /// _all string or when no indices are specified. + /// + /// + [JsonIgnore] + public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } + + /// + /// + /// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines + /// whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: + /// + /// + /// + /// + /// all: Match any data stream or index, including hidden ones. + /// + /// + /// + /// + /// closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. + /// + /// + /// + /// + /// hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both. + /// + /// + /// + /// + /// none: Wildcard patterns are not accepted. + /// + /// + /// + /// + /// open: Match open, non-hidden indices. Also matches any non-hidden data stream. + /// + /// + /// + /// + [JsonIgnore] + public ICollection? ExpandWildcards { get => Q?>("expand_wildcards"); set => Q("expand_wildcards", value); } + + /// + /// + /// If true, unavailable indices (missing or closed) are ignored. + /// + /// + [JsonIgnore] + public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } + /// /// /// Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide xpack.ml.max_lazy_ml_nodes setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. @@ -134,6 +236,14 @@ public PutJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Requi [JsonInclude, JsonPropertyName("groups")] public ICollection? Groups { get; set; } + /// + /// + /// The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. + /// + /// + [JsonInclude, JsonPropertyName("job_id")] + public Elastic.Clients.Elasticsearch.Id? JobId { get; set; } + /// /// /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. @@ -185,10 +295,6 @@ public sealed partial class PutJobRequestDescriptor : RequestDescript { internal PutJobRequestDescriptor(Action> configure) => configure.Invoke(this); - public PutJobRequestDescriptor(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Required("job_id", jobId)) - { - } - internal override ApiUrls ApiUrls => ApiUrlLookup.MachineLearningPutJob; protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; @@ -197,11 +303,9 @@ public PutJobRequestDescriptor(Elastic.Clients.Elasticsearch.Id jobId) : base(r internal override string OperationName => "ml.put_job"; - public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id jobId) - { - RouteValues.Required("job_id", jobId); - return Self; - } + public PutJobRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); + public PutJobRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); + public PutJobRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); private bool? AllowLazyOpenValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.AnalysisConfig AnalysisConfigValue { get; set; } @@ -221,6 +325,7 @@ public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id private Action> DatafeedConfigDescriptorAction { get; set; } private string? DescriptionValue { get; set; } private ICollection? GroupsValue { get; set; } + private Elastic.Clients.Elasticsearch.Id? JobIdValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.ModelPlotConfig? ModelPlotConfigValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.ModelPlotConfigDescriptor ModelPlotConfigDescriptor { get; set; } private Action> ModelPlotConfigDescriptorAction { get; set; } @@ -411,6 +516,17 @@ public PutJobRequestDescriptor Groups(ICollection? groups) return Self; } + /// + /// + /// The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. + /// + /// + public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id? jobId) + { + JobIdValue = jobId; + return Self; + } + /// /// /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. @@ -587,6 +703,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, GroupsValue, options); } + if (JobIdValue is not null) + { + writer.WritePropertyName("job_id"); + JsonSerializer.Serialize(writer, JobIdValue, options); + } + if (ModelPlotConfigDescriptor is not null) { writer.WritePropertyName("model_plot_config"); @@ -641,10 +763,6 @@ public sealed partial class PutJobRequestDescriptor : RequestDescriptor configure) => configure.Invoke(this); - public PutJobRequestDescriptor(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Required("job_id", jobId)) - { - } - internal override ApiUrls ApiUrls => ApiUrlLookup.MachineLearningPutJob; protected override HttpMethod StaticHttpMethod => HttpMethod.PUT; @@ -653,11 +771,9 @@ public PutJobRequestDescriptor(Elastic.Clients.Elasticsearch.Id jobId) : base(r internal override string OperationName => "ml.put_job"; - public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id jobId) - { - RouteValues.Required("job_id", jobId); - return Self; - } + public PutJobRequestDescriptor AllowNoIndices(bool? allowNoIndices = true) => Qs("allow_no_indices", allowNoIndices); + public PutJobRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); + public PutJobRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); private bool? AllowLazyOpenValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.AnalysisConfig AnalysisConfigValue { get; set; } @@ -677,6 +793,7 @@ public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id jobId) private Action DatafeedConfigDescriptorAction { get; set; } private string? DescriptionValue { get; set; } private ICollection? GroupsValue { get; set; } + private Elastic.Clients.Elasticsearch.Id? JobIdValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.ModelPlotConfig? ModelPlotConfigValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.ModelPlotConfigDescriptor ModelPlotConfigDescriptor { get; set; } private Action ModelPlotConfigDescriptorAction { get; set; } @@ -867,6 +984,17 @@ public PutJobRequestDescriptor Groups(ICollection? groups) return Self; } + /// + /// + /// The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. + /// + /// + public PutJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id? jobId) + { + JobIdValue = jobId; + return Self; + } + /// /// /// This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. @@ -1043,6 +1171,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, GroupsValue, options); } + if (JobIdValue is not null) + { + writer.WritePropertyName("job_id"); + JsonSerializer.Serialize(writer, JobIdValue, options); + } + if (ModelPlotConfigDescriptor is not null) { writer.WritePropertyName("model_plot_config"); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs index 2fdba4e3cb8..cb1d77cd15a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/PutTrainedModelResponse.g.cs @@ -128,6 +128,8 @@ public sealed partial class PutTrainedModelResponse : ElasticsearchResponse /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } + [JsonInclude, JsonPropertyName("model_package")] + public Elastic.Clients.Elasticsearch.MachineLearning.ModelPackageConfig? ModelPackage { get; init; } [JsonInclude, JsonPropertyName("model_size_bytes")] public Elastic.Clients.Elasticsearch.ByteSize? ModelSizeBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs index 548a6f67f0e..83f7061f442 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/UpdateJobRequest.g.cs @@ -129,7 +129,7 @@ public UpdateJobRequest(Elastic.Clients.Elasticsearch.Id jobId) : base(r => r.Re /// /// [JsonInclude, JsonPropertyName("detectors")] - public ICollection? Detectors { get; set; } + public ICollection? Detectors { get; set; } /// /// @@ -222,10 +222,10 @@ public UpdateJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch private IDictionary? CustomSettingsValue { get; set; } private long? DailyModelSnapshotRetentionAfterDaysValue { get; set; } private string? DescriptionValue { get; set; } - private ICollection? DetectorsValue { get; set; } - private Elastic.Clients.Elasticsearch.MachineLearning.DetectorDescriptor DetectorsDescriptor { get; set; } - private Action> DetectorsDescriptorAction { get; set; } - private Action>[] DetectorsDescriptorActions { get; set; } + private ICollection? DetectorsValue { get; set; } + private Elastic.Clients.Elasticsearch.MachineLearning.DetectorUpdateDescriptor DetectorsDescriptor { get; set; } + private Action> DetectorsDescriptorAction { get; set; } + private Action>[] DetectorsDescriptorActions { get; set; } private ICollection? GroupsValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.ModelPlotConfig? ModelPlotConfigValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.ModelPlotConfigDescriptor ModelPlotConfigDescriptor { get; set; } @@ -353,7 +353,7 @@ public UpdateJobRequestDescriptor Description(string? description) /// An array of detector update objects. /// /// - public UpdateJobRequestDescriptor Detectors(ICollection? detectors) + public UpdateJobRequestDescriptor Detectors(ICollection? detectors) { DetectorsDescriptor = null; DetectorsDescriptorAction = null; @@ -362,7 +362,7 @@ public UpdateJobRequestDescriptor Detectors(ICollection Detectors(Elastic.Clients.Elasticsearch.MachineLearning.DetectorDescriptor descriptor) + public UpdateJobRequestDescriptor Detectors(Elastic.Clients.Elasticsearch.MachineLearning.DetectorUpdateDescriptor descriptor) { DetectorsValue = null; DetectorsDescriptorAction = null; @@ -371,7 +371,7 @@ public UpdateJobRequestDescriptor Detectors(Elastic.Clients.Elasticse return Self; } - public UpdateJobRequestDescriptor Detectors(Action> configure) + public UpdateJobRequestDescriptor Detectors(Action> configure) { DetectorsValue = null; DetectorsDescriptor = null; @@ -380,7 +380,7 @@ public UpdateJobRequestDescriptor Detectors(Action Detectors(params Action>[] configure) + public UpdateJobRequestDescriptor Detectors(params Action>[] configure) { DetectorsValue = null; DetectorsDescriptor = null; @@ -567,7 +567,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o { writer.WritePropertyName("detectors"); writer.WriteStartArray(); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.DetectorDescriptor(DetectorsDescriptorAction), options); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.DetectorUpdateDescriptor(DetectorsDescriptorAction), options); writer.WriteEndArray(); } else if (DetectorsDescriptorActions is not null) @@ -576,7 +576,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStartArray(); foreach (var action in DetectorsDescriptorActions) { - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.DetectorDescriptor(action), options); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.DetectorUpdateDescriptor(action), options); } writer.WriteEndArray(); @@ -690,10 +690,10 @@ public UpdateJobRequestDescriptor JobId(Elastic.Clients.Elasticsearch.Id jobId) private IDictionary? CustomSettingsValue { get; set; } private long? DailyModelSnapshotRetentionAfterDaysValue { get; set; } private string? DescriptionValue { get; set; } - private ICollection? DetectorsValue { get; set; } - private Elastic.Clients.Elasticsearch.MachineLearning.DetectorDescriptor DetectorsDescriptor { get; set; } - private Action DetectorsDescriptorAction { get; set; } - private Action[] DetectorsDescriptorActions { get; set; } + private ICollection? DetectorsValue { get; set; } + private Elastic.Clients.Elasticsearch.MachineLearning.DetectorUpdateDescriptor DetectorsDescriptor { get; set; } + private Action DetectorsDescriptorAction { get; set; } + private Action[] DetectorsDescriptorActions { get; set; } private ICollection? GroupsValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.ModelPlotConfig? ModelPlotConfigValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.ModelPlotConfigDescriptor ModelPlotConfigDescriptor { get; set; } @@ -821,7 +821,7 @@ public UpdateJobRequestDescriptor Description(string? description) /// An array of detector update objects. /// /// - public UpdateJobRequestDescriptor Detectors(ICollection? detectors) + public UpdateJobRequestDescriptor Detectors(ICollection? detectors) { DetectorsDescriptor = null; DetectorsDescriptorAction = null; @@ -830,7 +830,7 @@ public UpdateJobRequestDescriptor Detectors(ICollection configure) + public UpdateJobRequestDescriptor Detectors(Action configure) { DetectorsValue = null; DetectorsDescriptor = null; @@ -848,7 +848,7 @@ public UpdateJobRequestDescriptor Detectors(Action[] configure) + public UpdateJobRequestDescriptor Detectors(params Action[] configure) { DetectorsValue = null; DetectorsDescriptor = null; @@ -1035,7 +1035,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o { writer.WritePropertyName("detectors"); writer.WriteStartArray(); - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.DetectorDescriptor(DetectorsDescriptorAction), options); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.DetectorUpdateDescriptor(DetectorsDescriptorAction), options); writer.WriteEndArray(); } else if (DetectorsDescriptorActions is not null) @@ -1044,7 +1044,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStartArray(); foreach (var action in DetectorsDescriptorActions) { - JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.DetectorDescriptor(action), options); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.DetectorUpdateDescriptor(action), options); } writer.WriteEndArray(); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs index 311f71a6840..0d1a079f90b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MachineLearning/ValidateDetectorRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class ValidateDetectorRequestParameters : RequestParameter /// /// -/// Validates an anomaly detection detector. +/// Validate an anomaly detection job. /// /// public sealed partial class ValidateDetectorRequest : PlainRequest, ISelfSerializable @@ -60,7 +60,7 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op /// /// -/// Validates an anomaly detection detector. +/// Validate an anomaly detection job. /// /// public sealed partial class ValidateDetectorRequestDescriptor : RequestDescriptor, ValidateDetectorRequestParameters> @@ -112,7 +112,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Validates an anomaly detection detector. +/// Validate an anomaly detection job. /// /// public sealed partial class ValidateDetectorRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiGetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/MultiGetRequest.g.cs index 479a8447f37..192b345d954 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 0142870ccb7..526b27fa61e 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 c987991b8cb..2c558db006d 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 03b4da10f08..9a6c3ba7206 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/Nodes/ClearRepositoriesMeteringArchiveRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ClearRepositoriesMeteringArchiveRequest.g.cs index 5e3c83cc33a..bd81ff113e0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ClearRepositoriesMeteringArchiveRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ClearRepositoriesMeteringArchiveRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class ClearRepositoriesMeteringArchiveRequestParameters : /// /// -/// You can use this API to clear the archived repositories metering information in the cluster. +/// Clear the archived repositories metering. +/// Clear the archived repositories metering information in the cluster. /// /// public sealed partial class ClearRepositoriesMeteringArchiveRequest : PlainRequest @@ -56,7 +57,8 @@ public ClearRepositoriesMeteringArchiveRequest(Elastic.Clients.Elasticsearch.Nod /// /// -/// You can use this API to clear the archived repositories metering information in the cluster. +/// Clear the archived repositories metering. +/// Clear the archived repositories metering information in the cluster. /// /// public sealed partial class ClearRepositoriesMeteringArchiveRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/GetRepositoriesMeteringInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/GetRepositoriesMeteringInfoRequest.g.cs index a292580e104..58ce8fee68b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/GetRepositoriesMeteringInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/GetRepositoriesMeteringInfoRequest.g.cs @@ -36,10 +36,10 @@ public sealed partial class GetRepositoriesMeteringInfoRequestParameters : Reque /// /// -/// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. -/// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the -/// information needed to compute aggregations over a period of time. Additionally, the information exposed by this -/// API is volatile, meaning that it won’t be present after node restarts. +/// Get cluster repositories metering. +/// Get repositories metering information for a cluster. +/// This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. +/// Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. /// /// public sealed partial class GetRepositoriesMeteringInfoRequest : PlainRequest @@ -59,10 +59,10 @@ public GetRepositoriesMeteringInfoRequest(Elastic.Clients.Elasticsearch.NodeIds /// /// -/// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. -/// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the -/// information needed to compute aggregations over a period of time. Additionally, the information exposed by this -/// API is volatile, meaning that it won’t be present after node restarts. +/// Get cluster repositories metering. +/// Get repositories metering information for a cluster. +/// This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. +/// Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. /// /// public sealed partial class GetRepositoriesMeteringInfoRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/HotThreadsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/HotThreadsRequest.g.cs index a975f255b63..0f6987065fc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/HotThreadsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/HotThreadsRequest.g.cs @@ -95,8 +95,9 @@ public sealed partial class HotThreadsRequestParameters : RequestParameters /// /// -/// 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. +/// Get the hot threads for nodes. +/// Get a breakdown of the hot threads on each selected node in the cluster. +/// The output is plain text with a breakdown of the top hot threads for each node. /// /// public sealed partial class HotThreadsRequest : PlainRequest @@ -188,8 +189,9 @@ public HotThreadsRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId) : base(r /// /// -/// 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. +/// Get the hot threads for nodes. +/// Get a breakdown of the hot threads on each selected node in the cluster. +/// The output is plain text with a breakdown of the top hot threads for each node. /// /// public sealed partial class HotThreadsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesInfoRequest.g.cs index afc2a557ec0..104b1f5333f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesInfoRequest.g.cs @@ -56,7 +56,8 @@ public sealed partial class NodesInfoRequestParameters : RequestParameters /// /// -/// Returns cluster nodes information. +/// Get node information. +/// By default, the API returns all attributes and core settings for cluster nodes. /// /// public sealed partial class NodesInfoRequest : PlainRequest @@ -112,7 +113,8 @@ public NodesInfoRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.C /// /// -/// Returns cluster nodes information. +/// Get node information. +/// By default, the API returns all attributes and core settings for cluster nodes. /// /// public sealed partial class NodesInfoRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesStatsRequest.g.cs index e5d075f10ac..47a0483057f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesStatsRequest.g.cs @@ -105,7 +105,9 @@ public sealed partial class NodesStatsRequestParameters : RequestParameters /// /// -/// Returns cluster nodes statistics. +/// Get node statistics. +/// Get statistics for nodes in a cluster. +/// By default, all stats are returned. You can limit the returned information by using metrics. /// /// public sealed partial class NodesStatsRequest : PlainRequest @@ -225,7 +227,9 @@ public NodesStatsRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic. /// /// -/// Returns cluster nodes statistics. +/// Get node statistics. +/// Get statistics for nodes in a cluster. +/// By default, all stats are returned. You can limit the returned information by using metrics. /// /// public sealed partial class NodesStatsRequestDescriptor : RequestDescriptor, NodesStatsRequestParameters> @@ -284,7 +288,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns cluster nodes statistics. +/// Get node statistics. +/// Get statistics for nodes in a cluster. +/// By default, all stats are returned. You can limit the returned information by using metrics. /// /// public sealed partial class NodesStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesUsageRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesUsageRequest.g.cs index 17b4a1378fb..28adaf7a654 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesUsageRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/NodesUsageRequest.g.cs @@ -43,7 +43,7 @@ public sealed partial class NodesUsageRequestParameters : RequestParameters /// /// -/// Returns information on the usage of features. +/// Get feature usage information. /// /// public sealed partial class NodesUsageRequest : PlainRequest @@ -84,7 +84,7 @@ public NodesUsageRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic. /// /// -/// Returns information on the usage of features. +/// Get feature usage information. /// /// public sealed partial class NodesUsageRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ReloadSecureSettingsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ReloadSecureSettingsRequest.g.cs index 35a1ab3f600..5e944e764a9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ReloadSecureSettingsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Nodes/ReloadSecureSettingsRequest.g.cs @@ -43,7 +43,17 @@ public sealed partial class ReloadSecureSettingsRequestParameters : RequestParam /// /// -/// Reloads the keystore on nodes in the cluster. +/// Reload the keystore on nodes in the cluster. +/// +/// +/// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. +/// That is, you can change them on disk and reload them without restarting any nodes in the cluster. +/// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. +/// +/// +/// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. +/// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. +/// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// public sealed partial class ReloadSecureSettingsRequest : PlainRequest @@ -84,7 +94,17 @@ public ReloadSecureSettingsRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId /// /// -/// Reloads the keystore on nodes in the cluster. +/// Reload the keystore on nodes in the cluster. +/// +/// +/// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. +/// That is, you can change them on disk and reload them without restarting any nodes in the cluster. +/// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. +/// +/// +/// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. +/// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. +/// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// public sealed partial class ReloadSecureSettingsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/OpenPointInTimeRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/OpenPointInTimeRequest.g.cs index 7eba519c3bc..4741472e4d9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/OpenPointInTimeRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/OpenPointInTimeRequest.g.cs @@ -32,6 +32,14 @@ namespace Elastic.Clients.Elasticsearch; public sealed partial class OpenPointInTimeRequestParameters : RequestParameters { + /// + /// + /// If false, creating a point in time request when a shard is missing or unavailable will throw an exception. + /// If true, the point in time will contain all the shards that are available at the time of the request. + /// + /// + public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } + /// /// /// Type of index that wildcard patterns can match. @@ -73,13 +81,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 { @@ -95,6 +110,15 @@ public OpenPointInTimeRequest(Elastic.Clients.Elasticsearch.Indices indices) : b internal override string OperationName => "open_point_in_time"; + /// + /// + /// If false, creating a point in time request when a shard is missing or unavailable will throw an exception. + /// If true, the point in time will contain all the shards that are available at the time of the request. + /// + /// + [JsonIgnore] + public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } + /// /// /// Type of index that wildcard patterns can match. @@ -149,13 +173,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> { @@ -177,6 +208,7 @@ public OpenPointInTimeRequestDescriptor() : this(typeof(TDocument)) internal override string OperationName => "open_point_in_time"; + public OpenPointInTimeRequestDescriptor AllowPartialSearchResults(bool? allowPartialSearchResults = true) => Qs("allow_partial_search_results", allowPartialSearchResults); public OpenPointInTimeRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public OpenPointInTimeRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); public OpenPointInTimeRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration keepAlive) => Qs("keep_alive", keepAlive); @@ -247,13 +279,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 { @@ -271,6 +310,7 @@ public OpenPointInTimeRequestDescriptor(Elastic.Clients.Elasticsearch.Indices in internal override string OperationName => "open_point_in_time"; + public OpenPointInTimeRequestDescriptor AllowPartialSearchResults(bool? allowPartialSearchResults = true) => Qs("allow_partial_search_results", allowPartialSearchResults); public OpenPointInTimeRequestDescriptor ExpandWildcards(ICollection? expandWildcards) => Qs("expand_wildcards", expandWildcards); public OpenPointInTimeRequestDescriptor IgnoreUnavailable(bool? ignoreUnavailable = true) => Qs("ignore_unavailable", ignoreUnavailable); public OpenPointInTimeRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration keepAlive) => Qs("keep_alive", keepAlive); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/PingRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/PingRequest.g.cs index eef881b997d..34182e1e3e2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/PingRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/PingRequest.g.cs @@ -37,7 +37,7 @@ public sealed partial class PingRequestParameters : RequestParameters /// /// /// Ping the cluster. -/// Returns whether the cluster is running. +/// Get information about whether the cluster is running. /// /// public sealed partial class PingRequest : PlainRequest @@ -54,7 +54,7 @@ public sealed partial class PingRequest : PlainRequest /// /// /// Ping the cluster. -/// Returns whether the cluster is running. +/// Get information about whether the cluster is running. /// /// public sealed partial class PingRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRuleRequest.g.cs index b7dc2979ea0..5db5e648058 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRuleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class DeleteRuleRequestParameters : RequestParameters /// /// -/// Deletes a query rule within a query ruleset. +/// Delete a query rule. +/// Delete a query rule within a query ruleset. /// /// public sealed partial class DeleteRuleRequest : PlainRequest @@ -56,7 +57,8 @@ public DeleteRuleRequest(Elastic.Clients.Elasticsearch.Id rulesetId, Elastic.Cli /// /// -/// Deletes a query rule within a query ruleset. +/// Delete a query rule. +/// Delete a query rule within a query ruleset. /// /// public sealed partial class DeleteRuleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs index 77e70e908c5..c9ff402c290 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/DeleteRulesetRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class DeleteRulesetRequestParameters : RequestParameters /// /// -/// Deletes a query ruleset. +/// Delete a query ruleset. /// /// public sealed partial class DeleteRulesetRequest : PlainRequest @@ -56,7 +56,7 @@ public DeleteRulesetRequest(Elastic.Clients.Elasticsearch.Id rulesetId) : base(r /// /// -/// Deletes a query ruleset. +/// Delete a query ruleset. /// /// public sealed partial class DeleteRulesetRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRuleRequest.g.cs index 206aaa37ca8..947016c599d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRuleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetRuleRequestParameters : RequestParameters /// /// -/// Returns the details about a query rule within a query ruleset +/// Get a query rule. +/// Get details about a query rule within a query ruleset. /// /// public sealed partial class GetRuleRequest : PlainRequest @@ -56,7 +57,8 @@ public GetRuleRequest(Elastic.Clients.Elasticsearch.Id rulesetId, Elastic.Client /// /// -/// Returns the details about a query rule within a query ruleset +/// Get a query rule. +/// Get details about a query rule within a query ruleset. /// /// public sealed partial class GetRuleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRulesetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRulesetRequest.g.cs index cb4d3848bf6..2241fbfbab8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRulesetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/GetRulesetRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetRulesetRequestParameters : RequestParameters /// /// -/// Returns the details about a query ruleset +/// Get a query ruleset. +/// Get details about a query ruleset. /// /// public sealed partial class GetRulesetRequest : PlainRequest @@ -56,7 +57,8 @@ public GetRulesetRequest(Elastic.Clients.Elasticsearch.Id rulesetId) : base(r => /// /// -/// Returns the details about a query ruleset +/// Get a query ruleset. +/// Get details about a query ruleset. /// /// public sealed partial class GetRulesetRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs index 17c90868680..1c0b5e1be87 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/ListRulesetsRequest.g.cs @@ -49,7 +49,8 @@ public sealed partial class ListRulesetsRequestParameters : RequestParameters /// /// -/// Returns summarized information about existing query rulesets. +/// Get all query rulesets. +/// Get summarized information about the query rulesets. /// /// public sealed partial class ListRulesetsRequest : PlainRequest @@ -81,7 +82,8 @@ public sealed partial class ListRulesetsRequest : PlainRequest /// -/// Returns summarized information about existing query rulesets. +/// Get all query rulesets. +/// Get summarized information about the query rulesets. /// /// public sealed partial class ListRulesetsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/PutRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/PutRuleRequest.g.cs index 18c0aa7a6bf..b9287c5cda7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/PutRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/PutRuleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class PutRuleRequestParameters : RequestParameters /// /// -/// Creates or updates a query rule within a query ruleset. +/// Create or update a query rule. +/// Create or update a query rule within a query ruleset. /// /// public sealed partial class PutRuleRequest : PlainRequest @@ -66,7 +67,8 @@ public PutRuleRequest(Elastic.Clients.Elasticsearch.Id rulesetId, Elastic.Client /// /// -/// Creates or updates a query rule within a query ruleset. +/// Create or update a query rule. +/// Create or update a query rule within a query ruleset. /// /// public sealed partial class PutRuleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/PutRulesetRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/PutRulesetRequest.g.cs index 22c3f8e0639..3d91b4e2890 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/PutRulesetRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/PutRulesetRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class PutRulesetRequestParameters : RequestParameters /// /// -/// Creates or updates a query ruleset. +/// Create or update a query ruleset. /// /// public sealed partial class PutRulesetRequest : PlainRequest @@ -60,7 +60,7 @@ public PutRulesetRequest(Elastic.Clients.Elasticsearch.Id rulesetId) : base(r => /// /// -/// Creates or updates a query ruleset. +/// Create or update a query ruleset. /// /// public sealed partial class PutRulesetRequestDescriptor : 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 00000000000..973d126cfdb --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/QueryRules/TestRequest.g.cs @@ -0,0 +1,104 @@ +// 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 +{ +} + +/// +/// +/// Test a query ruleset. +/// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. +/// +/// +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; } +} + +/// +/// +/// Test a query ruleset. +/// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. +/// +/// +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 00000000000..6afa8a862e7 --- /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 a883c183c86..c42ede2ec90 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 c5b605c9aad..88bf92f8d80 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 3271a224123..26361bc0ec5 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/Rollup/DeleteJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/DeleteJobRequest.g.cs index 22c64e0da0c..aa025a5e23b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/DeleteJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/DeleteJobRequest.g.cs @@ -36,8 +36,32 @@ public sealed partial class DeleteJobRequestParameters : RequestParameters /// /// -/// Deletes an existing rollup job. +/// Delete a rollup job. /// +/// +/// A job must be stopped before it can be deleted. +/// If you attempt to delete a started job, an error occurs. +/// Similarly, if you attempt to delete a nonexistent job, an exception occurs. +/// +/// +/// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. +/// The API does not delete any previously rolled up data. +/// This is by design; a user may wish to roll up a static data set. +/// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). +/// Thus the job can be deleted, leaving behind the rolled up data for analysis. +/// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. +/// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: +/// +/// +/// POST my_rollup_index/_delete_by_query +/// { +/// "query": { +/// "term": { +/// "_rollup.id": "the_rollup_job_id" +/// } +/// } +/// } +/// /// public sealed partial class DeleteJobRequest : PlainRequest { @@ -56,8 +80,32 @@ public DeleteJobRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requi /// /// -/// Deletes an existing rollup job. +/// Delete a rollup job. +/// +/// +/// A job must be stopped before it can be deleted. +/// If you attempt to delete a started job, an error occurs. +/// Similarly, if you attempt to delete a nonexistent job, an exception occurs. /// +/// +/// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. +/// The API does not delete any previously rolled up data. +/// This is by design; a user may wish to roll up a static data set. +/// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). +/// Thus the job can be deleted, leaving behind the rolled up data for analysis. +/// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. +/// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: +/// +/// +/// POST my_rollup_index/_delete_by_query +/// { +/// "query": { +/// "term": { +/// "_rollup.id": "the_rollup_job_id" +/// } +/// } +/// } +/// /// public sealed partial class DeleteJobRequestDescriptor : RequestDescriptor, DeleteJobRequestParameters> { @@ -88,8 +136,32 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes an existing rollup job. +/// Delete a rollup job. +/// +/// +/// A job must be stopped before it can be deleted. +/// If you attempt to delete a started job, an error occurs. +/// Similarly, if you attempt to delete a nonexistent job, an exception occurs. +/// +/// +/// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. +/// The API does not delete any previously rolled up data. +/// This is by design; a user may wish to roll up a static data set. +/// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). +/// Thus the job can be deleted, leaving behind the rolled up data for analysis. +/// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. +/// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: /// +/// +/// POST my_rollup_index/_delete_by_query +/// { +/// "query": { +/// "term": { +/// "_rollup.id": "the_rollup_job_id" +/// } +/// } +/// } +/// /// public sealed partial class DeleteJobRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetJobsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetJobsRequest.g.cs index 6ef40b0b3b3..fdf23d38c7e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetJobsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetJobsRequest.g.cs @@ -36,7 +36,13 @@ public sealed partial class GetJobsRequestParameters : RequestParameters /// /// -/// Retrieves the configuration, stats, and status of rollup jobs. +/// Get rollup job information. +/// Get the configuration, stats, and status of rollup jobs. +/// +/// +/// NOTE: This API returns only active (both STARTED and STOPPED) jobs. +/// If a job was created, ran for a while, then was deleted, the API does not return any details about it. +/// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// public sealed partial class GetJobsRequest : PlainRequest @@ -60,7 +66,13 @@ public GetJobsRequest(Elastic.Clients.Elasticsearch.Id? id) : base(r => r.Option /// /// -/// Retrieves the configuration, stats, and status of rollup jobs. +/// Get rollup job information. +/// Get the configuration, stats, and status of rollup jobs. +/// +/// +/// NOTE: This API returns only active (both STARTED and STOPPED) jobs. +/// If a job was created, ran for a while, then was deleted, the API does not return any details about it. +/// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// public sealed partial class GetJobsRequestDescriptor : RequestDescriptor, GetJobsRequestParameters> @@ -96,7 +108,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieves the configuration, stats, and status of rollup jobs. +/// Get rollup job information. +/// Get the configuration, stats, and status of rollup jobs. +/// +/// +/// NOTE: This API returns only active (both STARTED and STOPPED) jobs. +/// If a job was created, ran for a while, then was deleted, the API does not return any details about it. +/// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// public sealed partial class GetJobsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupCapsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupCapsRequest.g.cs index 84e3ca5d52a..7da32db36d5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupCapsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupCapsRequest.g.cs @@ -36,8 +36,26 @@ public sealed partial class GetRollupCapsRequestParameters : RequestParameters /// /// -/// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. +/// Get the rollup job capabilities. +/// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. /// +/// +/// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. +/// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. +/// This API enables you to inspect an index and determine: +/// +/// +/// +/// +/// Does this index have associated rollup data somewhere in the cluster? +/// +/// +/// +/// +/// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? +/// +/// +/// /// public sealed partial class GetRollupCapsRequest : PlainRequest { @@ -60,8 +78,26 @@ public GetRollupCapsRequest(Elastic.Clients.Elasticsearch.Id? id) : base(r => r. /// /// -/// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. +/// Get the rollup job capabilities. +/// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. +/// +/// +/// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. +/// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. +/// This API enables you to inspect an index and determine: +/// +/// +/// +/// +/// Does this index have associated rollup data somewhere in the cluster? +/// +/// +/// +/// +/// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? /// +/// +/// /// public sealed partial class GetRollupCapsRequestDescriptor : RequestDescriptor, GetRollupCapsRequestParameters> { @@ -96,8 +132,26 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. +/// Get the rollup job capabilities. +/// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. +/// +/// +/// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. +/// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. +/// This API enables you to inspect an index and determine: +/// +/// +/// +/// +/// Does this index have associated rollup data somewhere in the cluster? +/// +/// +/// +/// +/// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? /// +/// +/// /// public sealed partial class GetRollupCapsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupIndexCapsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupIndexCapsRequest.g.cs index 905c78c528a..f9e818a1e27 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupIndexCapsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/GetRollupIndexCapsRequest.g.cs @@ -36,8 +36,22 @@ public sealed partial class GetRollupIndexCapsRequestParameters : RequestParamet /// /// -/// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). +/// Get the rollup index capabilities. +/// Get the rollup capabilities of all jobs inside of a rollup index. +/// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: /// +/// +/// +/// +/// What jobs are stored in an index (or indices specified via a pattern)? +/// +/// +/// +/// +/// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? +/// +/// +/// /// public sealed partial class GetRollupIndexCapsRequest : PlainRequest { @@ -56,8 +70,22 @@ public GetRollupIndexCapsRequest(Elastic.Clients.Elasticsearch.Ids index) : base /// /// -/// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). +/// Get the rollup index capabilities. +/// Get the rollup capabilities of all jobs inside of a rollup index. +/// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: +/// +/// +/// +/// +/// What jobs are stored in an index (or indices specified via a pattern)? /// +/// +/// +/// +/// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? +/// +/// +/// /// public sealed partial class GetRollupIndexCapsRequestDescriptor : RequestDescriptor, GetRollupIndexCapsRequestParameters> { @@ -88,8 +116,22 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). +/// Get the rollup index capabilities. +/// Get the rollup capabilities of all jobs inside of a rollup index. +/// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: +/// +/// +/// +/// +/// What jobs are stored in an index (or indices specified via a pattern)? +/// +/// +/// +/// +/// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? /// +/// +/// /// public sealed partial class GetRollupIndexCapsRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/PutJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/PutJobRequest.g.cs index eff76b4c695..32ac6dc9b6b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/PutJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/PutJobRequest.g.cs @@ -36,7 +36,19 @@ public sealed partial class PutJobRequestParameters : RequestParameters /// /// -/// Creates a rollup job. +/// Create a rollup job. +/// +/// +/// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. +/// +/// +/// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. +/// +/// +/// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. +/// +/// +/// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// public sealed partial class PutJobRequest : PlainRequest @@ -127,7 +139,19 @@ public PutJobRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required /// /// -/// Creates a rollup job. +/// Create a rollup job. +/// +/// +/// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. +/// +/// +/// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. +/// +/// +/// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. +/// +/// +/// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// public sealed partial class PutJobRequestDescriptor : RequestDescriptor, PutJobRequestParameters> @@ -386,7 +410,19 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Creates a rollup job. +/// Create a rollup job. +/// +/// +/// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. +/// +/// +/// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. +/// +/// +/// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. +/// +/// +/// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// public sealed partial class PutJobRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/RollupSearchRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/RollupSearchRequest.g.cs index d24f3feb80a..983b3bbff95 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/RollupSearchRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/RollupSearchRequest.g.cs @@ -109,7 +109,9 @@ public override void Write(Utf8JsonWriter writer, RollupSearchRequest value, Jso /// /// -/// Enables searching rolled-up data using the standard Query DSL. +/// Search rolled-up data. +/// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. +/// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// [JsonConverter(typeof(RollupSearchRequestConverter))] @@ -174,7 +176,9 @@ public RollupSearchRequest() /// /// -/// Enables searching rolled-up data using the standard Query DSL. +/// Search rolled-up data. +/// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. +/// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// public sealed partial class RollupSearchRequestDescriptor : RequestDescriptor, RollupSearchRequestParameters> @@ -300,7 +304,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Enables searching rolled-up data using the standard Query DSL. +/// Search rolled-up data. +/// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. +/// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// public sealed partial class RollupSearchRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StartJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StartJobRequest.g.cs index cad0b8391f9..d5cfcc92559 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StartJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StartJobRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class StartJobRequestParameters : RequestParameters /// /// -/// Starts an existing, stopped rollup job. +/// Start rollup jobs. +/// If you try to start a job that does not exist, an exception occurs. +/// If you try to start a job that is already started, nothing happens. /// /// public sealed partial class StartJobRequest : PlainRequest @@ -56,7 +58,9 @@ public StartJobRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requir /// /// -/// Starts an existing, stopped rollup job. +/// Start rollup jobs. +/// If you try to start a job that does not exist, an exception occurs. +/// If you try to start a job that is already started, nothing happens. /// /// public sealed partial class StartJobRequestDescriptor : RequestDescriptor, StartJobRequestParameters> @@ -88,7 +92,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Starts an existing, stopped rollup job. +/// Start rollup jobs. +/// If you try to start a job that does not exist, an exception occurs. +/// If you try to start a job that is already started, nothing happens. /// /// public sealed partial class StartJobRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StopJobRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StopJobRequest.g.cs index 696e513e8bd..f4129512b7e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StopJobRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Rollup/StopJobRequest.g.cs @@ -51,7 +51,9 @@ public sealed partial class StopJobRequestParameters : RequestParameters /// /// -/// Stops an existing, started rollup job. +/// Stop rollup jobs. +/// If you try to stop a job that does not exist, an exception occurs. +/// If you try to stop a job that is already stopped, nothing happens. /// /// public sealed partial class StopJobRequest : PlainRequest @@ -89,7 +91,9 @@ public StopJobRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Require /// /// -/// Stops an existing, started rollup job. +/// Stop rollup jobs. +/// If you try to stop a job that does not exist, an exception occurs. +/// If you try to stop a job that is already stopped, nothing happens. /// /// public sealed partial class StopJobRequestDescriptor : RequestDescriptor, StopJobRequestParameters> @@ -124,7 +128,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Stops an existing, started rollup job. +/// Stop rollup jobs. +/// If you try to stop a job that does not exist, an exception occurs. +/// If you try to stop a job that is already stopped, nothing happens. /// /// public sealed partial class StopJobRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScrollRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/ScrollRequest.g.cs index 1d1f64d6ab7..71eeba5ada6 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 13bcb8d5841..e8dfe37f8c5 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 634f03fc463..c1945b4a695 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 30d3c434500..09736ffa1d9 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 7e67b3cc67f..2863e257262 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 31266e7e692..7c11901438f 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 7bd1c72a260..9e3baa8588e 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 923f66d1ae8..79f27aa0434 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/SearchableSnapshots/CacheStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/CacheStatsRequest.g.cs index df6332303d9..e7abfbbbe1c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/CacheStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/CacheStatsRequest.g.cs @@ -37,7 +37,8 @@ public sealed partial class CacheStatsRequestParameters : RequestParameters /// /// -/// Retrieve node-level cache statistics about searchable snapshots. +/// Get cache statistics. +/// Get statistics about the shared cache for partially mounted indices. /// /// public sealed partial class CacheStatsRequest : PlainRequest @@ -64,7 +65,8 @@ public CacheStatsRequest(Elastic.Clients.Elasticsearch.NodeIds? nodeId) : base(r /// /// -/// Retrieve node-level cache statistics about searchable snapshots. +/// Get cache statistics. +/// Get statistics about the shared cache for partially mounted indices. /// /// public sealed partial class CacheStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/ClearCacheRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/ClearCacheRequest.g.cs index 6f4a9c43964..92a8547f9d3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/ClearCacheRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/ClearCacheRequest.g.cs @@ -56,7 +56,8 @@ public sealed partial class ClearCacheRequestParameters : RequestParameters /// /// -/// Clear the cache of searchable snapshots. +/// Clear the cache. +/// Clear indices and data streams from the shared cache for partially mounted indices. /// /// public sealed partial class ClearCacheRequest : PlainRequest @@ -104,7 +105,8 @@ public ClearCacheRequest(Elastic.Clients.Elasticsearch.Indices? indices) : base( /// /// -/// Clear the cache of searchable snapshots. +/// Clear the cache. +/// Clear indices and data streams from the shared cache for partially mounted indices. /// /// public sealed partial class ClearCacheRequestDescriptor : RequestDescriptor, ClearCacheRequestParameters> @@ -144,7 +146,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Clear the cache of searchable snapshots. +/// Clear the cache. +/// Clear indices and data streams from the shared cache for partially mounted indices. /// /// public sealed partial class ClearCacheRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/MountRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/MountRequest.g.cs index 05fa84ac6c4..fd393b4da9f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/MountRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/MountRequest.g.cs @@ -56,7 +56,10 @@ public sealed partial class MountRequestParameters : RequestParameters /// /// -/// Mount a snapshot as a searchable index. +/// Mount a snapshot. +/// Mount a snapshot as a searchable snapshot index. +/// Do not use this API for snapshots managed by index lifecycle management (ILM). +/// Manually mounting ILM-managed snapshots can interfere with ILM processes. /// /// public sealed partial class MountRequest : PlainRequest @@ -108,7 +111,10 @@ public MountRequest(Elastic.Clients.Elasticsearch.Name repository, Elastic.Clien /// /// -/// Mount a snapshot as a searchable index. +/// Mount a snapshot. +/// Mount a snapshot as a searchable snapshot index. +/// Do not use this API for snapshots managed by index lifecycle management (ILM). +/// Manually mounting ILM-managed snapshots can interfere with ILM processes. /// /// public sealed partial class MountRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/SearchableSnapshotsStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/SearchableSnapshotsStatsRequest.g.cs index 1894a388247..24db2126902 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/SearchableSnapshotsStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SearchableSnapshots/SearchableSnapshotsStatsRequest.g.cs @@ -42,7 +42,7 @@ public sealed partial class SearchableSnapshotsStatsRequestParameters : RequestP /// /// -/// Retrieve shard-level statistics about searchable snapshots. +/// Get searchable snapshot statistics. /// /// public sealed partial class SearchableSnapshotsStatsRequest : PlainRequest @@ -74,7 +74,7 @@ public SearchableSnapshotsStatsRequest(Elastic.Clients.Elasticsearch.Indices? in /// /// -/// Retrieve shard-level statistics about searchable snapshots. +/// Get searchable snapshot statistics. /// /// public sealed partial class SearchableSnapshotsStatsRequestDescriptor : RequestDescriptor, SearchableSnapshotsStatsRequestParameters> @@ -112,7 +112,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieve shard-level statistics about searchable snapshots. +/// Get searchable snapshot statistics. /// /// public sealed partial class SearchableSnapshotsStatsRequestDescriptor : 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 cff16e81b4f..6efb0a6afae 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 ee6d297fcd6..e070e72ef85 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/AuthenticateResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/AuthenticateResponse.g.cs index dc51b50bb4d..0ce01ead1df 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/AuthenticateResponse.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/AuthenticateResponse.g.cs @@ -29,7 +29,7 @@ namespace Elastic.Clients.Elasticsearch.Security; public sealed partial class AuthenticateResponse : ElasticsearchResponse { [JsonInclude, JsonPropertyName("api_key")] - public Elastic.Clients.Elasticsearch.Security.ApiKey? ApiKey { get; init; } + public Elastic.Clients.Elasticsearch.Security.AuthenticateApiKey? ApiKey { get; init; } [JsonInclude, JsonPropertyName("authentication_realm")] public Elastic.Clients.Elasticsearch.Security.RealmInfo AuthenticationRealm { get; init; } [JsonInclude, JsonPropertyName("authentication_type")] 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 c1b55603478..c078ddfd772 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 120d3068d6a..15cd7c44396 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 d25c22e0aae..4c483138389 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 a62551acf22..48b0f598878 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 a9170d3c2fd..19bedb531d5 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 6873cadc5f8..0687c5d5d41 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 60ef63b37b0..1b630f2adff 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 9988ce26447..a018b729fd4 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 b09feb4d128..cc79ddf4274 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 00000000000..2ca3d9d6e10 --- /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/Api/Security/CreateCrossClusterApiKeyResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateCrossClusterApiKeyResponse.g.cs new file mode 100644 index 00000000000..3dcac6531a1 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Security/CreateCrossClusterApiKeyResponse.g.cs @@ -0,0 +1,72 @@ +// 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 CreateCrossClusterApiKeyResponse : ElasticsearchResponse +{ + /// + /// + /// Generated API key. + /// + /// + [JsonInclude, JsonPropertyName("api_key")] + public string ApiKey { get; init; } + + /// + /// + /// API key credentials which is the base64-encoding of + /// the UTF-8 representation of id and api_key joined + /// by a colon (:). + /// + /// + [JsonInclude, JsonPropertyName("encoded")] + public string Encoded { get; init; } + + /// + /// + /// Expiration in milliseconds for the API key. + /// + /// + [JsonInclude, JsonPropertyName("expiration")] + public long? Expiration { get; init; } + + /// + /// + /// Unique ID for this API key. + /// + /// + [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 82f0154e7e6..6b8dd3f4062 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 55d79f9287e..320489f1431 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 aafbd9fe708..2421e540477 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 2bf1ca5061a..fd976f508f4 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 6183ce96414..94441f708bb 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 6c01fdbe59e..90e38b47654 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 c0d51b98600..ee4991e79cf 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 1c98402cd49..e8f286a5a80 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 423075f3888..725a5665805 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 019ff052db9..4758880e9f4 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 83ced516fb8..51c0a32e140 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 19c48694766..580b4bc0b0c 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 996c419b3fe..57ce8199ac0 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 86da44c5865..218da5b567b 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 0f19d1b9a0e..2410a2d7776 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 e9b962cc0ff..54604deb0ad 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 3eb5c006fc7..8a4c6a97c43 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 277814202e1..9269177ee80 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 157e7bb90ee..921b203f237 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 bf51be2829d..a1a5d627f24 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 d3ade1b87c5..ee7fd7ce384 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 903249037d0..52d790b0458 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 aa80263756d..fa92cf1108f 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 734533078e9..9c77e91e3f6 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 5f0efc84624..c09da87befc 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 3ac8a626a3d..623c868da87 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 15dd0268db1..81f80132120 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 02dbbe38899..d648b5974ce 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 6c7c79d4e4e..4386ef53852 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 61b7a74d58b..9ba02c01239 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 748f72aa996..e0713523d9f 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 6f508ca957e..300912ec21c 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 9f9434d6e73..be4076b0394 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 f58fc473b5c..fdd42b6136d 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 08bee4543e0..e55732256d7 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 e29f3618f4d..c5d98d22452 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 5de9a26fc68..478b941c9d3 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 3fec565f907..9224bf81328 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 c4f8d7f7257..987ee8fde44 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 319b2e2d920..ffa0b19985c 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 c82dce9acf2..9afa7d595d4 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 50a7c5682ea..009395c49bc 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 7e54558792e..c6596d47ecb 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 488cea1b6d7..15a488a199c 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 00000000000..c93f01a473e --- /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 00000000000..d884f62166e --- /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 1427c4ba1bb..98048ccd890 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/CleanupRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs index 4f7d24f7fa3..3f7be7b5baa 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CleanupRepositoryRequest.g.cs @@ -49,7 +49,8 @@ public sealed partial class CleanupRepositoryRequestParameters : RequestParamete /// /// -/// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. +/// Clean up the snapshot repository. +/// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// public sealed partial class CleanupRepositoryRequest : PlainRequest @@ -85,7 +86,8 @@ public CleanupRepositoryRequest(Elastic.Clients.Elasticsearch.Name name) : base( /// /// -/// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. +/// Clean up the snapshot repository. +/// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// public sealed partial class CleanupRepositoryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs index f2d56ebe57b..69c10ac78c7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CloneSnapshotRequest.g.cs @@ -43,7 +43,8 @@ public sealed partial class CloneSnapshotRequestParameters : RequestParameters /// /// -/// Clones indices from one snapshot into another snapshot in the same repository. +/// Clone a snapshot. +/// Clone part of all of a snapshot into another snapshot in the same repository. /// /// public sealed partial class CloneSnapshotRequest : PlainRequest @@ -75,7 +76,8 @@ public CloneSnapshotRequest(Elastic.Clients.Elasticsearch.Name repository, Elast /// /// -/// Clones indices from one snapshot into another snapshot in the same repository. +/// Clone a snapshot. +/// Clone part of all of a snapshot into another snapshot in the same repository. /// /// public sealed partial class CloneSnapshotRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs index 48f82d31977..bba5de0492f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateRepositoryRequest.g.cs @@ -56,7 +56,10 @@ public sealed partial class CreateRepositoryRequestParameters : RequestParameter /// /// -/// Creates a repository. +/// Create or update a snapshot repository. +/// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. +/// To register a snapshot repository, the cluster's global metadata must be writeable. +/// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// public sealed partial class CreateRepositoryRequest : PlainRequest, ISelfSerializable @@ -107,7 +110,10 @@ void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions op /// /// -/// Creates a repository. +/// Create or update a snapshot repository. +/// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. +/// To register a snapshot repository, the cluster's global metadata must be writeable. +/// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// public sealed partial class CreateRepositoryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs index 9c963bf9059..974b6350300 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/CreateSnapshotRequest.g.cs @@ -49,7 +49,8 @@ public sealed partial class CreateSnapshotRequestParameters : RequestParameters /// /// -/// Creates a snapshot in a repository. +/// Create a snapshot. +/// Take a snapshot of a cluster or of data streams and indices. /// /// public sealed partial class CreateSnapshotRequest : PlainRequest @@ -133,7 +134,8 @@ public CreateSnapshotRequest(Elastic.Clients.Elasticsearch.Name repository, Elas /// /// -/// Creates a snapshot in a repository. +/// Create a snapshot. +/// Take a snapshot of a cluster or of data streams and indices. /// /// public sealed partial class CreateSnapshotRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs index 41acee94388..bda787380fe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteRepositoryRequest.g.cs @@ -49,7 +49,9 @@ public sealed partial class DeleteRepositoryRequestParameters : RequestParameter /// /// -/// Deletes a repository. +/// Delete snapshot repositories. +/// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. +/// The snapshots themselves are left untouched and in place. /// /// public sealed partial class DeleteRepositoryRequest : PlainRequest @@ -85,7 +87,9 @@ public DeleteRepositoryRequest(Elastic.Clients.Elasticsearch.Names name) : base( /// /// -/// Deletes a repository. +/// Delete snapshot repositories. +/// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. +/// The snapshots themselves are left untouched and in place. /// /// public sealed partial class DeleteRepositoryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs index 3435c965641..6b478e4cbff 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/DeleteSnapshotRequest.g.cs @@ -42,7 +42,7 @@ public sealed partial class DeleteSnapshotRequestParameters : RequestParameters /// /// -/// Deletes one or more snapshots. +/// Delete snapshots. /// /// public sealed partial class DeleteSnapshotRequest : PlainRequest @@ -70,7 +70,7 @@ public DeleteSnapshotRequest(Elastic.Clients.Elasticsearch.Name repository, Elas /// /// -/// Deletes one or more snapshots. +/// Delete snapshots. /// /// public sealed partial class DeleteSnapshotRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs index 5564259562b..a6279cf9d40 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetRepositoryRequest.g.cs @@ -49,7 +49,7 @@ public sealed partial class GetRepositoryRequestParameters : RequestParameters /// /// -/// Returns information about a repository. +/// Get snapshot repository information. /// /// public sealed partial class GetRepositoryRequest : PlainRequest @@ -89,7 +89,7 @@ public GetRepositoryRequest(Elastic.Clients.Elasticsearch.Names? name) : base(r /// /// -/// Returns information about a repository. +/// Get snapshot repository information. /// /// public sealed partial class GetRepositoryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs index d7cfbe43e6f..a920c821cac 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/GetSnapshotRequest.g.cs @@ -126,7 +126,7 @@ public sealed partial class GetSnapshotRequestParameters : RequestParameters /// /// -/// Returns information about a snapshot. +/// Get snapshot information. /// /// public sealed partial class GetSnapshotRequest : PlainRequest @@ -250,7 +250,7 @@ public GetSnapshotRequest(Elastic.Clients.Elasticsearch.Name repository, Elastic /// /// -/// Returns information about a snapshot. +/// Get snapshot information. /// /// public sealed partial class GetSnapshotRequestDescriptor : 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 00000000000..f48895454de --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RepositoryVerifyIntegrityRequest.g.cs @@ -0,0 +1,325 @@ +// 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); } +} + +/// +/// +/// Verify the repository integrity. +/// Verify the integrity of the contents of a snapshot repository. +/// +/// +/// This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. +/// +/// +/// If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its read_only option to true, and use this API to verify its integrity. +/// Until you do so: +/// +/// +/// +/// +/// It may not be possible to restore some snapshots from this repository. +/// +/// +/// +/// +/// Searchable snapshots may report errors when searched or may have unassigned shards. +/// +/// +/// +/// +/// Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. +/// +/// +/// +/// +/// Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. +/// +/// +/// +/// +/// Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. +/// +/// +/// +/// +/// If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. +/// The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. +/// You must also identify what caused the damage and take action to prevent it from happening again. +/// +/// +/// If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. +/// In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. +/// +/// +/// Avoid all operations which write to the repository while the verify repository integrity API is running. +/// If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. +/// It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. +/// +/// +/// NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. +/// +/// +/// NOTE: This API may not work correctly in a mixed-version cluster. +/// +/// +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); } +} + +/// +/// +/// Verify the repository integrity. +/// Verify the integrity of the contents of a snapshot repository. +/// +/// +/// This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. +/// +/// +/// If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its read_only option to true, and use this API to verify its integrity. +/// Until you do so: +/// +/// +/// +/// +/// It may not be possible to restore some snapshots from this repository. +/// +/// +/// +/// +/// Searchable snapshots may report errors when searched or may have unassigned shards. +/// +/// +/// +/// +/// Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. +/// +/// +/// +/// +/// Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. +/// +/// +/// +/// +/// Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. +/// +/// +/// +/// +/// If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. +/// The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. +/// You must also identify what caused the damage and take action to prevent it from happening again. +/// +/// +/// If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. +/// In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. +/// +/// +/// Avoid all operations which write to the repository while the verify repository integrity API is running. +/// If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. +/// It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. +/// +/// +/// NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. +/// +/// +/// NOTE: This API may not work correctly in a mixed-version cluster. +/// +/// +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 00000000000..15a2250ef7f --- /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/Snapshot/RestoreRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RestoreRequest.g.cs index 6ad466530e9..73de6d5abec 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RestoreRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/RestoreRequest.g.cs @@ -49,7 +49,28 @@ public sealed partial class RestoreRequestParameters : RequestParameters /// /// -/// Restores a snapshot. +/// Restore a snapshot. +/// Restore a snapshot of a cluster or data streams and indices. +/// +/// +/// You can restore a snapshot only to a running cluster with an elected master node. +/// The snapshot repository must be registered and available to the cluster. +/// The snapshot and cluster versions must be compatible. +/// +/// +/// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. +/// +/// +/// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: +/// +/// +/// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream +/// +/// +/// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. +/// +/// +/// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// public sealed partial class RestoreRequest : PlainRequest @@ -105,7 +126,28 @@ public RestoreRequest(Elastic.Clients.Elasticsearch.Name repository, Elastic.Cli /// /// -/// Restores a snapshot. +/// Restore a snapshot. +/// Restore a snapshot of a cluster or data streams and indices. +/// +/// +/// You can restore a snapshot only to a running cluster with an elected master node. +/// The snapshot repository must be registered and available to the cluster. +/// The snapshot and cluster versions must be compatible. +/// +/// +/// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. +/// +/// +/// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: +/// +/// +/// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream +/// +/// +/// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. +/// +/// +/// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// public sealed partial class RestoreRequestDescriptor : RequestDescriptor, RestoreRequestParameters> @@ -309,7 +351,28 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Restores a snapshot. +/// Restore a snapshot. +/// Restore a snapshot of a cluster or data streams and indices. +/// +/// +/// You can restore a snapshot only to a running cluster with an elected master node. +/// The snapshot repository must be registered and available to the cluster. +/// The snapshot and cluster versions must be compatible. +/// +/// +/// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. +/// +/// +/// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: +/// +/// +/// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream +/// +/// +/// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. +/// +/// +/// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// public sealed partial class RestoreRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs index cc1c9442cdf..11e6df51119 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/SnapshotStatusRequest.g.cs @@ -49,7 +49,19 @@ public sealed partial class SnapshotStatusRequestParameters : RequestParameters /// /// -/// Returns information about the status of a snapshot. +/// Get the snapshot status. +/// Get a detailed description of the current state for each shard participating in the snapshot. +/// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. +/// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. +/// +/// +/// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. +/// The API requires a read from the repository for each shard in each snapshot. +/// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). +/// +/// +/// Depending on the latency of your storage, such requests can take an extremely long time to return results. +/// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// public sealed partial class SnapshotStatusRequest : PlainRequest @@ -93,7 +105,19 @@ public SnapshotStatusRequest(Elastic.Clients.Elasticsearch.Name? repository, Ela /// /// -/// Returns information about the status of a snapshot. +/// Get the snapshot status. +/// Get a detailed description of the current state for each shard participating in the snapshot. +/// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. +/// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. +/// +/// +/// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. +/// The API requires a read from the repository for each shard in each snapshot. +/// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). +/// +/// +/// Depending on the latency of your storage, such requests can take an extremely long time to return results. +/// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// public sealed partial class SnapshotStatusRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs index cadffda742f..e6100f9e2f9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Snapshot/VerifyRepositoryRequest.g.cs @@ -49,7 +49,8 @@ public sealed partial class VerifyRepositoryRequestParameters : RequestParameter /// /// -/// Verifies a repository. +/// Verify a snapshot repository. +/// Check for common misconfigurations in a snapshot repository. /// /// public sealed partial class VerifyRepositoryRequest : PlainRequest @@ -85,7 +86,8 @@ public VerifyRepositoryRequest(Elastic.Clients.Elasticsearch.Name name) : base(r /// /// -/// Verifies a repository. +/// Verify a snapshot repository. +/// Check for common misconfigurations in a snapshot repository. /// /// public sealed partial class VerifyRepositoryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs index 85f33535e96..e50ac965692 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/DeleteLifecycleRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class DeleteLifecycleRequestParameters : RequestParameters /// /// -/// Deletes an existing snapshot lifecycle policy. +/// Delete a policy. +/// Delete a snapshot lifecycle policy definition. +/// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// public sealed partial class DeleteLifecycleRequest : PlainRequest @@ -56,7 +58,9 @@ public DeleteLifecycleRequest(Elastic.Clients.Elasticsearch.Name policyId) : bas /// /// -/// Deletes an existing snapshot lifecycle policy. +/// Delete a policy. +/// Delete a snapshot lifecycle policy definition. +/// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// public sealed partial class DeleteLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs index 65674da8cf3..46c763acd3a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteLifecycleRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class ExecuteLifecycleRequestParameters : RequestParameter /// /// -/// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. +/// Run a policy. +/// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. +/// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// public sealed partial class ExecuteLifecycleRequest : PlainRequest @@ -56,7 +58,9 @@ public ExecuteLifecycleRequest(Elastic.Clients.Elasticsearch.Name policyId) : ba /// /// -/// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. +/// Run a policy. +/// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. +/// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// public sealed partial class ExecuteLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs index 94c7e365ad6..14f759460ca 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/ExecuteRetentionRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class ExecuteRetentionRequestParameters : RequestParameter /// /// -/// Deletes any snapshots that are expired according to the policy's retention rules. +/// Run a retention policy. +/// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. +/// The retention policy is normally applied according to its schedule. /// /// public sealed partial class ExecuteRetentionRequest : PlainRequest @@ -52,7 +54,9 @@ public sealed partial class ExecuteRetentionRequest : PlainRequest /// -/// Deletes any snapshots that are expired according to the policy's retention rules. +/// Run a retention policy. +/// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. +/// The retention policy is normally applied according to its schedule. /// /// public sealed partial class ExecuteRetentionRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs index 065d37b1eea..e647bd33bb8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetLifecycleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetLifecycleRequestParameters : RequestParameters /// /// -/// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. +/// Get policy information. +/// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// public sealed partial class GetLifecycleRequest : PlainRequest @@ -60,7 +61,8 @@ public GetLifecycleRequest(Elastic.Clients.Elasticsearch.Names? policyId) : base /// /// -/// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. +/// Get policy information. +/// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// public sealed partial class GetLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs index 5086212cfc6..3b0fc096ab6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetSlmStatusRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class GetSlmStatusRequestParameters : RequestParameters /// /// -/// Retrieves the status of snapshot lifecycle management (SLM). +/// Get the snapshot lifecycle management status. /// /// public sealed partial class GetSlmStatusRequest : PlainRequest @@ -52,7 +52,7 @@ public sealed partial class GetSlmStatusRequest : PlainRequest /// -/// Retrieves the status of snapshot lifecycle management (SLM). +/// Get the snapshot lifecycle management status. /// /// public sealed partial class GetSlmStatusRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs index 60f73a9cac8..183295795da 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/GetStatsRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetStatsRequestParameters : RequestParameters /// /// -/// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. +/// Get snapshot lifecycle management statistics. +/// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// public sealed partial class GetStatsRequest : PlainRequest @@ -52,7 +53,8 @@ public sealed partial class GetStatsRequest : PlainRequest /// -/// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. +/// Get snapshot lifecycle management statistics. +/// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// public sealed partial class GetStatsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs index ea93dcafd88..865a2baf563 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/PutLifecycleRequest.g.cs @@ -49,7 +49,10 @@ public sealed partial class PutLifecycleRequestParameters : RequestParameters /// /// -/// Creates or updates a snapshot lifecycle policy. +/// Create or update a policy. +/// Create or update a snapshot lifecycle policy. +/// If the policy already exists, this request increments the policy version. +/// Only the latest version of a policy is stored. /// /// public sealed partial class PutLifecycleRequest : PlainRequest @@ -125,7 +128,10 @@ public PutLifecycleRequest(Elastic.Clients.Elasticsearch.Name policyId) : base(r /// /// -/// Creates or updates a snapshot lifecycle policy. +/// Create or update a policy. +/// Create or update a snapshot lifecycle policy. +/// If the policy already exists, this request increments the policy version. +/// Only the latest version of a policy is stored. /// /// public sealed partial class PutLifecycleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs index 4cde81967c5..f45719cc0a0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StartSlmRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class StartSlmRequestParameters : RequestParameters /// /// -/// Turns on snapshot lifecycle management (SLM). +/// Start snapshot lifecycle management. +/// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. +/// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// public sealed partial class StartSlmRequest : PlainRequest @@ -52,7 +54,9 @@ public sealed partial class StartSlmRequest : PlainRequest /// -/// Turns on snapshot lifecycle management (SLM). +/// Start snapshot lifecycle management. +/// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. +/// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// public sealed partial class StartSlmRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs index 8fb9b82af9b..4f8e240975d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/SnapshotLifecycleManagement/StopSlmRequest.g.cs @@ -36,7 +36,15 @@ public sealed partial class StopSlmRequestParameters : RequestParameters /// /// -/// Turns off snapshot lifecycle management (SLM). +/// Stop snapshot lifecycle management. +/// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. +/// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. +/// Stopping SLM does not stop any snapshots that are in progress. +/// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. +/// +/// +/// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. +/// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// public sealed partial class StopSlmRequest : PlainRequest @@ -52,7 +60,15 @@ public sealed partial class StopSlmRequest : PlainRequest /// -/// Turns off snapshot lifecycle management (SLM). +/// Stop snapshot lifecycle management. +/// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. +/// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. +/// Stopping SLM does not stop any snapshots that are in progress. +/// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. +/// +/// +/// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. +/// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// public sealed partial class StopSlmRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/ClearCursorRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/ClearCursorRequest.g.cs index e7642520024..3f9c11570d2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/ClearCursorRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/ClearCursorRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class ClearCursorRequestParameters : RequestParameters /// /// -/// Clears the SQL cursor +/// Clear an SQL search cursor. /// /// public sealed partial class ClearCursorRequest : PlainRequest @@ -60,7 +60,7 @@ public sealed partial class ClearCursorRequest : PlainRequest /// -/// Clears the SQL cursor +/// Clear an SQL search cursor. /// /// public sealed partial class ClearCursorRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/DeleteAsyncRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/DeleteAsyncRequest.g.cs index f10354d82f4..d306d8916d2 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/DeleteAsyncRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/DeleteAsyncRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class DeleteAsyncRequestParameters : RequestParameters /// /// -/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// Delete an async SQL search. +/// Delete an async SQL search or a stored synchronous SQL search. +/// If the search is still running, the API cancels it. /// /// public sealed partial class DeleteAsyncRequest : PlainRequest @@ -56,7 +58,9 @@ public DeleteAsyncRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Req /// /// -/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// Delete an async SQL search. +/// Delete an async SQL search or a stored synchronous SQL search. +/// If the search is still running, the API cancels it. /// /// public sealed partial class DeleteAsyncRequestDescriptor : RequestDescriptor, DeleteAsyncRequestParameters> @@ -88,7 +92,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. +/// Delete an async SQL search. +/// Delete an async SQL search or a stored synchronous SQL search. +/// If the search is still running, the API cancels it. /// /// public sealed partial class DeleteAsyncRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncRequest.g.cs index 75b724ab11d..a725dcd4bd3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncRequest.g.cs @@ -66,7 +66,8 @@ public sealed partial class GetAsyncRequestParameters : RequestParameters /// /// -/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// Get async SQL search results. +/// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// public sealed partial class GetAsyncRequest : PlainRequest @@ -121,7 +122,8 @@ public GetAsyncRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requir /// /// -/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// Get async SQL search results. +/// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// public sealed partial class GetAsyncRequestDescriptor : RequestDescriptor, GetAsyncRequestParameters> @@ -158,7 +160,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns the current status and available results for an async SQL search or stored synchronous SQL search +/// Get async SQL search results. +/// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// public sealed partial class GetAsyncRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs index 002f87c77ac..cd754c0e812 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/GetAsyncStatusRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetAsyncStatusRequestParameters : RequestParameters /// /// -/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// Get the async SQL search status. +/// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// public sealed partial class GetAsyncStatusRequest : PlainRequest @@ -56,7 +57,8 @@ public GetAsyncStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r. /// /// -/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// Get the async SQL search status. +/// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// public sealed partial class GetAsyncStatusRequestDescriptor : RequestDescriptor, GetAsyncStatusRequestParameters> @@ -88,7 +90,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Returns the current status of an async SQL search or a stored synchronous SQL search +/// Get the async SQL search status. +/// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// public sealed partial class GetAsyncStatusRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/QueryRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/QueryRequest.g.cs index 34519a8f721..a45bfdcc1cd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/QueryRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/QueryRequest.g.cs @@ -42,7 +42,8 @@ public sealed partial class QueryRequestParameters : RequestParameters /// /// -/// Executes a SQL request +/// Get SQL search results. +/// Run an SQL request. /// /// public sealed partial class QueryRequest : PlainRequest @@ -197,7 +198,8 @@ public sealed partial class QueryRequest : PlainRequest /// /// -/// Executes a SQL request +/// Get SQL search results. +/// Run an SQL request. /// /// public sealed partial class QueryRequestDescriptor : RequestDescriptor, QueryRequestParameters> @@ -549,7 +551,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Executes a SQL request +/// Get SQL search results. +/// Run an SQL request. /// /// public sealed partial class QueryRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/TranslateRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/TranslateRequest.g.cs index 7b29b6516d1..33dd98cbf08 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/TranslateRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Sql/TranslateRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class TranslateRequestParameters : RequestParameters /// /// -/// Translates SQL into Elasticsearch queries +/// Translate SQL into Elasticsearch queries. +/// Translate an SQL search into a search API request containing Query DSL. /// /// public sealed partial class TranslateRequest : PlainRequest @@ -84,7 +85,8 @@ public sealed partial class TranslateRequest : PlainRequest /// -/// Translates SQL into Elasticsearch queries +/// Translate SQL into Elasticsearch queries. +/// Translate an SQL search into a search API request containing Query DSL. /// /// public sealed partial class TranslateRequestDescriptor : RequestDescriptor, TranslateRequestParameters> @@ -211,7 +213,8 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Translates SQL into Elasticsearch queries +/// Translate SQL into Elasticsearch queries. +/// Translate an SQL search into a search API request containing Query DSL. /// /// public sealed partial class TranslateRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs index 2ff242aa234..8468d27085d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRequest.g.cs @@ -36,7 +36,7 @@ public sealed partial class DeleteSynonymRequestParameters : RequestParameters /// /// -/// Deletes a synonym set +/// Delete a synonym set. /// /// public sealed partial class DeleteSynonymRequest : PlainRequest @@ -56,7 +56,7 @@ public DeleteSynonymRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.R /// /// -/// Deletes a synonym set +/// Delete a synonym set. /// /// public sealed partial class DeleteSynonymRequestDescriptor : RequestDescriptor, DeleteSynonymRequestParameters> @@ -88,7 +88,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Deletes a synonym set +/// Delete a synonym set. /// /// public sealed partial class DeleteSynonymRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs index fceca4690d8..9bc1264b7ef 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/DeleteSynonymRuleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class DeleteSynonymRuleRequestParameters : RequestParamete /// /// -/// Deletes a synonym rule in a synonym set +/// Delete a synonym rule. +/// Delete a synonym rule from a synonym set. /// /// public sealed partial class DeleteSynonymRuleRequest : PlainRequest @@ -56,7 +57,8 @@ public DeleteSynonymRuleRequest(Elastic.Clients.Elasticsearch.Id setId, Elastic. /// /// -/// Deletes a synonym rule in a synonym set +/// Delete a synonym rule. +/// Delete a synonym rule from a synonym set. /// /// public sealed partial class DeleteSynonymRuleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRequest.g.cs index 5422954551b..4a03450e469 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRequest.g.cs @@ -49,7 +49,7 @@ public sealed partial class GetSynonymRequestParameters : RequestParameters /// /// -/// Retrieves a synonym set +/// Get a synonym set. /// /// public sealed partial class GetSynonymRequest : PlainRequest @@ -85,7 +85,7 @@ public GetSynonymRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requ /// /// -/// Retrieves a synonym set +/// Get a synonym set. /// /// public sealed partial class GetSynonymRequestDescriptor : RequestDescriptor, GetSynonymRequestParameters> @@ -120,7 +120,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Retrieves a synonym set +/// Get a synonym set. /// /// public sealed partial class GetSynonymRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs index aae76d746b6..55894c24e13 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymRuleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class GetSynonymRuleRequestParameters : RequestParameters /// /// -/// Retrieves a synonym rule from a synonym set +/// Get a synonym rule. +/// Get a synonym rule from a synonym set. /// /// public sealed partial class GetSynonymRuleRequest : PlainRequest @@ -56,7 +57,8 @@ public GetSynonymRuleRequest(Elastic.Clients.Elasticsearch.Id setId, Elastic.Cli /// /// -/// Retrieves a synonym rule from a synonym set +/// Get a synonym rule. +/// Get a synonym rule from a synonym set. /// /// public sealed partial class GetSynonymRuleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs index 806b9170341..ff263268dcd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/GetSynonymsSetsRequest.g.cs @@ -49,7 +49,8 @@ public sealed partial class GetSynonymsSetsRequestParameters : RequestParameters /// /// -/// Retrieves a summary of all defined synonym sets +/// Get all synonym sets. +/// Get a summary of all defined synonym sets. /// /// public sealed partial class GetSynonymsSetsRequest : PlainRequest @@ -81,7 +82,8 @@ public sealed partial class GetSynonymsSetsRequest : PlainRequest /// -/// Retrieves a summary of all defined synonym sets +/// Get all synonym sets. +/// Get a summary of all defined synonym sets. /// /// public sealed partial class GetSynonymsSetsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRequest.g.cs index e451898972e..ebde087aa42 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRequest.g.cs @@ -36,7 +36,9 @@ public sealed partial class PutSynonymRequestParameters : RequestParameters /// /// -/// Creates or updates a synonym set. +/// Create or update a synonym set. +/// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. +/// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// public sealed partial class PutSynonymRequest : PlainRequest @@ -65,7 +67,9 @@ public PutSynonymRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Requ /// /// -/// Creates or updates a synonym set. +/// Create or update a synonym set. +/// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. +/// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// public sealed partial class PutSynonymRequestDescriptor : RequestDescriptor, PutSynonymRequestParameters> @@ -174,7 +178,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o /// /// -/// Creates or updates a synonym set. +/// Create or update a synonym set. +/// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. +/// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// public sealed partial class PutSynonymRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs index 6a85a994be1..30b670af3d5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Synonyms/PutSynonymRuleRequest.g.cs @@ -36,7 +36,8 @@ public sealed partial class PutSynonymRuleRequestParameters : RequestParameters /// /// -/// Creates or updates a synonym rule in a synonym set +/// Create or update a synonym rule. +/// Create or update a synonym rule in a synonym set. /// /// public sealed partial class PutSynonymRuleRequest : PlainRequest @@ -59,7 +60,8 @@ public PutSynonymRuleRequest(Elastic.Clients.Elasticsearch.Id setId, Elastic.Cli /// /// -/// Creates or updates a synonym rule in a synonym set +/// Create or update a synonym rule. +/// Create or update a synonym rule in a synonym set. /// /// public sealed partial class PutSynonymRuleRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/CancelRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/CancelRequest.g.cs index afad51cb35b..ecf9f2c38c1 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/CancelRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/CancelRequest.g.cs @@ -63,7 +63,15 @@ public sealed partial class CancelRequestParameters : RequestParameters /// /// -/// Cancels a task, if it can be cancelled through an API. +/// Cancel a task. +/// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. +/// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. +/// The get task information API will continue to list these cancelled tasks until they complete. +/// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. +/// +/// +/// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. +/// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. /// /// public sealed partial class CancelRequest : PlainRequest @@ -119,7 +127,15 @@ public CancelRequest(Elastic.Clients.Elasticsearch.TaskId? taskId) : base(r => r /// /// -/// Cancels a task, if it can be cancelled through an API. +/// Cancel a task. +/// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. +/// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. +/// The get task information API will continue to list these cancelled tasks until they complete. +/// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. +/// +/// +/// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. +/// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. /// /// public sealed partial class CancelRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/GetTasksRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/GetTasksRequest.g.cs index 1ef20cc4469..543a2fadcd0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/GetTasksRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/GetTasksRequest.g.cs @@ -51,7 +51,7 @@ public sealed partial class GetTasksRequestParameters : RequestParameters /// /// /// Get task information. -/// Returns information about the tasks currently executing in the cluster. +/// Get information about a task currently running in the cluster. /// /// public sealed partial class GetTasksRequest : PlainRequest @@ -89,7 +89,7 @@ public GetTasksRequest(Elastic.Clients.Elasticsearch.Id taskId) : base(r => r.Re /// /// /// Get task information. -/// Returns information about the tasks currently executing in the cluster. +/// Get information about a task currently running in the cluster. /// /// public sealed partial class GetTasksRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListRequest.g.cs index 228be9745b7..f20af93fc1b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Tasks/ListRequest.g.cs @@ -42,6 +42,7 @@ public sealed partial class ListRequestParameters : RequestParameters /// /// /// If true, the response includes detailed information about shard recoveries. + /// This information is useful to distinguish tasks from each other but is more costly to run. /// /// public bool? Detailed { get => Q("detailed"); set => Q("detailed", value); } @@ -65,7 +66,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); } /// /// @@ -91,7 +92,8 @@ public sealed partial class ListRequestParameters : RequestParameters /// /// -/// The task management API returns information about tasks currently executing on one or more nodes in the cluster. +/// Get all tasks. +/// Get information about the tasks currently running on one or more nodes in the cluster. /// /// public sealed partial class ListRequest : PlainRequest @@ -115,6 +117,7 @@ public sealed partial class ListRequest : PlainRequest /// /// /// If true, the response includes detailed information about shard recoveries. + /// This information is useful to distinguish tasks from each other but is more costly to run. /// /// [JsonIgnore] @@ -142,7 +145,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); } /// /// @@ -171,7 +174,8 @@ public sealed partial class ListRequest : PlainRequest /// /// -/// The task management API returns information about tasks currently executing on one or more nodes in the cluster. +/// Get all tasks. +/// Get information about the tasks currently running on one or more nodes in the cluster. /// /// public sealed partial class ListRequestDescriptor : RequestDescriptor @@ -194,7 +198,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 74cf80a255d..f9052ff3303 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 75a2b05b403..60b90b70370 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/TextStructure/FindFieldStructureRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/FindFieldStructureRequest.g.cs new file mode 100644 index 00000000000..0e810f8dd67 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/FindFieldStructureRequest.g.cs @@ -0,0 +1,643 @@ +// 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.TextStructure; + +public sealed partial class FindFieldStructureRequestParameters : RequestParameters +{ + /// + /// + /// If format is set to delimited, you can specify the column names in a comma-separated list. + /// If this parameter is not specified, the structure finder uses the column names from the header row of the text. + /// If the text does not have a header row, columns are named "column1", "column2", "column3", for example. + /// + /// + public string? ColumnNames { get => Q("column_names"); set => Q("column_names", value); } + + /// + /// + /// If you have set format to delimited, you can specify the character used to delimit the values in each row. + /// Only a single character is supported; the delimiter cannot have multiple characters. + /// By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (|). + /// In this default scenario, all rows must have the same number of fields for the delimited format to be detected. + /// If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. + /// + /// + public string? Delimiter { get => Q("delimiter"); set => Q("delimiter", value); } + + /// + /// + /// The number of documents to include in the structural analysis. + /// The minimum value is 2. + /// + /// + public int? DocumentsToSample { get => Q("documents_to_sample"); set => Q("documents_to_sample", value); } + + /// + /// + /// The mode of compatibility with ECS compliant Grok patterns. + /// Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. + /// This setting primarily has an impact when a whole message Grok pattern such as %{CATALINALOG} matches the input. + /// If the structure finder identifies a common structure but has no idea of the meaning then generic field names such as path, ipaddress, field1, and field2 are used in the grok_pattern output. + /// The intention in that situation is that a user who knows the meanings will rename the fields before using them. + /// + /// + public Elastic.Clients.Elasticsearch.TextStructure.EcsCompatibilityType? EcsCompatibility { get => Q("ecs_compatibility"); set => Q("ecs_compatibility", value); } + + /// + /// + /// If true, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result. + /// + /// + public bool? Explain { get => Q("explain"); set => Q("explain", value); } + + /// + /// + /// The field that should be analyzed. + /// + /// + public Elastic.Clients.Elasticsearch.Field Field { get => Q("field"); set => Q("field", value); } + + /// + /// + /// The high level structure of the text. + /// By default, the API chooses the format. + /// In this default scenario, all rows must have the same number of fields for a delimited format to be detected. + /// If the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. + /// + /// + public Elastic.Clients.Elasticsearch.TextStructure.FormatType? Format { get => Q("format"); set => Q("format", value); } + + /// + /// + /// If the format is semi_structured_text, you can specify a Grok pattern that is used to extract fields from every message in the text. + /// The name of the timestamp field in the Grok pattern must match what is specified in the timestamp_field parameter. + /// If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". + /// If grok_pattern is not specified, the structure finder creates a Grok pattern. + /// + /// + public string? GrokPattern { get => Q("grok_pattern"); set => Q("grok_pattern", value); } + + /// + /// + /// The name of the index that contains the analyzed field. + /// + /// + public Elastic.Clients.Elasticsearch.IndexName Index { get => Q("index"); set => Q("index", value); } + + /// + /// + /// If the format is delimited, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. + /// Only a single character is supported. + /// If this parameter is not specified, the default value is a double quote ("). + /// If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. + /// + /// + public string? Quote { get => Q("quote"); set => Q("quote", value); } + + /// + /// + /// If the format is delimited, you can specify whether values between delimiters should have whitespace trimmed from them. + /// If this parameter is not specified and the delimiter is pipe (|), the default value is true. + /// Otherwise, the default value is false. + /// + /// + public bool? ShouldTrimFields { get => Q("should_trim_fields"); set => Q("should_trim_fields", value); } + + /// + /// + /// The maximum amount of time that the structure analysis can take. + /// If the analysis is still running when the timeout expires, it will be stopped. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + + /// + /// + /// The name of the field that contains the primary timestamp of each record in the text. + /// In particular, if the text was ingested into an index, this is the field that would be used to populate the @timestamp field. + /// + /// + /// If the format is semi_structured_text, this field must match the name of the appropriate extraction in the grok_pattern. + /// Therefore, for semi-structured text, it is best not to specify this parameter unless grok_pattern is also specified. + /// + /// + /// For structured text, if you specify this parameter, the field must exist within the text. + /// + /// + /// If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. + /// For structured text, it is not compulsory to have a timestamp in the text. + /// + /// + public Elastic.Clients.Elasticsearch.Field? TimestampField { get => Q("timestamp_field"); set => Q("timestamp_field", value); } + + /// + /// + /// The Java time format of the timestamp field in the text. + /// Only a subset of Java time format letter groups are supported: + /// + /// + /// + /// + /// a + /// + /// + /// + /// + /// d + /// + /// + /// + /// + /// dd + /// + /// + /// + /// + /// EEE + /// + /// + /// + /// + /// EEEE + /// + /// + /// + /// + /// H + /// + /// + /// + /// + /// HH + /// + /// + /// + /// + /// h + /// + /// + /// + /// + /// M + /// + /// + /// + /// + /// MM + /// + /// + /// + /// + /// MMM + /// + /// + /// + /// + /// MMMM + /// + /// + /// + /// + /// mm + /// + /// + /// + /// + /// ss + /// + /// + /// + /// + /// XX + /// + /// + /// + /// + /// XXX + /// + /// + /// + /// + /// yy + /// + /// + /// + /// + /// yyyy + /// + /// + /// + /// + /// zzz + /// + /// + /// + /// + /// Additionally S letter groups (fractional seconds) of length one to nine are supported providing they occur after ss and are separated from the ss by a period (.), comma (,), or colon (:). + /// Spacing and punctuation is also permitted with the exception a question mark (?), newline, and carriage return, together with literal text enclosed in single quotes. + /// For example, MM/dd HH.mm.ss,SSSSSS 'in' yyyy is a valid override format. + /// + /// + /// One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full grok_pattern. + /// Another is when the timestamp format is one that the structure finder does not consider by default. + /// + /// + /// If this parameter is not specified, the structure finder chooses the best format from a built-in set. + /// + /// + /// If the special value null is specified, the structure finder will not look for a primary timestamp in the text. + /// When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. + /// + /// + public string? TimestampFormat { get => Q("timestamp_format"); set => Q("timestamp_format", value); } +} + +/// +/// +/// Find the structure of a text field. +/// Find the structure of a text field in an Elasticsearch index. +/// +/// +public sealed partial class FindFieldStructureRequest : PlainRequest +{ + internal override ApiUrls ApiUrls => ApiUrlLookup.TextStructureFindFieldStructure; + + protected override HttpMethod StaticHttpMethod => HttpMethod.GET; + + internal override bool SupportsBody => false; + + internal override string OperationName => "text_structure.find_field_structure"; + + /// + /// + /// If format is set to delimited, you can specify the column names in a comma-separated list. + /// If this parameter is not specified, the structure finder uses the column names from the header row of the text. + /// If the text does not have a header row, columns are named "column1", "column2", "column3", for example. + /// + /// + [JsonIgnore] + public string? ColumnNames { get => Q("column_names"); set => Q("column_names", value); } + + /// + /// + /// If you have set format to delimited, you can specify the character used to delimit the values in each row. + /// Only a single character is supported; the delimiter cannot have multiple characters. + /// By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (|). + /// In this default scenario, all rows must have the same number of fields for the delimited format to be detected. + /// If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. + /// + /// + [JsonIgnore] + public string? Delimiter { get => Q("delimiter"); set => Q("delimiter", value); } + + /// + /// + /// The number of documents to include in the structural analysis. + /// The minimum value is 2. + /// + /// + [JsonIgnore] + public int? DocumentsToSample { get => Q("documents_to_sample"); set => Q("documents_to_sample", value); } + + /// + /// + /// The mode of compatibility with ECS compliant Grok patterns. + /// Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. + /// This setting primarily has an impact when a whole message Grok pattern such as %{CATALINALOG} matches the input. + /// If the structure finder identifies a common structure but has no idea of the meaning then generic field names such as path, ipaddress, field1, and field2 are used in the grok_pattern output. + /// The intention in that situation is that a user who knows the meanings will rename the fields before using them. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.TextStructure.EcsCompatibilityType? EcsCompatibility { get => Q("ecs_compatibility"); set => Q("ecs_compatibility", value); } + + /// + /// + /// If true, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result. + /// + /// + [JsonIgnore] + public bool? Explain { get => Q("explain"); set => Q("explain", value); } + + /// + /// + /// The field that should be analyzed. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Field Field { get => Q("field"); set => Q("field", value); } + + /// + /// + /// The high level structure of the text. + /// By default, the API chooses the format. + /// In this default scenario, all rows must have the same number of fields for a delimited format to be detected. + /// If the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.TextStructure.FormatType? Format { get => Q("format"); set => Q("format", value); } + + /// + /// + /// If the format is semi_structured_text, you can specify a Grok pattern that is used to extract fields from every message in the text. + /// The name of the timestamp field in the Grok pattern must match what is specified in the timestamp_field parameter. + /// If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". + /// If grok_pattern is not specified, the structure finder creates a Grok pattern. + /// + /// + [JsonIgnore] + public string? GrokPattern { get => Q("grok_pattern"); set => Q("grok_pattern", value); } + + /// + /// + /// The name of the index that contains the analyzed field. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.IndexName Index { get => Q("index"); set => Q("index", value); } + + /// + /// + /// If the format is delimited, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. + /// Only a single character is supported. + /// If this parameter is not specified, the default value is a double quote ("). + /// If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. + /// + /// + [JsonIgnore] + public string? Quote { get => Q("quote"); set => Q("quote", value); } + + /// + /// + /// If the format is delimited, you can specify whether values between delimiters should have whitespace trimmed from them. + /// If this parameter is not specified and the delimiter is pipe (|), the default value is true. + /// Otherwise, the default value is false. + /// + /// + [JsonIgnore] + public bool? ShouldTrimFields { get => Q("should_trim_fields"); set => Q("should_trim_fields", value); } + + /// + /// + /// The maximum amount of time that the structure analysis can take. + /// If the analysis is still running when the timeout expires, it will be stopped. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + + /// + /// + /// The name of the field that contains the primary timestamp of each record in the text. + /// In particular, if the text was ingested into an index, this is the field that would be used to populate the @timestamp field. + /// + /// + /// If the format is semi_structured_text, this field must match the name of the appropriate extraction in the grok_pattern. + /// Therefore, for semi-structured text, it is best not to specify this parameter unless grok_pattern is also specified. + /// + /// + /// For structured text, if you specify this parameter, the field must exist within the text. + /// + /// + /// If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. + /// For structured text, it is not compulsory to have a timestamp in the text. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Field? TimestampField { get => Q("timestamp_field"); set => Q("timestamp_field", value); } + + /// + /// + /// The Java time format of the timestamp field in the text. + /// Only a subset of Java time format letter groups are supported: + /// + /// + /// + /// + /// a + /// + /// + /// + /// + /// d + /// + /// + /// + /// + /// dd + /// + /// + /// + /// + /// EEE + /// + /// + /// + /// + /// EEEE + /// + /// + /// + /// + /// H + /// + /// + /// + /// + /// HH + /// + /// + /// + /// + /// h + /// + /// + /// + /// + /// M + /// + /// + /// + /// + /// MM + /// + /// + /// + /// + /// MMM + /// + /// + /// + /// + /// MMMM + /// + /// + /// + /// + /// mm + /// + /// + /// + /// + /// ss + /// + /// + /// + /// + /// XX + /// + /// + /// + /// + /// XXX + /// + /// + /// + /// + /// yy + /// + /// + /// + /// + /// yyyy + /// + /// + /// + /// + /// zzz + /// + /// + /// + /// + /// Additionally S letter groups (fractional seconds) of length one to nine are supported providing they occur after ss and are separated from the ss by a period (.), comma (,), or colon (:). + /// Spacing and punctuation is also permitted with the exception a question mark (?), newline, and carriage return, together with literal text enclosed in single quotes. + /// For example, MM/dd HH.mm.ss,SSSSSS 'in' yyyy is a valid override format. + /// + /// + /// One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full grok_pattern. + /// Another is when the timestamp format is one that the structure finder does not consider by default. + /// + /// + /// If this parameter is not specified, the structure finder chooses the best format from a built-in set. + /// + /// + /// If the special value null is specified, the structure finder will not look for a primary timestamp in the text. + /// When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. + /// + /// + [JsonIgnore] + public string? TimestampFormat { get => Q("timestamp_format"); set => Q("timestamp_format", value); } +} + +/// +/// +/// Find the structure of a text field. +/// Find the structure of a text field in an Elasticsearch index. +/// +/// +public sealed partial class FindFieldStructureRequestDescriptor : RequestDescriptor, FindFieldStructureRequestParameters> +{ + internal FindFieldStructureRequestDescriptor(Action> configure) => configure.Invoke(this); + + public FindFieldStructureRequestDescriptor() + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.TextStructureFindFieldStructure; + + protected override HttpMethod StaticHttpMethod => HttpMethod.GET; + + internal override bool SupportsBody => false; + + internal override string OperationName => "text_structure.find_field_structure"; + + public FindFieldStructureRequestDescriptor ColumnNames(string? columnNames) => Qs("column_names", columnNames); + public FindFieldStructureRequestDescriptor Delimiter(string? delimiter) => Qs("delimiter", delimiter); + public FindFieldStructureRequestDescriptor DocumentsToSample(int? documentsToSample) => Qs("documents_to_sample", documentsToSample); + public FindFieldStructureRequestDescriptor EcsCompatibility(Elastic.Clients.Elasticsearch.TextStructure.EcsCompatibilityType? ecsCompatibility) => Qs("ecs_compatibility", ecsCompatibility); + public FindFieldStructureRequestDescriptor Explain(bool? explain = true) => Qs("explain", explain); + public FindFieldStructureRequestDescriptor Field(Elastic.Clients.Elasticsearch.Field field) => Qs("field", field); + public FindFieldStructureRequestDescriptor Format(Elastic.Clients.Elasticsearch.TextStructure.FormatType? format) => Qs("format", format); + public FindFieldStructureRequestDescriptor GrokPattern(string? grokPattern) => Qs("grok_pattern", grokPattern); + public FindFieldStructureRequestDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) => Qs("index", index); + public FindFieldStructureRequestDescriptor Quote(string? quote) => Qs("quote", quote); + public FindFieldStructureRequestDescriptor ShouldTrimFields(bool? shouldTrimFields = true) => Qs("should_trim_fields", shouldTrimFields); + public FindFieldStructureRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) => Qs("timeout", timeout); + public FindFieldStructureRequestDescriptor TimestampField(Elastic.Clients.Elasticsearch.Field? timestampField) => Qs("timestamp_field", timestampField); + public FindFieldStructureRequestDescriptor TimestampFormat(string? timestampFormat) => Qs("timestamp_format", timestampFormat); + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + } +} + +/// +/// +/// Find the structure of a text field. +/// Find the structure of a text field in an Elasticsearch index. +/// +/// +public sealed partial class FindFieldStructureRequestDescriptor : RequestDescriptor +{ + internal FindFieldStructureRequestDescriptor(Action configure) => configure.Invoke(this); + + public FindFieldStructureRequestDescriptor() + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.TextStructureFindFieldStructure; + + protected override HttpMethod StaticHttpMethod => HttpMethod.GET; + + internal override bool SupportsBody => false; + + internal override string OperationName => "text_structure.find_field_structure"; + + public FindFieldStructureRequestDescriptor ColumnNames(string? columnNames) => Qs("column_names", columnNames); + public FindFieldStructureRequestDescriptor Delimiter(string? delimiter) => Qs("delimiter", delimiter); + public FindFieldStructureRequestDescriptor DocumentsToSample(int? documentsToSample) => Qs("documents_to_sample", documentsToSample); + public FindFieldStructureRequestDescriptor EcsCompatibility(Elastic.Clients.Elasticsearch.TextStructure.EcsCompatibilityType? ecsCompatibility) => Qs("ecs_compatibility", ecsCompatibility); + public FindFieldStructureRequestDescriptor Explain(bool? explain = true) => Qs("explain", explain); + public FindFieldStructureRequestDescriptor Field(Elastic.Clients.Elasticsearch.Field field) => Qs("field", field); + public FindFieldStructureRequestDescriptor Format(Elastic.Clients.Elasticsearch.TextStructure.FormatType? format) => Qs("format", format); + public FindFieldStructureRequestDescriptor GrokPattern(string? grokPattern) => Qs("grok_pattern", grokPattern); + public FindFieldStructureRequestDescriptor Index(Elastic.Clients.Elasticsearch.IndexName index) => Qs("index", index); + public FindFieldStructureRequestDescriptor Quote(string? quote) => Qs("quote", quote); + public FindFieldStructureRequestDescriptor ShouldTrimFields(bool? shouldTrimFields = true) => Qs("should_trim_fields", shouldTrimFields); + public FindFieldStructureRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) => Qs("timeout", timeout); + public FindFieldStructureRequestDescriptor TimestampField(Elastic.Clients.Elasticsearch.Field? timestampField) => Qs("timestamp_field", timestampField); + public FindFieldStructureRequestDescriptor TimestampFormat(string? timestampFormat) => Qs("timestamp_format", timestampFormat); + + 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/TextStructure/FindFieldStructureResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/FindFieldStructureResponse.g.cs new file mode 100644 index 00000000000..432ca254f96 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/FindFieldStructureResponse.g.cs @@ -0,0 +1,62 @@ +// 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.TextStructure; + +public sealed partial class FindFieldStructureResponse : ElasticsearchResponse +{ + [JsonInclude, JsonPropertyName("charset")] + public string Charset { get; init; } + [JsonInclude, JsonPropertyName("ecs_compatibility")] + public Elastic.Clients.Elasticsearch.TextStructure.EcsCompatibilityType? EcsCompatibility { get; init; } + [JsonInclude, JsonPropertyName("field_stats")] + [ReadOnlyFieldDictionaryConverter(typeof(Elastic.Clients.Elasticsearch.TextStructure.FieldStat))] + public IReadOnlyDictionary FieldStats { get; init; } + [JsonInclude, JsonPropertyName("format")] + public Elastic.Clients.Elasticsearch.TextStructure.FormatType Format { get; init; } + [JsonInclude, JsonPropertyName("grok_pattern")] + public string? GrokPattern { get; init; } + [JsonInclude, JsonPropertyName("ingest_pipeline")] + public Elastic.Clients.Elasticsearch.Ingest.PipelineConfig IngestPipeline { get; init; } + [JsonInclude, JsonPropertyName("java_timestamp_formats")] + public IReadOnlyCollection? JavaTimestampFormats { get; init; } + [JsonInclude, JsonPropertyName("joda_timestamp_formats")] + public IReadOnlyCollection? JodaTimestampFormats { get; init; } + [JsonInclude, JsonPropertyName("mappings")] + public Elastic.Clients.Elasticsearch.Mapping.TypeMapping Mappings { get; init; } + [JsonInclude, JsonPropertyName("multiline_start_pattern")] + public string? MultilineStartPattern { get; init; } + [JsonInclude, JsonPropertyName("need_client_timezone")] + public bool NeedClientTimezone { get; init; } + [JsonInclude, JsonPropertyName("num_lines_analyzed")] + public int NumLinesAnalyzed { get; init; } + [JsonInclude, JsonPropertyName("num_messages_analyzed")] + public int NumMessagesAnalyzed { get; init; } + [JsonInclude, JsonPropertyName("sample_start")] + public string SampleStart { get; init; } + [JsonInclude, JsonPropertyName("timestamp_field")] + public string? TimestampField { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/FindMessageStructureRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/FindMessageStructureRequest.g.cs new file mode 100644 index 00000000000..b50c0cabef5 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/FindMessageStructureRequest.g.cs @@ -0,0 +1,714 @@ +// 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.TextStructure; + +public sealed partial class FindMessageStructureRequestParameters : RequestParameters +{ + /// + /// + /// If the format is delimited, you can specify the column names in a comma-separated list. + /// If this parameter is not specified, the structure finder uses the column names from the header row of the text. + /// If the text does not have a header role, columns are named "column1", "column2", "column3", for example. + /// + /// + public string? ColumnNames { get => Q("column_names"); set => Q("column_names", value); } + + /// + /// + /// If you the format is delimited, you can specify the character used to delimit the values in each row. + /// Only a single character is supported; the delimiter cannot have multiple characters. + /// By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (|). + /// In this default scenario, all rows must have the same number of fields for the delimited format to be detected. + /// If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. + /// + /// + public string? Delimiter { get => Q("delimiter"); set => Q("delimiter", value); } + + /// + /// + /// The mode of compatibility with ECS compliant Grok patterns. + /// Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. + /// This setting primarily has an impact when a whole message Grok pattern such as %{CATALINALOG} matches the input. + /// If the structure finder identifies a common structure but has no idea of meaning then generic field names such as path, ipaddress, field1, and field2 are used in the grok_pattern output, with the intention that a user who knows the meanings rename these fields before using it. + /// + /// + public Elastic.Clients.Elasticsearch.TextStructure.EcsCompatibilityType? EcsCompatibility { get => Q("ecs_compatibility"); set => Q("ecs_compatibility", value); } + + /// + /// + /// If this parameter is set to true, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result. + /// + /// + public bool? Explain { get => Q("explain"); set => Q("explain", value); } + + /// + /// + /// The high level structure of the text. + /// By default, the API chooses the format. + /// In this default scenario, all rows must have the same number of fields for a delimited format to be detected. + /// If the format is delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. + /// + /// + public Elastic.Clients.Elasticsearch.TextStructure.FormatType? Format { get => Q("format"); set => Q("format", value); } + + /// + /// + /// If the format is semi_structured_text, you can specify a Grok pattern that is used to extract fields from every message in the text. + /// The name of the timestamp field in the Grok pattern must match what is specified in the timestamp_field parameter. + /// If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". + /// If grok_pattern is not specified, the structure finder creates a Grok pattern. + /// + /// + public string? GrokPattern { get => Q("grok_pattern"); set => Q("grok_pattern", value); } + + /// + /// + /// If the format is delimited, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. + /// Only a single character is supported. + /// If this parameter is not specified, the default value is a double quote ("). + /// If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. + /// + /// + public string? Quote { get => Q("quote"); set => Q("quote", value); } + + /// + /// + /// If the format is delimited, you can specify whether values between delimiters should have whitespace trimmed from them. + /// If this parameter is not specified and the delimiter is pipe (|), the default value is true. + /// Otherwise, the default value is false. + /// + /// + public bool? ShouldTrimFields { get => Q("should_trim_fields"); set => Q("should_trim_fields", value); } + + /// + /// + /// The maximum amount of time that the structure analysis can take. + /// If the analysis is still running when the timeout expires, it will be stopped. + /// + /// + public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + + /// + /// + /// The name of the field that contains the primary timestamp of each record in the text. + /// In particular, if the text was ingested into an index, this is the field that would be used to populate the @timestamp field. + /// + /// + /// If the format is semi_structured_text, this field must match the name of the appropriate extraction in the grok_pattern. + /// Therefore, for semi-structured text, it is best not to specify this parameter unless grok_pattern is also specified. + /// + /// + /// For structured text, if you specify this parameter, the field must exist within the text. + /// + /// + /// If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. + /// For structured text, it is not compulsory to have a timestamp in the text. + /// + /// + public Elastic.Clients.Elasticsearch.Field? TimestampField { get => Q("timestamp_field"); set => Q("timestamp_field", value); } + + /// + /// + /// The Java time format of the timestamp field in the text. + /// Only a subset of Java time format letter groups are supported: + /// + /// + /// + /// + /// a + /// + /// + /// + /// + /// d + /// + /// + /// + /// + /// dd + /// + /// + /// + /// + /// EEE + /// + /// + /// + /// + /// EEEE + /// + /// + /// + /// + /// H + /// + /// + /// + /// + /// HH + /// + /// + /// + /// + /// h + /// + /// + /// + /// + /// M + /// + /// + /// + /// + /// MM + /// + /// + /// + /// + /// MMM + /// + /// + /// + /// + /// MMMM + /// + /// + /// + /// + /// mm + /// + /// + /// + /// + /// ss + /// + /// + /// + /// + /// XX + /// + /// + /// + /// + /// XXX + /// + /// + /// + /// + /// yy + /// + /// + /// + /// + /// yyyy + /// + /// + /// + /// + /// zzz + /// + /// + /// + /// + /// Additionally S letter groups (fractional seconds) of length one to nine are supported providing they occur after ss and are separated from the ss by a period (.), comma (,), or colon (:). + /// Spacing and punctuation is also permitted with the exception a question mark (?), newline, and carriage return, together with literal text enclosed in single quotes. + /// For example, MM/dd HH.mm.ss,SSSSSS 'in' yyyy is a valid override format. + /// + /// + /// One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full grok_pattern. + /// Another is when the timestamp format is one that the structure finder does not consider by default. + /// + /// + /// If this parameter is not specified, the structure finder chooses the best format from a built-in set. + /// + /// + /// If the special value null is specified, the structure finder will not look for a primary timestamp in the text. + /// When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. + /// + /// + public string? TimestampFormat { get => Q("timestamp_format"); set => Q("timestamp_format", value); } +} + +/// +/// +/// Find the structure of text messages. +/// Find the structure of a list of text messages. +/// The messages must contain data that is suitable to be ingested into Elasticsearch. +/// +/// +/// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. +/// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. +/// The response from the API contains: +/// +/// +/// +/// +/// Sample messages. +/// +/// +/// +/// +/// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. +/// +/// +/// +/// +/// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. +/// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. +/// +/// +/// +/// +/// All this information can be calculated by the structure finder with no guidance. +/// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. +/// +/// +public sealed partial class FindMessageStructureRequest : PlainRequest +{ + internal override ApiUrls ApiUrls => ApiUrlLookup.TextStructureFindMessageStructure; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => true; + + internal override string OperationName => "text_structure.find_message_structure"; + + /// + /// + /// If the format is delimited, you can specify the column names in a comma-separated list. + /// If this parameter is not specified, the structure finder uses the column names from the header row of the text. + /// If the text does not have a header role, columns are named "column1", "column2", "column3", for example. + /// + /// + [JsonIgnore] + public string? ColumnNames { get => Q("column_names"); set => Q("column_names", value); } + + /// + /// + /// If you the format is delimited, you can specify the character used to delimit the values in each row. + /// Only a single character is supported; the delimiter cannot have multiple characters. + /// By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (|). + /// In this default scenario, all rows must have the same number of fields for the delimited format to be detected. + /// If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. + /// + /// + [JsonIgnore] + public string? Delimiter { get => Q("delimiter"); set => Q("delimiter", value); } + + /// + /// + /// The mode of compatibility with ECS compliant Grok patterns. + /// Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. + /// This setting primarily has an impact when a whole message Grok pattern such as %{CATALINALOG} matches the input. + /// If the structure finder identifies a common structure but has no idea of meaning then generic field names such as path, ipaddress, field1, and field2 are used in the grok_pattern output, with the intention that a user who knows the meanings rename these fields before using it. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.TextStructure.EcsCompatibilityType? EcsCompatibility { get => Q("ecs_compatibility"); set => Q("ecs_compatibility", value); } + + /// + /// + /// If this parameter is set to true, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result. + /// + /// + [JsonIgnore] + public bool? Explain { get => Q("explain"); set => Q("explain", value); } + + /// + /// + /// The high level structure of the text. + /// By default, the API chooses the format. + /// In this default scenario, all rows must have the same number of fields for a delimited format to be detected. + /// If the format is delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.TextStructure.FormatType? Format { get => Q("format"); set => Q("format", value); } + + /// + /// + /// If the format is semi_structured_text, you can specify a Grok pattern that is used to extract fields from every message in the text. + /// The name of the timestamp field in the Grok pattern must match what is specified in the timestamp_field parameter. + /// If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". + /// If grok_pattern is not specified, the structure finder creates a Grok pattern. + /// + /// + [JsonIgnore] + public string? GrokPattern { get => Q("grok_pattern"); set => Q("grok_pattern", value); } + + /// + /// + /// If the format is delimited, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. + /// Only a single character is supported. + /// If this parameter is not specified, the default value is a double quote ("). + /// If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. + /// + /// + [JsonIgnore] + public string? Quote { get => Q("quote"); set => Q("quote", value); } + + /// + /// + /// If the format is delimited, you can specify whether values between delimiters should have whitespace trimmed from them. + /// If this parameter is not specified and the delimiter is pipe (|), the default value is true. + /// Otherwise, the default value is false. + /// + /// + [JsonIgnore] + public bool? ShouldTrimFields { get => Q("should_trim_fields"); set => Q("should_trim_fields", value); } + + /// + /// + /// The maximum amount of time that the structure analysis can take. + /// If the analysis is still running when the timeout expires, it will be stopped. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q("timeout"); set => Q("timeout", value); } + + /// + /// + /// The name of the field that contains the primary timestamp of each record in the text. + /// In particular, if the text was ingested into an index, this is the field that would be used to populate the @timestamp field. + /// + /// + /// If the format is semi_structured_text, this field must match the name of the appropriate extraction in the grok_pattern. + /// Therefore, for semi-structured text, it is best not to specify this parameter unless grok_pattern is also specified. + /// + /// + /// For structured text, if you specify this parameter, the field must exist within the text. + /// + /// + /// If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. + /// For structured text, it is not compulsory to have a timestamp in the text. + /// + /// + [JsonIgnore] + public Elastic.Clients.Elasticsearch.Field? TimestampField { get => Q("timestamp_field"); set => Q("timestamp_field", value); } + + /// + /// + /// The Java time format of the timestamp field in the text. + /// Only a subset of Java time format letter groups are supported: + /// + /// + /// + /// + /// a + /// + /// + /// + /// + /// d + /// + /// + /// + /// + /// dd + /// + /// + /// + /// + /// EEE + /// + /// + /// + /// + /// EEEE + /// + /// + /// + /// + /// H + /// + /// + /// + /// + /// HH + /// + /// + /// + /// + /// h + /// + /// + /// + /// + /// M + /// + /// + /// + /// + /// MM + /// + /// + /// + /// + /// MMM + /// + /// + /// + /// + /// MMMM + /// + /// + /// + /// + /// mm + /// + /// + /// + /// + /// ss + /// + /// + /// + /// + /// XX + /// + /// + /// + /// + /// XXX + /// + /// + /// + /// + /// yy + /// + /// + /// + /// + /// yyyy + /// + /// + /// + /// + /// zzz + /// + /// + /// + /// + /// Additionally S letter groups (fractional seconds) of length one to nine are supported providing they occur after ss and are separated from the ss by a period (.), comma (,), or colon (:). + /// Spacing and punctuation is also permitted with the exception a question mark (?), newline, and carriage return, together with literal text enclosed in single quotes. + /// For example, MM/dd HH.mm.ss,SSSSSS 'in' yyyy is a valid override format. + /// + /// + /// One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full grok_pattern. + /// Another is when the timestamp format is one that the structure finder does not consider by default. + /// + /// + /// If this parameter is not specified, the structure finder chooses the best format from a built-in set. + /// + /// + /// If the special value null is specified, the structure finder will not look for a primary timestamp in the text. + /// When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. + /// + /// + [JsonIgnore] + public string? TimestampFormat { get => Q("timestamp_format"); set => Q("timestamp_format", value); } + + /// + /// + /// The list of messages you want to analyze. + /// + /// + [JsonInclude, JsonPropertyName("messages")] + public ICollection Messages { get; set; } +} + +/// +/// +/// Find the structure of text messages. +/// Find the structure of a list of text messages. +/// The messages must contain data that is suitable to be ingested into Elasticsearch. +/// +/// +/// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. +/// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. +/// The response from the API contains: +/// +/// +/// +/// +/// Sample messages. +/// +/// +/// +/// +/// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. +/// +/// +/// +/// +/// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. +/// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. +/// +/// +/// +/// +/// All this information can be calculated by the structure finder with no guidance. +/// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. +/// +/// +public sealed partial class FindMessageStructureRequestDescriptor : RequestDescriptor, FindMessageStructureRequestParameters> +{ + internal FindMessageStructureRequestDescriptor(Action> configure) => configure.Invoke(this); + + public FindMessageStructureRequestDescriptor() + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.TextStructureFindMessageStructure; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => true; + + internal override string OperationName => "text_structure.find_message_structure"; + + public FindMessageStructureRequestDescriptor ColumnNames(string? columnNames) => Qs("column_names", columnNames); + public FindMessageStructureRequestDescriptor Delimiter(string? delimiter) => Qs("delimiter", delimiter); + public FindMessageStructureRequestDescriptor EcsCompatibility(Elastic.Clients.Elasticsearch.TextStructure.EcsCompatibilityType? ecsCompatibility) => Qs("ecs_compatibility", ecsCompatibility); + public FindMessageStructureRequestDescriptor Explain(bool? explain = true) => Qs("explain", explain); + public FindMessageStructureRequestDescriptor Format(Elastic.Clients.Elasticsearch.TextStructure.FormatType? format) => Qs("format", format); + public FindMessageStructureRequestDescriptor GrokPattern(string? grokPattern) => Qs("grok_pattern", grokPattern); + public FindMessageStructureRequestDescriptor Quote(string? quote) => Qs("quote", quote); + public FindMessageStructureRequestDescriptor ShouldTrimFields(bool? shouldTrimFields = true) => Qs("should_trim_fields", shouldTrimFields); + public FindMessageStructureRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) => Qs("timeout", timeout); + public FindMessageStructureRequestDescriptor TimestampField(Elastic.Clients.Elasticsearch.Field? timestampField) => Qs("timestamp_field", timestampField); + public FindMessageStructureRequestDescriptor TimestampFormat(string? timestampFormat) => Qs("timestamp_format", timestampFormat); + + private ICollection MessagesValue { get; set; } + + /// + /// + /// The list of messages you want to analyze. + /// + /// + public FindMessageStructureRequestDescriptor Messages(ICollection messages) + { + MessagesValue = messages; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("messages"); + JsonSerializer.Serialize(writer, MessagesValue, options); + writer.WriteEndObject(); + } +} + +/// +/// +/// Find the structure of text messages. +/// Find the structure of a list of text messages. +/// The messages must contain data that is suitable to be ingested into Elasticsearch. +/// +/// +/// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. +/// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. +/// The response from the API contains: +/// +/// +/// +/// +/// Sample messages. +/// +/// +/// +/// +/// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. +/// +/// +/// +/// +/// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. +/// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. +/// +/// +/// +/// +/// All this information can be calculated by the structure finder with no guidance. +/// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. +/// +/// +public sealed partial class FindMessageStructureRequestDescriptor : RequestDescriptor +{ + internal FindMessageStructureRequestDescriptor(Action configure) => configure.Invoke(this); + + public FindMessageStructureRequestDescriptor() + { + } + + internal override ApiUrls ApiUrls => ApiUrlLookup.TextStructureFindMessageStructure; + + protected override HttpMethod StaticHttpMethod => HttpMethod.POST; + + internal override bool SupportsBody => true; + + internal override string OperationName => "text_structure.find_message_structure"; + + public FindMessageStructureRequestDescriptor ColumnNames(string? columnNames) => Qs("column_names", columnNames); + public FindMessageStructureRequestDescriptor Delimiter(string? delimiter) => Qs("delimiter", delimiter); + public FindMessageStructureRequestDescriptor EcsCompatibility(Elastic.Clients.Elasticsearch.TextStructure.EcsCompatibilityType? ecsCompatibility) => Qs("ecs_compatibility", ecsCompatibility); + public FindMessageStructureRequestDescriptor Explain(bool? explain = true) => Qs("explain", explain); + public FindMessageStructureRequestDescriptor Format(Elastic.Clients.Elasticsearch.TextStructure.FormatType? format) => Qs("format", format); + public FindMessageStructureRequestDescriptor GrokPattern(string? grokPattern) => Qs("grok_pattern", grokPattern); + public FindMessageStructureRequestDescriptor Quote(string? quote) => Qs("quote", quote); + public FindMessageStructureRequestDescriptor ShouldTrimFields(bool? shouldTrimFields = true) => Qs("should_trim_fields", shouldTrimFields); + public FindMessageStructureRequestDescriptor Timeout(Elastic.Clients.Elasticsearch.Duration? timeout) => Qs("timeout", timeout); + public FindMessageStructureRequestDescriptor TimestampField(Elastic.Clients.Elasticsearch.Field? timestampField) => Qs("timestamp_field", timestampField); + public FindMessageStructureRequestDescriptor TimestampFormat(string? timestampFormat) => Qs("timestamp_format", timestampFormat); + + private ICollection MessagesValue { get; set; } + + /// + /// + /// The list of messages you want to analyze. + /// + /// + public FindMessageStructureRequestDescriptor Messages(ICollection messages) + { + MessagesValue = messages; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("messages"); + JsonSerializer.Serialize(writer, MessagesValue, options); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/FindMessageStructureResponse.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/FindMessageStructureResponse.g.cs new file mode 100644 index 00000000000..922ef596371 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/FindMessageStructureResponse.g.cs @@ -0,0 +1,62 @@ +// 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.TextStructure; + +public sealed partial class FindMessageStructureResponse : ElasticsearchResponse +{ + [JsonInclude, JsonPropertyName("charset")] + public string Charset { get; init; } + [JsonInclude, JsonPropertyName("ecs_compatibility")] + public Elastic.Clients.Elasticsearch.TextStructure.EcsCompatibilityType? EcsCompatibility { get; init; } + [JsonInclude, JsonPropertyName("field_stats")] + [ReadOnlyFieldDictionaryConverter(typeof(Elastic.Clients.Elasticsearch.TextStructure.FieldStat))] + public IReadOnlyDictionary FieldStats { get; init; } + [JsonInclude, JsonPropertyName("format")] + public Elastic.Clients.Elasticsearch.TextStructure.FormatType Format { get; init; } + [JsonInclude, JsonPropertyName("grok_pattern")] + public string? GrokPattern { get; init; } + [JsonInclude, JsonPropertyName("ingest_pipeline")] + public Elastic.Clients.Elasticsearch.Ingest.PipelineConfig IngestPipeline { get; init; } + [JsonInclude, JsonPropertyName("java_timestamp_formats")] + public IReadOnlyCollection? JavaTimestampFormats { get; init; } + [JsonInclude, JsonPropertyName("joda_timestamp_formats")] + public IReadOnlyCollection? JodaTimestampFormats { get; init; } + [JsonInclude, JsonPropertyName("mappings")] + public Elastic.Clients.Elasticsearch.Mapping.TypeMapping Mappings { get; init; } + [JsonInclude, JsonPropertyName("multiline_start_pattern")] + public string? MultilineStartPattern { get; init; } + [JsonInclude, JsonPropertyName("need_client_timezone")] + public bool NeedClientTimezone { get; init; } + [JsonInclude, JsonPropertyName("num_lines_analyzed")] + public int NumLinesAnalyzed { get; init; } + [JsonInclude, JsonPropertyName("num_messages_analyzed")] + public int NumMessagesAnalyzed { get; init; } + [JsonInclude, JsonPropertyName("sample_start")] + public string SampleStart { get; init; } + [JsonInclude, JsonPropertyName("timestamp_field")] + public string? TimestampField { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs index f8e4bcdafdd..247d72941e7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TextStructure/TestGrokPatternRequest.g.cs @@ -42,7 +42,9 @@ public sealed partial class TestGrokPatternRequestParameters : RequestParameters /// /// -/// Tests a Grok pattern on some text. +/// Test a Grok pattern. +/// Test a Grok pattern on one or more lines of text. +/// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// public sealed partial class TestGrokPatternRequest : PlainRequest @@ -82,7 +84,9 @@ public sealed partial class TestGrokPatternRequest : PlainRequest /// -/// Tests a Grok pattern on some text. +/// Test a Grok pattern. +/// Test a Grok pattern on one or more lines of text. +/// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// public sealed partial class TestGrokPatternRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs index a562b550fb2..50bfb0a2008 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/TransformManagement/UpgradeTransformsRequest.g.cs @@ -50,12 +50,22 @@ public sealed partial class UpgradeTransformsRequestParameters : RequestParamete /// /// -/// Upgrades all transforms. -/// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It -/// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not -/// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when -/// Elasticsearch security features are enabled; the role used to read source data and write to the destination index -/// remains unchanged. +/// Upgrade all transforms. +/// Transforms are compatible across minor versions and between supported major versions. +/// However, over time, the format of transform configuration information may change. +/// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. +/// It also cleans up the internal data structures that store the transform state and checkpoints. +/// The upgrade does not affect the source and destination indices. +/// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. +/// +/// +/// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. +/// Resolve the issue then re-run the process again. +/// A summary is returned when the upgrade is finished. +/// +/// +/// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. +/// You may want to perform a recent cluster backup prior to the upgrade. /// /// public sealed partial class UpgradeTransformsRequest : PlainRequest @@ -88,12 +98,22 @@ public sealed partial class UpgradeTransformsRequest : PlainRequest /// -/// Upgrades all transforms. -/// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It -/// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not -/// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when -/// Elasticsearch security features are enabled; the role used to read source data and write to the destination index -/// remains unchanged. +/// Upgrade all transforms. +/// Transforms are compatible across minor versions and between supported major versions. +/// However, over time, the format of transform configuration information may change. +/// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. +/// It also cleans up the internal data structures that store the transform state and checkpoints. +/// The upgrade does not affect the source and destination indices. +/// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. +/// +/// +/// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. +/// Resolve the issue then re-run the process again. +/// A summary is returned when the upgrade is finished. +/// +/// +/// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. +/// You may want to perform a recent cluster backup prior to the upgrade. /// /// public sealed partial class UpgradeTransformsRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/UpdateByQueryRethrottleRequest.g.cs index 5a793d21b27..6ee3ca87ed4 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/Api/Xpack/XpackInfoRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackInfoRequest.g.cs index 4399788c3ee..42b67ad0cb0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackInfoRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackInfoRequest.g.cs @@ -49,8 +49,26 @@ public sealed partial class XpackInfoRequestParameters : RequestParameters /// /// -/// Provides general information about the installed X-Pack features. +/// Get information. +/// The information provided by the API includes: /// +/// +/// +/// +/// Build information including the build number and timestamp. +/// +/// +/// +/// +/// License information about the currently installed license. +/// +/// +/// +/// +/// Feature information for the features that are currently enabled and available under the current license. +/// +/// +/// /// public sealed partial class XpackInfoRequest : PlainRequest { @@ -81,8 +99,26 @@ public sealed partial class XpackInfoRequest : PlainRequest /// -/// Provides general information about the installed X-Pack features. +/// Get information. +/// The information provided by the API includes: +/// +/// +/// +/// +/// Build information including the build number and timestamp. +/// +/// +/// +/// +/// License information about the currently installed license. +/// +/// +/// +/// +/// Feature information for the features that are currently enabled and available under the current license. /// +/// +/// /// public sealed partial class XpackInfoRequestDescriptor : RequestDescriptor { diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackUsageRequest.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackUsageRequest.g.cs index 8a0ac0566a4..f166a00e6dc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackUsageRequest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Api/Xpack/XpackUsageRequest.g.cs @@ -42,7 +42,9 @@ public sealed partial class XpackUsageRequestParameters : RequestParameters /// /// -/// This API provides information about which features are currently enabled and available under the current license and some usage statistics. +/// Get usage information. +/// Get information about the features that are currently enabled and available under the current license. +/// The API also provides some usage statistics. /// /// public sealed partial class XpackUsageRequest : PlainRequest @@ -66,7 +68,9 @@ public sealed partial class XpackUsageRequest : PlainRequest /// -/// This API provides information about which features are currently enabled and available under the current license and some usage statistics. +/// Get usage information. +/// Get information about the features that are currently enabled and available under the current license. +/// The API also provides some usage statistics. /// /// public sealed partial class XpackUsageRequestDescriptor : RequestDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.AsyncSearch.g.cs index 0169e8ecc2f..6cdf90cffa7 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 302f2b4bccf..410d8d118fe 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ccr.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ccr.g.cs @@ -41,9 +41,10 @@ internal CrossClusterReplicationNamespacedClient(ElasticsearchClient client) : b /// /// - /// Deletes auto-follow patterns. + /// Delete auto-follow patterns. + /// Delete a collection of cross-cluster replication 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) @@ -54,9 +55,10 @@ public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(DeleteAut /// /// - /// Deletes auto-follow patterns. + /// Delete auto-follow patterns. + /// Delete a collection of cross-cluster replication 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) { @@ -66,9 +68,10 @@ public virtual Task DeleteAutoFollowPatternAsyn /// /// - /// Deletes auto-follow patterns. + /// Delete auto-follow patterns. + /// Delete a collection of cross-cluster replication 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) @@ -79,9 +82,10 @@ public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(DeleteAut /// /// - /// Deletes auto-follow patterns. + /// Delete auto-follow patterns. + /// Delete a collection of cross-cluster replication 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) @@ -93,9 +97,10 @@ public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(Elastic.C /// /// - /// Deletes auto-follow patterns. + /// Delete auto-follow patterns. + /// Delete a collection of cross-cluster replication 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) @@ -108,9 +113,10 @@ public virtual DeleteAutoFollowPatternResponse DeleteAutoFollowPattern(Elastic.C /// /// - /// Deletes auto-follow patterns. + /// Delete auto-follow patterns. + /// Delete a collection of cross-cluster replication 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) { @@ -120,9 +126,10 @@ public virtual Task DeleteAutoFollowPatternAsyn /// /// - /// Deletes auto-follow patterns. + /// Delete auto-follow patterns. + /// Delete a collection of cross-cluster replication 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) { @@ -133,9 +140,10 @@ public virtual Task DeleteAutoFollowPatternAsyn /// /// - /// Deletes auto-follow patterns. + /// Delete auto-follow patterns. + /// Delete a collection of cross-cluster replication 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) { @@ -147,9 +155,11 @@ public virtual Task DeleteAutoFollowPatternAsyn /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the 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 FollowResponse Follow(FollowRequest request) @@ -160,9 +170,11 @@ public virtual FollowResponse Follow(FollowRequest request) /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower 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) { @@ -172,9 +184,11 @@ public virtual Task FollowAsync(FollowRequest request, Cancellat /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the 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 FollowResponse Follow(FollowRequestDescriptor descriptor) @@ -185,9 +199,11 @@ public virtual FollowResponse Follow(FollowRequestDescriptor /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the 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 FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName index) @@ -199,9 +215,11 @@ public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.In /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the 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 FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest) @@ -214,9 +232,11 @@ public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.In /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the 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 FollowResponse Follow() @@ -228,9 +248,11 @@ public virtual FollowResponse Follow() /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the 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 FollowResponse Follow(Action> configureRequest) @@ -243,9 +265,11 @@ public virtual FollowResponse Follow(Action /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the 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 FollowResponse Follow(FollowRequestDescriptor descriptor) @@ -256,9 +280,11 @@ public virtual FollowResponse Follow(FollowRequestDescriptor descriptor) /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the 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 FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName index) @@ -270,9 +296,11 @@ public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName ind /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the 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 FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest) @@ -285,9 +313,11 @@ public virtual FollowResponse Follow(Elastic.Clients.Elasticsearch.IndexName ind /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower 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) { @@ -297,9 +327,11 @@ public virtual Task FollowAsync(FollowRequestDescript /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower 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) { @@ -310,9 +342,11 @@ public virtual Task FollowAsync(Elastic.Clients.Elast /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower 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) { @@ -324,9 +358,11 @@ public virtual Task FollowAsync(Elastic.Clients.Elast /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower 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) { @@ -337,9 +373,11 @@ public virtual Task FollowAsync(CancellationToken can /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower 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) { @@ -351,9 +389,11 @@ public virtual Task FollowAsync(Action /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower 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) { @@ -363,9 +403,11 @@ public virtual Task FollowAsync(FollowRequestDescriptor descript /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower 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) { @@ -376,9 +418,11 @@ public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.In /// /// - /// Creates a new follower index configured to follow the referenced leader index. + /// Create a follower. + /// Create a cross-cluster replication follower index that follows a specific leader index. + /// When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower 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) { @@ -390,9 +434,11 @@ public virtual Task FollowAsync(Elastic.Clients.Elasticsearch.In /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or 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 FollowInfoResponse FollowInfo(FollowInfoRequest request) @@ -403,9 +449,11 @@ public virtual FollowInfoResponse FollowInfo(FollowInfoRequest request) /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. /// - /// 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) { @@ -415,9 +463,11 @@ public virtual Task FollowInfoAsync(FollowInfoRequest reques /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or 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 FollowInfoResponse FollowInfo(FollowInfoRequestDescriptor descriptor) @@ -428,9 +478,11 @@ public virtual FollowInfoResponse FollowInfo(FollowInfoRequestDescrip /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or 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 FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indices indices) @@ -442,9 +494,11 @@ public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elastics /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or 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 FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest) @@ -457,9 +511,11 @@ public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elastics /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or 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 FollowInfoResponse FollowInfo() @@ -471,9 +527,11 @@ public virtual FollowInfoResponse FollowInfo() /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or 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 FollowInfoResponse FollowInfo(Action> configureRequest) @@ -486,9 +544,11 @@ public virtual FollowInfoResponse FollowInfo(Action /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or 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 FollowInfoResponse FollowInfo(FollowInfoRequestDescriptor descriptor) @@ -499,9 +559,11 @@ public virtual FollowInfoResponse FollowInfo(FollowInfoRequestDescriptor descrip /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or 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 FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indices indices) @@ -513,9 +575,11 @@ public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indic /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or 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 FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest) @@ -528,9 +592,11 @@ public virtual FollowInfoResponse FollowInfo(Elastic.Clients.Elasticsearch.Indic /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. /// - /// 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) { @@ -540,9 +606,11 @@ public virtual Task FollowInfoAsync(FollowInfoReq /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. /// - /// 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) { @@ -553,9 +621,11 @@ public virtual Task FollowInfoAsync(Elastic.Clien /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. /// - /// 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) { @@ -567,9 +637,11 @@ public virtual Task FollowInfoAsync(Elastic.Clien /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. /// - /// 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) { @@ -580,9 +652,11 @@ public virtual Task FollowInfoAsync(CancellationT /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. /// - /// 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) { @@ -594,9 +668,11 @@ public virtual Task FollowInfoAsync(Action /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. /// - /// 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) { @@ -606,9 +682,11 @@ public virtual Task FollowInfoAsync(FollowInfoRequestDescrip /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. /// - /// 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) { @@ -619,9 +697,11 @@ public virtual Task FollowInfoAsync(Elastic.Clients.Elastics /// /// - /// Retrieves information about all follower indices, including parameters and status for each follower index + /// Get follower information. + /// Get information about all cross-cluster replication follower indices. + /// For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. /// - /// 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) { @@ -633,9 +713,11 @@ 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. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) @@ -646,9 +728,11 @@ 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. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) { @@ -658,9 +742,11 @@ 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. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) @@ -671,9 +757,11 @@ public virtual FollowStatsResponse FollowStats(FollowStatsRequestDesc /// /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) @@ -685,9 +773,11 @@ 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. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) @@ -700,9 +790,11 @@ 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. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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() @@ -714,9 +806,11 @@ public virtual FollowStatsResponse FollowStats() /// /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) @@ -729,9 +823,11 @@ public virtual FollowStatsResponse FollowStats(Action /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) @@ -742,9 +838,11 @@ 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. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) @@ -756,9 +854,11 @@ 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. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) @@ -771,9 +871,11 @@ 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. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) { @@ -783,9 +885,11 @@ public virtual Task FollowStatsAsync(FollowStats /// /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) { @@ -796,9 +900,11 @@ 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. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) { @@ -810,9 +916,11 @@ 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. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) { @@ -823,9 +931,11 @@ public virtual Task FollowStatsAsync(Cancellatio /// /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) { @@ -837,9 +947,11 @@ public virtual Task FollowStatsAsync(Action /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) { @@ -849,9 +961,11 @@ public virtual Task FollowStatsAsync(FollowStatsRequestDesc /// /// - /// Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) { @@ -862,9 +976,11 @@ 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. + /// Get follower stats. + /// Get cross-cluster replication follower stats. + /// The API returns 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) { @@ -876,9 +992,22 @@ public virtual Task FollowStatsAsync(Elastic.Clients.Elasti /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. + /// + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// 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) @@ -889,9 +1018,22 @@ public virtual ForgetFollowerResponse ForgetFollower(ForgetFollowerRequest reque /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. + /// + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(ForgetFollowerRequest request, CancellationToken cancellationToken = default) { @@ -901,9 +1043,22 @@ public virtual Task ForgetFollowerAsync(ForgetFollowerRe /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. + /// + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. + /// + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. /// - /// Learn more about this API in the Elasticsearch 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) @@ -914,9 +1069,22 @@ public virtual ForgetFollowerResponse ForgetFollower(ForgetFollowerRe /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. + /// + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// 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) @@ -928,9 +1096,22 @@ public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients. /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. + /// + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// 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) @@ -943,9 +1124,22 @@ public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients. /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. + /// + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// 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() @@ -957,9 +1151,22 @@ public virtual ForgetFollowerResponse ForgetFollower() /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. + /// + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// 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) @@ -972,9 +1179,22 @@ public virtual ForgetFollowerResponse ForgetFollower(Action /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. + /// + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. + /// + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. /// - /// Learn more about this API in the Elasticsearch 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) @@ -985,9 +1205,22 @@ public virtual ForgetFollowerResponse ForgetFollower(ForgetFollowerRequestDescri /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. + /// + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. + /// + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. /// - /// Learn more about this API in the Elasticsearch 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) @@ -999,9 +1232,22 @@ public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients.Elasticsear /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. + /// + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. + /// + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1014,9 +1260,22 @@ public virtual ForgetFollowerResponse ForgetFollower(Elastic.Clients.Elasticsear /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. + /// + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. + /// + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. /// - /// 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) { @@ -1026,9 +1285,22 @@ public virtual Task ForgetFollowerAsync(Forge /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. + /// + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -1039,9 +1311,22 @@ public virtual Task ForgetFollowerAsync(Elast /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. + /// + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1053,9 +1338,22 @@ public virtual Task ForgetFollowerAsync(Elast /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. + /// + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(CancellationToken cancellationToken = default) { @@ -1066,9 +1364,22 @@ public virtual Task ForgetFollowerAsync(Cance /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. + /// + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1080,9 +1391,22 @@ public virtual Task ForgetFollowerAsync(Actio /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. + /// + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(ForgetFollowerRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1092,9 +1416,22 @@ public virtual Task ForgetFollowerAsync(ForgetFollowerRe /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. + /// + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -1105,9 +1442,22 @@ public virtual Task ForgetFollowerAsync(Elastic.Clients. /// /// - /// Removes the follower retention leases from the leader. + /// Forget a follower. + /// Remove the cross-cluster replication follower retention leases from the leader. + /// + /// + /// A following index takes out retention leases on its leader index. + /// These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + /// When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + /// However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + /// While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + /// This API exists to enable manually removing the leases when the unfollow API is unable to do so. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + /// The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ForgetFollowerAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1119,9 +1469,10 @@ public virtual Task ForgetFollowerAsync(Elastic.Clients. /// /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// Get auto-follow patterns. + /// Get cross-cluster replication 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 GetAutoFollowPatternResponse GetAutoFollowPattern(GetAutoFollowPatternRequest request) @@ -1132,9 +1483,10 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(GetAutoFollowPa /// /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// Get auto-follow patterns. + /// Get cross-cluster replication auto-follow patterns. /// - /// 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) { @@ -1144,9 +1496,10 @@ public virtual Task GetAutoFollowPatternAsync(GetA /// /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// Get auto-follow patterns. + /// Get cross-cluster replication 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 GetAutoFollowPatternResponse GetAutoFollowPattern(GetAutoFollowPatternRequestDescriptor descriptor) @@ -1157,9 +1510,10 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(GetAutoFollowPa /// /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// Get auto-follow patterns. + /// Get cross-cluster replication 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 GetAutoFollowPatternResponse GetAutoFollowPattern(Elastic.Clients.Elasticsearch.Name? name) @@ -1171,9 +1525,10 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(Elastic.Clients /// /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// Get auto-follow patterns. + /// Get cross-cluster replication 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 GetAutoFollowPatternResponse GetAutoFollowPattern(Elastic.Clients.Elasticsearch.Name? name, Action configureRequest) @@ -1186,9 +1541,10 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(Elastic.Clients /// /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// Get auto-follow patterns. + /// Get cross-cluster replication 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 GetAutoFollowPatternResponse GetAutoFollowPattern() @@ -1200,9 +1556,10 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern() /// /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// Get auto-follow patterns. + /// Get cross-cluster replication 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 GetAutoFollowPatternResponse GetAutoFollowPattern(Action configureRequest) @@ -1215,9 +1572,10 @@ public virtual GetAutoFollowPatternResponse GetAutoFollowPattern(Action /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// Get auto-follow patterns. + /// Get cross-cluster replication auto-follow patterns. /// - /// 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) { @@ -1227,9 +1585,10 @@ public virtual Task GetAutoFollowPatternAsync(GetA /// /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// Get auto-follow patterns. + /// Get cross-cluster replication auto-follow patterns. /// - /// 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) { @@ -1240,9 +1599,10 @@ public virtual Task GetAutoFollowPatternAsync(Elas /// /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// Get auto-follow patterns. + /// Get cross-cluster replication auto-follow patterns. /// - /// 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) { @@ -1254,9 +1614,10 @@ public virtual Task GetAutoFollowPatternAsync(Elas /// /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// Get auto-follow patterns. + /// Get cross-cluster replication auto-follow patterns. /// - /// 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) { @@ -1267,9 +1628,10 @@ public virtual Task GetAutoFollowPatternAsync(Canc /// /// - /// Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + /// Get auto-follow patterns. + /// Get cross-cluster replication auto-follow patterns. /// - /// 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) { @@ -1281,9 +1643,17 @@ public virtual Task GetAutoFollowPatternAsync(Acti /// /// - /// Pauses an auto-follow pattern + /// Pause an auto-follow pattern. + /// Pause a cross-cluster replication auto-follow pattern. + /// When the API returns, the auto-follow pattern is inactive. + /// New indices that are created on the remote cluster and match the auto-follow patterns are ignored. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// You can resume auto-following with the resume auto-follow pattern API. + /// When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. + /// Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. + /// + /// 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) @@ -1294,9 +1664,17 @@ public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(PauseAutoFo /// /// - /// Pauses an auto-follow pattern + /// Pause an auto-follow pattern. + /// Pause a cross-cluster replication auto-follow pattern. + /// When the API returns, the auto-follow pattern is inactive. + /// New indices that are created on the remote cluster and match the auto-follow patterns are ignored. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// You can resume auto-following with the resume auto-follow pattern API. + /// When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. + /// Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseAutoFollowPatternAsync(PauseAutoFollowPatternRequest request, CancellationToken cancellationToken = default) { @@ -1306,9 +1684,17 @@ public virtual Task PauseAutoFollowPatternAsync( /// /// - /// Pauses an auto-follow pattern + /// Pause an auto-follow pattern. + /// Pause a cross-cluster replication auto-follow pattern. + /// When the API returns, the auto-follow pattern is inactive. + /// New indices that are created on the remote cluster and match the auto-follow patterns are ignored. + /// + /// + /// You can resume auto-following with the resume auto-follow pattern API. + /// When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. + /// Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1319,9 +1705,17 @@ public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(PauseAutoFo /// /// - /// Pauses an auto-follow pattern + /// Pause an auto-follow pattern. + /// Pause a cross-cluster replication auto-follow pattern. + /// When the API returns, the auto-follow pattern is inactive. + /// New indices that are created on the remote cluster and match the auto-follow patterns are ignored. + /// + /// + /// You can resume auto-following with the resume auto-follow pattern API. + /// When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. + /// Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1333,9 +1727,17 @@ public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(Elastic.Cli /// /// - /// Pauses an auto-follow pattern + /// Pause an auto-follow pattern. + /// Pause a cross-cluster replication auto-follow pattern. + /// When the API returns, the auto-follow pattern is inactive. + /// New indices that are created on the remote cluster and match the auto-follow patterns are ignored. + /// + /// + /// You can resume auto-following with the resume auto-follow pattern API. + /// When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. + /// Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1348,9 +1750,17 @@ public virtual PauseAutoFollowPatternResponse PauseAutoFollowPattern(Elastic.Cli /// /// - /// Pauses an auto-follow pattern + /// Pause an auto-follow pattern. + /// Pause a cross-cluster replication auto-follow pattern. + /// When the API returns, the auto-follow pattern is inactive. + /// New indices that are created on the remote cluster and match the auto-follow patterns are ignored. + /// + /// + /// You can resume auto-following with the resume auto-follow pattern API. + /// When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. + /// Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. /// - /// 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) { @@ -1360,9 +1770,17 @@ public virtual Task PauseAutoFollowPatternAsync( /// /// - /// Pauses an auto-follow pattern + /// Pause an auto-follow pattern. + /// Pause a cross-cluster replication auto-follow pattern. + /// When the API returns, the auto-follow pattern is inactive. + /// New indices that are created on the remote cluster and match the auto-follow patterns are ignored. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// You can resume auto-following with the resume auto-follow pattern API. + /// When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. + /// Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PauseAutoFollowPatternAsync(Elastic.Clients.Elasticsearch.Name name, CancellationToken cancellationToken = default) { @@ -1373,9 +1791,17 @@ public virtual Task PauseAutoFollowPatternAsync( /// /// - /// Pauses an auto-follow pattern + /// Pause an auto-follow pattern. + /// Pause a cross-cluster replication auto-follow pattern. + /// When the API returns, the auto-follow pattern is inactive. + /// New indices that are created on the remote cluster and match the auto-follow patterns are ignored. + /// + /// + /// You can resume auto-following with the resume auto-follow pattern API. + /// When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. + /// Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. /// - /// 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) { @@ -1387,9 +1813,13 @@ public virtual Task PauseAutoFollowPatternAsync( /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1400,9 +1830,13 @@ public virtual PauseFollowResponse PauseFollow(PauseFollowRequest request) /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// 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) { @@ -1412,9 +1846,13 @@ public virtual Task PauseFollowAsync(PauseFollowRequest req /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1425,9 +1863,13 @@ public virtual PauseFollowResponse PauseFollow(PauseFollowRequestDesc /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1439,9 +1881,13 @@ public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasti /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1454,9 +1900,13 @@ public virtual PauseFollowResponse PauseFollow(Elastic.Clients.Elasti /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// Learn more about this API in the Elasticsearch 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() @@ -1468,9 +1918,13 @@ public virtual PauseFollowResponse PauseFollow() /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1483,9 +1937,13 @@ public virtual PauseFollowResponse PauseFollow(Action /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1496,9 +1954,13 @@ public virtual PauseFollowResponse PauseFollow(PauseFollowRequestDescriptor desc /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1510,9 +1972,13 @@ 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. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1525,9 +1991,13 @@ 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. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// 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) { @@ -1537,9 +2007,13 @@ public virtual Task PauseFollowAsync(PauseFollow /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// 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) { @@ -1550,9 +2024,13 @@ public virtual Task PauseFollowAsync(Elastic.Cli /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// 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) { @@ -1564,9 +2042,13 @@ public virtual Task PauseFollowAsync(Elastic.Cli /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// 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) { @@ -1577,9 +2059,13 @@ public virtual Task PauseFollowAsync(Cancellatio /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// 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) { @@ -1591,9 +2077,13 @@ public virtual Task PauseFollowAsync(Action /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// 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) { @@ -1603,9 +2093,13 @@ public virtual Task PauseFollowAsync(PauseFollowRequestDesc /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// 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) { @@ -1616,9 +2110,13 @@ public virtual Task PauseFollowAsync(Elastic.Clients.Elasti /// /// - /// Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + /// Pause a follower. + /// Pause a cross-cluster replication follower index. + /// The follower index will not fetch any additional operations from the leader index. + /// You can resume following with the resume follower API. + /// You can pause and resume a follower index to change the configuration of the following task. /// - /// 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) { @@ -1630,9 +2128,16 @@ 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. + /// Create or update auto-follow patterns. + /// Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. + /// Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. + /// Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// This API can also be used to update auto-follow patterns. + /// NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. + /// + /// 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) @@ -1643,9 +2148,16 @@ 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. + /// Create or update auto-follow patterns. + /// Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. + /// Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. + /// Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// This API can also be used to update auto-follow patterns. + /// NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PutAutoFollowPatternAsync(PutAutoFollowPatternRequest request, CancellationToken cancellationToken = default) { @@ -1655,9 +2167,16 @@ 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. + /// Create or update auto-follow patterns. + /// Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. + /// Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. + /// Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// This API can also be used to update auto-follow patterns. + /// NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. + /// + /// 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) @@ -1668,9 +2187,16 @@ 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. + /// Create or update auto-follow patterns. + /// Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. + /// Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. + /// Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. + /// + /// + /// This API can also be used to update auto-follow patterns. + /// NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new 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 PutAutoFollowPatternResponse PutAutoFollowPattern(Elastic.Clients.Elasticsearch.Name name) @@ -1682,9 +2208,16 @@ 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. + /// Create or update auto-follow patterns. + /// Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. + /// Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. + /// Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// This API can also be used to update auto-follow patterns. + /// NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. + /// + /// 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) @@ -1697,9 +2230,16 @@ 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. + /// Create or update auto-follow patterns. + /// Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. + /// Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. + /// Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. + /// + /// + /// This API can also be used to update auto-follow patterns. + /// NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. /// - /// 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) { @@ -1709,9 +2249,16 @@ 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. + /// Create or update auto-follow patterns. + /// Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. + /// Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. + /// Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. + /// + /// + /// This API can also be used to update auto-follow patterns. + /// NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. /// - /// 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) { @@ -1722,9 +2269,16 @@ 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. + /// Create or update auto-follow patterns. + /// Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. + /// Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. + /// Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. + /// + /// + /// This API can also be used to update auto-follow patterns. + /// NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. /// - /// 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) { @@ -1736,9 +2290,12 @@ public virtual Task PutAutoFollowPatternAsync(Elas /// /// - /// Resumes an auto-follow pattern that has been paused + /// Resume an auto-follow pattern. + /// Resume a cross-cluster replication auto-follow pattern that was paused. + /// The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. + /// Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1749,9 +2306,12 @@ public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(ResumeAut /// /// - /// Resumes an auto-follow pattern that has been paused + /// Resume an auto-follow pattern. + /// Resume a cross-cluster replication auto-follow pattern that was paused. + /// The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. + /// Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. /// - /// 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) { @@ -1761,9 +2321,12 @@ public virtual Task ResumeAutoFollowPatternAsyn /// /// - /// Resumes an auto-follow pattern that has been paused + /// Resume an auto-follow pattern. + /// Resume a cross-cluster replication auto-follow pattern that was paused. + /// The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. + /// Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1774,9 +2337,12 @@ public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(ResumeAut /// /// - /// Resumes an auto-follow pattern that has been paused + /// Resume an auto-follow pattern. + /// Resume a cross-cluster replication auto-follow pattern that was paused. + /// The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. + /// Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1788,9 +2354,12 @@ public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(Elastic.C /// /// - /// Resumes an auto-follow pattern that has been paused + /// Resume an auto-follow pattern. + /// Resume a cross-cluster replication auto-follow pattern that was paused. + /// The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. + /// Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1803,9 +2372,12 @@ public virtual ResumeAutoFollowPatternResponse ResumeAutoFollowPattern(Elastic.C /// /// - /// Resumes an auto-follow pattern that has been paused + /// Resume an auto-follow pattern. + /// Resume a cross-cluster replication auto-follow pattern that was paused. + /// The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. + /// Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. /// - /// 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) { @@ -1815,9 +2387,12 @@ public virtual Task ResumeAutoFollowPatternAsyn /// /// - /// Resumes an auto-follow pattern that has been paused + /// Resume an auto-follow pattern. + /// Resume a cross-cluster replication auto-follow pattern that was paused. + /// The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. + /// Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. /// - /// 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) { @@ -1828,9 +2403,12 @@ public virtual Task ResumeAutoFollowPatternAsyn /// /// - /// Resumes an auto-follow pattern that has been paused + /// Resume an auto-follow pattern. + /// Resume a cross-cluster replication auto-follow pattern that was paused. + /// The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. + /// Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. /// - /// 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) { @@ -1842,9 +2420,13 @@ public virtual Task ResumeAutoFollowPatternAsyn /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowResponse ResumeFollow(ResumeFollowRequest request) @@ -1855,9 +2437,13 @@ public virtual ResumeFollowResponse ResumeFollow(ResumeFollowRequest request) /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowAsync(ResumeFollowRequest request, CancellationToken cancellationToken = default) { @@ -1867,9 +2453,13 @@ public virtual Task ResumeFollowAsync(ResumeFollowRequest /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowResponse ResumeFollow(ResumeFollowRequestDescriptor descriptor) @@ -1880,9 +2470,13 @@ public virtual ResumeFollowResponse ResumeFollow(ResumeFollowRequestD /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.IndexName index) @@ -1894,9 +2488,13 @@ public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elas /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest) @@ -1909,9 +2507,13 @@ public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elas /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowResponse ResumeFollow() @@ -1923,9 +2525,13 @@ public virtual ResumeFollowResponse ResumeFollow() /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowResponse ResumeFollow(Action> configureRequest) @@ -1938,9 +2544,13 @@ public virtual ResumeFollowResponse ResumeFollow(Action /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowResponse ResumeFollow(ResumeFollowRequestDescriptor descriptor) @@ -1951,9 +2561,13 @@ public virtual ResumeFollowResponse ResumeFollow(ResumeFollowRequestDescriptor d /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.IndexName index) @@ -1965,9 +2579,13 @@ public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.I /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest) @@ -1980,9 +2598,13 @@ public virtual ResumeFollowResponse ResumeFollow(Elastic.Clients.Elasticsearch.I /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowAsync(ResumeFollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1992,9 +2614,13 @@ public virtual Task ResumeFollowAsync(ResumeFol /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -2005,9 +2631,13 @@ public virtual Task ResumeFollowAsync(Elastic.C /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -2019,9 +2649,13 @@ public virtual Task ResumeFollowAsync(Elastic.C /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowAsync(CancellationToken cancellationToken = default) { @@ -2032,9 +2666,13 @@ public virtual Task ResumeFollowAsync(Cancellat /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -2046,9 +2684,13 @@ public virtual Task ResumeFollowAsync(Action /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowAsync(ResumeFollowRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -2058,9 +2700,13 @@ public virtual Task ResumeFollowAsync(ResumeFollowRequestD /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -2071,9 +2717,13 @@ public virtual Task ResumeFollowAsync(Elastic.Clients.Elas /// /// - /// Resumes a follower index that has been paused + /// Resume a follower. + /// Resume a cross-cluster replication follower index that was paused. + /// The follower index could have been paused with the pause follower API. + /// Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + /// When this API returns, the follower index will resume fetching 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 ResumeFollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action configureRequest, CancellationToken cancellationToken = default) { @@ -2085,9 +2735,10 @@ public virtual Task ResumeFollowAsync(Elastic.Clients.Elas /// /// - /// Gets all stats related to cross-cluster replication. + /// Get cross-cluster replication stats. + /// This API returns stats about auto-following and the same shard-level stats as the get follower stats 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 CcrStatsResponse Stats(CcrStatsRequest request) @@ -2098,9 +2749,10 @@ public virtual CcrStatsResponse Stats(CcrStatsRequest request) /// /// - /// Gets all stats related to cross-cluster replication. + /// Get cross-cluster replication stats. + /// This API returns stats about auto-following and the same shard-level stats as the get follower stats API. /// - /// 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) { @@ -2110,9 +2762,10 @@ public virtual Task StatsAsync(CcrStatsRequest request, Cancel /// /// - /// Gets all stats related to cross-cluster replication. + /// Get cross-cluster replication stats. + /// This API returns stats about auto-following and the same shard-level stats as the get follower stats 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 CcrStatsResponse Stats(CcrStatsRequestDescriptor descriptor) @@ -2123,9 +2776,10 @@ public virtual CcrStatsResponse Stats(CcrStatsRequestDescriptor descriptor) /// /// - /// Gets all stats related to cross-cluster replication. + /// Get cross-cluster replication stats. + /// This API returns stats about auto-following and the same shard-level stats as the get follower stats 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 CcrStatsResponse Stats() @@ -2137,9 +2791,10 @@ public virtual CcrStatsResponse Stats() /// /// - /// Gets all stats related to cross-cluster replication. + /// Get cross-cluster replication stats. + /// This API returns stats about auto-following and the same shard-level stats as the get follower stats 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 CcrStatsResponse Stats(Action configureRequest) @@ -2152,9 +2807,10 @@ public virtual CcrStatsResponse Stats(Action configur /// /// - /// Gets all stats related to cross-cluster replication. + /// Get cross-cluster replication stats. + /// This API returns stats about auto-following and the same shard-level stats as the get follower stats API. /// - /// 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) { @@ -2164,9 +2820,10 @@ public virtual Task StatsAsync(CcrStatsRequestDescriptor descr /// /// - /// Gets all stats related to cross-cluster replication. + /// Get cross-cluster replication stats. + /// This API returns stats about auto-following and the same shard-level stats as the get follower stats API. /// - /// 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) { @@ -2177,9 +2834,10 @@ public virtual Task StatsAsync(CancellationToken cancellationT /// /// - /// Gets all stats related to cross-cluster replication. + /// Get cross-cluster replication stats. + /// This API returns stats about auto-following and the same shard-level stats as the get follower stats API. /// - /// 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) { @@ -2191,9 +2849,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. + /// + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// - /// Learn more about this API in the Elasticsearch 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) @@ -2204,9 +2868,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. + /// + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// - /// 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) { @@ -2216,9 +2886,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. + /// + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// - /// Learn more about this API in the Elasticsearch 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) @@ -2229,9 +2905,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. + /// + /// 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) @@ -2243,9 +2925,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. + /// + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// - /// Learn more about this API in the Elasticsearch 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) @@ -2258,9 +2946,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. + /// + /// 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() @@ -2272,9 +2966,15 @@ public virtual UnfollowResponse Unfollow() /// /// - /// Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. + /// + /// 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) @@ -2287,9 +2987,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. + /// + /// 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) @@ -2300,9 +3006,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. + /// + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// - /// Learn more about this API in the Elasticsearch 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) @@ -2314,9 +3026,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. + /// + /// 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) @@ -2329,9 +3047,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. + /// + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// - /// 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) { @@ -2341,9 +3065,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. + /// + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// - /// 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) { @@ -2354,9 +3084,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Elastic.Clients.Elasticsearch.IndexName index, Action> configureRequest, CancellationToken cancellationToken = default) { @@ -2368,9 +3104,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. + /// + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// - /// 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) { @@ -2381,9 +3123,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -2395,9 +3143,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. + /// + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// - /// 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) { @@ -2407,9 +3161,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task UnfollowAsync(Elastic.Clients.Elasticsearch.IndexName index, CancellationToken cancellationToken = default) { @@ -2420,9 +3180,15 @@ 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. + /// Unfollow an index. + /// Convert a cross-cluster replication follower index to a regular index. + /// The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + /// The follower index must be paused and closed before you call the unfollow API. + /// + /// + /// NOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. /// - /// 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 b7c03eaef6a..12a5de69299 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Cluster.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Cluster.g.cs @@ -41,9 +41,13 @@ internal ClusterNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Provides explanations for shard allocations in the cluster. + /// Explain the shard allocations. + /// Get explanations for shard allocations in the cluster. + /// For unassigned shards, it provides an explanation for why the shard is unassigned. + /// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + /// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// - /// Learn more about this API in the Elasticsearch 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) @@ -54,9 +58,13 @@ public virtual AllocationExplainResponse AllocationExplain(AllocationExplainRequ /// /// - /// Provides explanations for shard allocations in the cluster. + /// Explain the shard allocations. + /// Get explanations for shard allocations in the cluster. + /// For unassigned shards, it provides an explanation for why the shard is unassigned. + /// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + /// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// - /// 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) { @@ -66,9 +74,13 @@ public virtual Task AllocationExplainAsync(Allocation /// /// - /// Provides explanations for shard allocations in the cluster. + /// Explain the shard allocations. + /// Get explanations for shard allocations in the cluster. + /// For unassigned shards, it provides an explanation for why the shard is unassigned. + /// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + /// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// - /// Learn more about this API in the Elasticsearch 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) @@ -79,9 +91,13 @@ public virtual AllocationExplainResponse AllocationExplain(AllocationExplainRequ /// /// - /// Provides explanations for shard allocations in the cluster. + /// Explain the shard allocations. + /// Get explanations for shard allocations in the cluster. + /// For unassigned shards, it provides an explanation for why the shard is unassigned. + /// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + /// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// - /// Learn more about this API in the Elasticsearch 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() @@ -93,9 +109,13 @@ public virtual AllocationExplainResponse AllocationExplain() /// /// - /// Provides explanations for shard allocations in the cluster. + /// Explain the shard allocations. + /// Get explanations for shard allocations in the cluster. + /// For unassigned shards, it provides an explanation for why the shard is unassigned. + /// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + /// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// - /// Learn more about this API in the Elasticsearch 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) @@ -108,9 +128,13 @@ public virtual AllocationExplainResponse AllocationExplain(Action /// - /// Provides explanations for shard allocations in the cluster. + /// Explain the shard allocations. + /// Get explanations for shard allocations in the cluster. + /// For unassigned shards, it provides an explanation for why the shard is unassigned. + /// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + /// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// - /// 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) { @@ -120,9 +144,13 @@ public virtual Task AllocationExplainAsync(Allocation /// /// - /// Provides explanations for shard allocations in the cluster. + /// Explain the shard allocations. + /// Get explanations for shard allocations in the cluster. + /// For unassigned shards, it provides an explanation for why the shard is unassigned. + /// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + /// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// - /// 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) { @@ -133,9 +161,13 @@ public virtual Task AllocationExplainAsync(Cancellati /// /// - /// Provides explanations for shard allocations in the cluster. + /// Explain the shard allocations. + /// Get explanations for shard allocations in the cluster. + /// For unassigned shards, it provides an explanation for why the shard is unassigned. + /// For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + /// This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. /// - /// 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 +183,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 +198,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 +212,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 +227,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 +243,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 +260,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 +274,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 +289,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) { @@ -269,9 +301,10 @@ public virtual Task DeleteComponentTemplateAsyn /// /// - /// Clears cluster voting config exclusions. + /// Clear cluster voting config exclusions. + /// Remove master-eligible nodes from the voting configuration exclusion list. /// - /// Learn more about this API in the Elasticsearch 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) @@ -282,9 +315,10 @@ public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions /// /// - /// Clears cluster voting config exclusions. + /// Clear cluster voting config exclusions. + /// Remove master-eligible nodes from the voting configuration exclusion list. /// - /// 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) { @@ -294,9 +328,10 @@ public virtual Task DeleteVotingConfigExcl /// /// - /// Clears cluster voting config exclusions. + /// Clear cluster voting config exclusions. + /// Remove master-eligible nodes from the voting configuration exclusion list. /// - /// Learn more about this API in the Elasticsearch 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) @@ -307,9 +342,10 @@ public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions /// /// - /// Clears cluster voting config exclusions. + /// Clear cluster voting config exclusions. + /// Remove master-eligible nodes from the voting configuration exclusion list. /// - /// Learn more about this API in the Elasticsearch 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() @@ -321,9 +357,10 @@ public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions /// /// - /// Clears cluster voting config exclusions. + /// Clear cluster voting config exclusions. + /// Remove master-eligible nodes from the voting configuration exclusion list. /// - /// Learn more about this API in the Elasticsearch 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) @@ -336,9 +373,10 @@ public virtual DeleteVotingConfigExclusionsResponse DeleteVotingConfigExclusions /// /// - /// Clears cluster voting config exclusions. + /// Clear cluster voting config exclusions. + /// Remove master-eligible nodes from the voting configuration exclusion list. /// - /// 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) { @@ -348,9 +386,10 @@ public virtual Task DeleteVotingConfigExcl /// /// - /// Clears cluster voting config exclusions. + /// Clear cluster voting config exclusions. + /// Remove master-eligible nodes from the voting configuration exclusion list. /// - /// 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) { @@ -361,9 +400,10 @@ public virtual Task DeleteVotingConfigExcl /// /// - /// Clears cluster voting config exclusions. + /// Clear cluster voting config exclusions. + /// Remove master-eligible nodes from the voting configuration exclusion list. /// - /// 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 +418,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 +432,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 +445,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 +459,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 +474,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 +490,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 +503,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 +517,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 +532,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 +546,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 +559,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 +573,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 +588,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 +604,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 +619,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 +635,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 +648,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 +662,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 +677,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 +691,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) { @@ -663,10 +703,10 @@ public virtual Task GetComponentTemplateAsync(Acti /// /// - /// Returns cluster-wide settings. + /// Get 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) @@ -677,10 +717,10 @@ public virtual GetClusterSettingsResponse GetSettings(GetClusterSettingsRequest /// /// - /// Returns cluster-wide settings. + /// Get 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) { @@ -690,10 +730,10 @@ public virtual Task GetSettingsAsync(GetClusterSetti /// /// - /// Returns cluster-wide settings. + /// Get 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) @@ -704,10 +744,10 @@ public virtual GetClusterSettingsResponse GetSettings(GetClusterSettingsRequestD /// /// - /// Returns cluster-wide settings. + /// Get 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() @@ -719,10 +759,10 @@ public virtual GetClusterSettingsResponse GetSettings() /// /// - /// Returns cluster-wide settings. + /// Get 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) @@ -735,10 +775,10 @@ public virtual GetClusterSettingsResponse GetSettings(Action /// - /// Returns cluster-wide settings. + /// Get 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) { @@ -748,10 +788,10 @@ public virtual Task GetSettingsAsync(GetClusterSetti /// /// - /// Returns cluster-wide settings. + /// Get 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) { @@ -762,10 +802,10 @@ public virtual Task GetSettingsAsync(CancellationTok /// /// - /// Returns cluster-wide settings. + /// Get 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) { @@ -777,10 +817,20 @@ public virtual Task GetSettingsAsync(Action /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. - /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// Get the cluster health status. + /// 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. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(HealthRequest request) @@ -791,10 +841,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// 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) { @@ -804,10 +864,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(HealthRequestDescriptor descriptor) @@ -818,10 +888,20 @@ public virtual HealthResponse Health(HealthRequestDescriptor /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. - /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// Get the cluster health status. + /// 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. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.Indices? indices) @@ -833,10 +913,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// 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) @@ -849,10 +939,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// 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() @@ -864,10 +964,20 @@ 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. + /// Get the cluster health status. + /// 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. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(Action> configureRequest) @@ -880,10 +990,20 @@ public virtual HealthResponse Health(Action /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. - /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// Get the cluster health status. + /// 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. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(HealthRequestDescriptor descriptor) @@ -894,10 +1014,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.Indices? indices) @@ -909,10 +1039,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] public virtual HealthResponse Health(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest) @@ -925,10 +1065,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// 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() @@ -940,10 +1090,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// 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) @@ -956,10 +1116,20 @@ 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. + /// Get the cluster health status. + /// 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. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(HealthRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -969,10 +1139,20 @@ 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. + /// Get the cluster health status. + /// 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. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) { @@ -983,10 +1163,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// 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) { @@ -998,10 +1188,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(CancellationToken cancellationToken = default) { @@ -1012,10 +1212,20 @@ 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. + /// Get the cluster health status. + /// 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. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Action> configureRequest, CancellationToken cancellationToken = default) { @@ -1027,10 +1237,20 @@ public virtual Task HealthAsync(Action /// - /// The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. - /// The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// 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) { @@ -1040,10 +1260,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// 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) { @@ -1054,10 +1284,20 @@ 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. + /// Get the cluster health status. + /// 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. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -1069,10 +1309,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. + /// + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// 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) { @@ -1083,10 +1333,20 @@ 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. + /// Get the cluster health status. + /// 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. Green means that all shards are allocated. + /// The index level status is controlled by the worst shard status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + /// The cluster status is controlled by the worst index status. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task HealthAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -1101,7 +1361,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 +1375,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 +1388,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 +1402,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 +1417,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 +1433,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 +1446,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 +1460,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) { @@ -1212,12 +1472,15 @@ public virtual Task InfoAsync(IReadOnlyCollection /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// Get the pending cluster tasks. + /// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + /// + /// /// NOTE: This API returns a list of any pending updates to the cluster state. - /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// 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(PendingTasksRequest request) @@ -1228,12 +1491,15 @@ public virtual PendingTasksResponse PendingTasks(PendingTasksRequest request) /// /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// Get the pending cluster tasks. + /// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + /// + /// /// NOTE: This API returns a list of any pending updates to the cluster state. - /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// 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) { @@ -1243,12 +1509,15 @@ public virtual Task PendingTasksAsync(PendingTasksRequest /// /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// Get the pending cluster tasks. + /// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + /// + /// /// NOTE: This API returns a list of any pending updates to the cluster state. - /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// 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) @@ -1259,12 +1528,15 @@ public virtual PendingTasksResponse PendingTasks(PendingTasksRequestDescriptor d /// /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// Get the pending cluster tasks. + /// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + /// + /// /// NOTE: This API returns a list of any pending updates to the cluster state. - /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// 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() @@ -1276,12 +1548,15 @@ public virtual PendingTasksResponse PendingTasks() /// /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// Get the pending cluster tasks. + /// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + /// + /// /// NOTE: This API returns a list of any pending updates to the cluster state. - /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// 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) @@ -1294,12 +1569,15 @@ public virtual PendingTasksResponse PendingTasks(Action /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// Get the pending cluster tasks. + /// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + /// + /// /// NOTE: This API returns a list of any pending updates to the cluster state. - /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// 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) { @@ -1309,12 +1587,15 @@ public virtual Task PendingTasksAsync(PendingTasksRequestD /// /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// Get the pending cluster tasks. + /// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + /// + /// /// NOTE: This API returns a list of any pending updates to the cluster state. - /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// 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) { @@ -1325,12 +1606,15 @@ public virtual Task PendingTasksAsync(CancellationToken ca /// /// - /// Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. + /// Get the pending cluster tasks. + /// Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + /// + /// /// NOTE: This API returns a list of any pending updates to the cluster state. - /// These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + /// 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) { @@ -1342,9 +1626,29 @@ public virtual Task PendingTasksAsync(Action /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// Update voting configuration exclusions. + /// Update the cluster voting config exclusions by node IDs or node names. + /// By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. + /// If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. + /// The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. + /// It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Clusters should have no voting configuration exclusions in normal operation. + /// Once the excluded nodes have stopped, clear the voting configuration exclusions with DELETE /_cluster/voting_config_exclusions. + /// This API waits for the nodes to be fully removed from the cluster before it returns. + /// If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use DELETE /_cluster/voting_config_exclusions?wait_for_removal=false to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. + /// + /// + /// A response to POST /_cluster/voting_config_exclusions with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling DELETE /_cluster/voting_config_exclusions. + /// If the call to POST /_cluster/voting_config_exclusions fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. + /// In that case, you may safely retry the call. + /// + /// + /// NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. + /// They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. + /// + /// 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) @@ -1355,9 +1659,29 @@ public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions(Pos /// /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// Update voting configuration exclusions. + /// Update the cluster voting config exclusions by node IDs or node names. + /// By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. + /// If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. + /// The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. + /// It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. + /// + /// + /// Clusters should have no voting configuration exclusions in normal operation. + /// Once the excluded nodes have stopped, clear the voting configuration exclusions with DELETE /_cluster/voting_config_exclusions. + /// This API waits for the nodes to be fully removed from the cluster before it returns. + /// If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use DELETE /_cluster/voting_config_exclusions?wait_for_removal=false to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. + /// + /// + /// A response to POST /_cluster/voting_config_exclusions with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling DELETE /_cluster/voting_config_exclusions. + /// If the call to POST /_cluster/voting_config_exclusions fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. + /// In that case, you may safely retry the call. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. + /// They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostVotingConfigExclusionsAsync(PostVotingConfigExclusionsRequest request, CancellationToken cancellationToken = default) { @@ -1367,9 +1691,29 @@ public virtual Task PostVotingConfigExclusio /// /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// Update voting configuration exclusions. + /// Update the cluster voting config exclusions by node IDs or node names. + /// By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. + /// If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. + /// The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. + /// It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. + /// + /// + /// Clusters should have no voting configuration exclusions in normal operation. + /// Once the excluded nodes have stopped, clear the voting configuration exclusions with DELETE /_cluster/voting_config_exclusions. + /// This API waits for the nodes to be fully removed from the cluster before it returns. + /// If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use DELETE /_cluster/voting_config_exclusions?wait_for_removal=false to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. + /// + /// + /// A response to POST /_cluster/voting_config_exclusions with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling DELETE /_cluster/voting_config_exclusions. + /// If the call to POST /_cluster/voting_config_exclusions fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. + /// In that case, you may safely retry the call. + /// + /// + /// NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. + /// They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1380,9 +1724,29 @@ public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions(Pos /// /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// Update voting configuration exclusions. + /// Update the cluster voting config exclusions by node IDs or node names. + /// By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. + /// If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. + /// The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. + /// It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. + /// + /// + /// Clusters should have no voting configuration exclusions in normal operation. + /// Once the excluded nodes have stopped, clear the voting configuration exclusions with DELETE /_cluster/voting_config_exclusions. + /// This API waits for the nodes to be fully removed from the cluster before it returns. + /// If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use DELETE /_cluster/voting_config_exclusions?wait_for_removal=false to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A response to POST /_cluster/voting_config_exclusions with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling DELETE /_cluster/voting_config_exclusions. + /// If the call to POST /_cluster/voting_config_exclusions fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. + /// In that case, you may safely retry the call. + /// + /// + /// NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. + /// They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. + /// + /// 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() @@ -1394,9 +1758,29 @@ public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions() /// /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// Update voting configuration exclusions. + /// Update the cluster voting config exclusions by node IDs or node names. + /// By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. + /// If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. + /// The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. + /// It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. + /// + /// + /// Clusters should have no voting configuration exclusions in normal operation. + /// Once the excluded nodes have stopped, clear the voting configuration exclusions with DELETE /_cluster/voting_config_exclusions. + /// This API waits for the nodes to be fully removed from the cluster before it returns. + /// If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use DELETE /_cluster/voting_config_exclusions?wait_for_removal=false to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. + /// + /// + /// A response to POST /_cluster/voting_config_exclusions with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling DELETE /_cluster/voting_config_exclusions. + /// If the call to POST /_cluster/voting_config_exclusions fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. + /// In that case, you may safely retry the call. + /// + /// + /// NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. + /// They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1409,9 +1793,29 @@ public virtual PostVotingConfigExclusionsResponse PostVotingConfigExclusions(Act /// /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// Update voting configuration exclusions. + /// Update the cluster voting config exclusions by node IDs or node names. + /// By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. + /// If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. + /// The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. + /// It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. + /// + /// + /// Clusters should have no voting configuration exclusions in normal operation. + /// Once the excluded nodes have stopped, clear the voting configuration exclusions with DELETE /_cluster/voting_config_exclusions. + /// This API waits for the nodes to be fully removed from the cluster before it returns. + /// If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use DELETE /_cluster/voting_config_exclusions?wait_for_removal=false to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. + /// + /// + /// A response to POST /_cluster/voting_config_exclusions with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling DELETE /_cluster/voting_config_exclusions. + /// If the call to POST /_cluster/voting_config_exclusions fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. + /// In that case, you may safely retry the call. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. + /// They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostVotingConfigExclusionsAsync(PostVotingConfigExclusionsRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1421,9 +1825,29 @@ public virtual Task PostVotingConfigExclusio /// /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// Update voting configuration exclusions. + /// Update the cluster voting config exclusions by node IDs or node names. + /// By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. + /// If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. + /// The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. + /// It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// Clusters should have no voting configuration exclusions in normal operation. + /// Once the excluded nodes have stopped, clear the voting configuration exclusions with DELETE /_cluster/voting_config_exclusions. + /// This API waits for the nodes to be fully removed from the cluster before it returns. + /// If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use DELETE /_cluster/voting_config_exclusions?wait_for_removal=false to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. + /// + /// + /// A response to POST /_cluster/voting_config_exclusions with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling DELETE /_cluster/voting_config_exclusions. + /// If the call to POST /_cluster/voting_config_exclusions fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. + /// In that case, you may safely retry the call. + /// + /// + /// NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. + /// They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task PostVotingConfigExclusionsAsync(CancellationToken cancellationToken = default) { @@ -1434,9 +1858,29 @@ public virtual Task PostVotingConfigExclusio /// /// - /// Updates the cluster voting config exclusions by node ids or node names. + /// Update voting configuration exclusions. + /// Update the cluster voting config exclusions by node IDs or node names. + /// By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. + /// If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. + /// The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. + /// It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. + /// + /// + /// Clusters should have no voting configuration exclusions in normal operation. + /// Once the excluded nodes have stopped, clear the voting configuration exclusions with DELETE /_cluster/voting_config_exclusions. + /// This API waits for the nodes to be fully removed from the cluster before it returns. + /// If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use DELETE /_cluster/voting_config_exclusions?wait_for_removal=false to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. + /// + /// + /// A response to POST /_cluster/voting_config_exclusions with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling DELETE /_cluster/voting_config_exclusions. + /// If the call to POST /_cluster/voting_config_exclusions fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. + /// In that case, you may safely retry the call. + /// + /// + /// NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. + /// They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. /// - /// 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 +1913,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 +1945,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 +1976,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 +2008,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 +2041,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 +2075,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 +2107,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 +2140,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 +2174,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 +2205,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 +2237,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 +2270,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 +2301,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 +2333,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) { @@ -1901,10 +2345,10 @@ public virtual Task PutComponentTemplateAsync(Elas /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) @@ -1915,10 +2359,10 @@ public virtual ClusterStatsResponse Stats(ClusterStatsRequest request) /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) { @@ -1928,10 +2372,10 @@ public virtual Task StatsAsync(ClusterStatsRequest request /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) @@ -1942,10 +2386,10 @@ public virtual ClusterStatsResponse Stats(ClusterStatsRequestDescriptor descript /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) @@ -1957,10 +2401,10 @@ public virtual ClusterStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) @@ -1973,10 +2417,10 @@ public virtual ClusterStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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() @@ -1988,10 +2432,10 @@ public virtual ClusterStatsResponse Stats() /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) @@ -2004,10 +2448,10 @@ public virtual ClusterStatsResponse Stats(Action /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) { @@ -2017,10 +2461,10 @@ public virtual Task StatsAsync(ClusterStatsRequestDescript /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) { @@ -2031,10 +2475,10 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) { @@ -2046,10 +2490,10 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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) { @@ -2060,10 +2504,10 @@ public virtual Task StatsAsync(CancellationToken cancellat /// /// - /// Returns cluster statistics. - /// It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). + /// Get cluster statistics. + /// Get 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 f4bed190814..544af02adfa 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 cbb8fa9e435..7884181a8ee 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Enrich.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Enrich.g.cs @@ -155,9 +155,10 @@ public virtual Task DeletePolicyAsync(Elastic.Clients.Elas /// /// - /// Creates the enrich index for an existing enrich policy. + /// Run an enrich policy. + /// Create 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) @@ -168,9 +169,10 @@ public virtual ExecutePolicyResponse ExecutePolicy(ExecutePolicyRequest request) /// /// - /// Creates the enrich index for an existing enrich policy. + /// Run an enrich policy. + /// Create 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) { @@ -180,9 +182,10 @@ public virtual Task ExecutePolicyAsync(ExecutePolicyReque /// /// - /// Creates the enrich index for an existing enrich policy. + /// Run an enrich policy. + /// Create 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) @@ -193,9 +196,10 @@ public virtual ExecutePolicyResponse ExecutePolicy(ExecutePolicyRequestDescripto /// /// - /// Creates the enrich index for an existing enrich policy. + /// Run an enrich policy. + /// Create 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) @@ -207,9 +211,10 @@ public virtual ExecutePolicyResponse ExecutePolicy(Elastic.Clients.Elasticsearch /// /// - /// Creates the enrich index for an existing enrich policy. + /// Run an enrich policy. + /// Create 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) @@ -222,9 +227,10 @@ public virtual ExecutePolicyResponse ExecutePolicy(Elastic.Clients.Elasticsearch /// /// - /// Creates the enrich index for an existing enrich policy. + /// Run an enrich policy. + /// Create 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) { @@ -234,9 +240,10 @@ public virtual Task ExecutePolicyAsync(ExecutePolicyReque /// /// - /// Creates the enrich index for an existing enrich policy. + /// Run an enrich policy. + /// Create 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) { @@ -247,9 +254,10 @@ public virtual Task ExecutePolicyAsync(Elastic.Clients.El /// /// - /// Creates the enrich index for an existing enrich policy. + /// Run an enrich policy. + /// Create 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 +446,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 +460,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 +473,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 +487,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 +502,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 +518,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 +532,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 +547,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 +563,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 +576,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 +590,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 +605,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 +618,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 +632,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 288fe04ee8c..22475255bd0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Eql.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Eql.g.cs @@ -41,7 +41,8 @@ internal EqlNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -55,7 +56,8 @@ public virtual EqlDeleteResponse Delete(EqlDeleteRequest request) /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -68,7 +70,8 @@ public virtual Task DeleteAsync(EqlDeleteRequest request, Can /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -82,7 +85,8 @@ public virtual EqlDeleteResponse Delete(EqlDeleteRequestDescriptor /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -97,7 +101,8 @@ public virtual EqlDeleteResponse Delete(Elastic.Clients.Elasticsearch /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -113,7 +118,8 @@ public virtual EqlDeleteResponse Delete(Elastic.Clients.Elasticsearch /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -127,7 +133,8 @@ public virtual EqlDeleteResponse Delete(EqlDeleteRequestDescriptor descriptor) /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -142,7 +149,8 @@ public virtual EqlDeleteResponse Delete(Elastic.Clients.Elasticsearch.Id id) /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -158,7 +166,8 @@ public virtual EqlDeleteResponse Delete(Elastic.Clients.Elasticsearch.Id id, Act /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -171,7 +180,8 @@ public virtual Task DeleteAsync(EqlDeleteRequestDe /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -185,7 +195,8 @@ public virtual Task DeleteAsync(Elastic.Clients.El /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -200,7 +211,8 @@ public virtual Task DeleteAsync(Elastic.Clients.El /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -213,7 +225,8 @@ public virtual Task DeleteAsync(EqlDeleteRequestDescriptor de /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -227,7 +240,8 @@ public virtual Task DeleteAsync(Elastic.Clients.Elasticsearch /// /// - /// Deletes an async EQL search or a stored synchronous EQL search. + /// Delete an async EQL search. + /// Delete an async EQL search or a stored synchronous EQL search. /// The API also deletes results for the search. /// /// Learn more about this API in the Elasticsearch documentation. @@ -242,9 +256,10 @@ 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. + /// Get async EQL search results. + /// Get 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) @@ -255,9 +270,10 @@ public virtual EqlGetResponse Get(EqlGetRequest request) /// /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// Get async EQL search results. + /// Get 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) { @@ -267,9 +283,10 @@ public virtual Task> GetAsync(EqlGetRequest reque /// /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// Get async EQL search results. + /// Get 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) @@ -280,9 +297,10 @@ public virtual EqlGetResponse Get(EqlGetRequestDescriptor /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// Get async EQL search results. + /// Get 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) @@ -294,9 +312,10 @@ 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. + /// Get async EQL search results. + /// Get 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) @@ -309,9 +328,10 @@ 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. + /// Get async EQL search results. + /// Get 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) { @@ -321,9 +341,10 @@ public virtual Task> GetAsync(EqlGetRequestDescri /// /// - /// Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + /// Get async EQL search results. + /// Get 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) { @@ -334,9 +355,10 @@ 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. + /// Get async EQL search results. + /// Get 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) { @@ -348,9 +370,10 @@ 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. + /// Get the async EQL status. + /// Get 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) @@ -361,9 +384,10 @@ public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequest request) /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) { @@ -373,9 +397,10 @@ public virtual Task GetStatusAsync(GetEqlStatusRequest req /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) @@ -386,9 +411,10 @@ public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequestDesc /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) @@ -400,9 +426,10 @@ 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. + /// Get the async EQL status. + /// Get 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) @@ -415,9 +442,10 @@ 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. + /// Get the async EQL status. + /// Get 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) @@ -428,9 +456,10 @@ public virtual GetEqlStatusResponse GetStatus(GetEqlStatusRequestDescriptor desc /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) @@ -442,9 +471,10 @@ 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. + /// Get the async EQL status. + /// Get 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) @@ -457,9 +487,10 @@ 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. + /// Get the async EQL status. + /// Get 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) { @@ -469,9 +500,10 @@ public virtual Task GetStatusAsync(GetEqlStatus /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) { @@ -482,9 +514,10 @@ public virtual Task GetStatusAsync(Elastic.Clie /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) { @@ -496,9 +529,10 @@ public virtual Task GetStatusAsync(Elastic.Clie /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) { @@ -508,9 +542,10 @@ public virtual Task GetStatusAsync(GetEqlStatusRequestDesc /// /// - /// Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + /// Get the async EQL status. + /// Get 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) { @@ -521,9 +556,10 @@ 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. + /// Get the async EQL status. + /// Get 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) { @@ -535,7 +571,9 @@ public virtual Task GetStatusAsync(Elastic.Clients.Elastic /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -548,7 +586,9 @@ public virtual EqlSearchResponse Search(EqlSearchRequest request /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -560,7 +600,9 @@ public virtual Task> SearchAsync(EqlSearchRequ /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -573,7 +615,9 @@ public virtual EqlSearchResponse Search(EqlSearchRequestDescript /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -587,7 +631,9 @@ public virtual EqlSearchResponse Search(Elastic.Clients.Elastics /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -602,7 +648,9 @@ public virtual EqlSearchResponse Search(Elastic.Clients.Elastics /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -616,7 +664,9 @@ public virtual EqlSearchResponse Search() /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -631,7 +681,9 @@ public virtual EqlSearchResponse Search(Action /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -643,7 +695,9 @@ public virtual Task> SearchAsync(EqlSearchRequ /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -656,7 +710,9 @@ public virtual Task> SearchAsync(Elastic.Clien /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -670,7 +726,9 @@ public virtual Task> SearchAsync(Elastic.Clien /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -683,7 +741,9 @@ public virtual Task> SearchAsync(CancellationT /// /// - /// Returns results matching a query expressed in Event Query Language (EQL) + /// Get EQL search results. + /// Returns search results for an Event Query Language (EQL) query. + /// EQL assumes each document in a data stream or index corresponds to an event. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 c0957362790..53ae4b23514 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Esql.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Esql.g.cs @@ -41,9 +41,10 @@ internal EsqlNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// Learn more about this API in the Elasticsearch 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) @@ -54,9 +55,10 @@ public virtual EsqlQueryResponse Query(EsqlQueryRequest request) /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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) { @@ -66,9 +68,10 @@ public virtual Task QueryAsync(EsqlQueryRequest request, Canc /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// Learn more about this API in the Elasticsearch 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) @@ -79,9 +82,10 @@ public virtual EsqlQueryResponse Query(EsqlQueryRequestDescriptor /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// Learn more about this API in the Elasticsearch 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() @@ -93,9 +97,10 @@ public virtual EsqlQueryResponse Query() /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// Learn more about this API in the Elasticsearch 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) @@ -108,9 +113,10 @@ public virtual EsqlQueryResponse Query(Action /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// Learn more about this API in the Elasticsearch 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) @@ -121,9 +127,10 @@ public virtual EsqlQueryResponse Query(EsqlQueryRequestDescriptor descriptor) /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// Learn more about this API in the Elasticsearch 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() @@ -135,9 +142,10 @@ public virtual EsqlQueryResponse Query() /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// Learn more about this API in the Elasticsearch 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) @@ -150,9 +158,10 @@ public virtual EsqlQueryResponse Query(Action config /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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) { @@ -162,9 +171,10 @@ public virtual Task QueryAsync(EsqlQueryRequestDes /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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) { @@ -175,9 +185,10 @@ public virtual Task QueryAsync(CancellationToken c /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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) { @@ -189,9 +200,10 @@ public virtual Task QueryAsync(Action /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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) { @@ -201,9 +213,10 @@ public virtual Task QueryAsync(EsqlQueryRequestDescriptor des /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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) { @@ -214,9 +227,10 @@ public virtual Task QueryAsync(CancellationToken cancellation /// /// - /// Executes an ES|QL request + /// Run an ES|QL query. + /// Get search results for an ES|QL (Elasticsearch query language) query. /// - /// 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.Features.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Features.g.cs index bc25559f2d8..03bfacd5777 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Features.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Features.g.cs @@ -41,7 +41,18 @@ internal FeaturesNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// Get the features. + /// Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. + /// You can use this API to determine which feature states to include when taking a snapshot. + /// By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. + /// + /// + /// A feature state includes one or more system indices necessary for a given feature to function. + /// In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. + /// + /// + /// The features listed by this API are a combination of built-in features and features defined by plugins. + /// In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +65,18 @@ public virtual GetFeaturesResponse GetFeatures(GetFeaturesRequest request) /// /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// Get the features. + /// Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. + /// You can use this API to determine which feature states to include when taking a snapshot. + /// By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. + /// + /// + /// A feature state includes one or more system indices necessary for a given feature to function. + /// In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. + /// + /// + /// The features listed by this API are a combination of built-in features and features defined by plugins. + /// In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +88,18 @@ public virtual Task GetFeaturesAsync(GetFeaturesRequest req /// /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// Get the features. + /// Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. + /// You can use this API to determine which feature states to include when taking a snapshot. + /// By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. + /// + /// + /// A feature state includes one or more system indices necessary for a given feature to function. + /// In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. + /// + /// + /// The features listed by this API are a combination of built-in features and features defined by plugins. + /// In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +112,18 @@ public virtual GetFeaturesResponse GetFeatures(GetFeaturesRequestDescriptor desc /// /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// Get the features. + /// Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. + /// You can use this API to determine which feature states to include when taking a snapshot. + /// By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. + /// + /// + /// A feature state includes one or more system indices necessary for a given feature to function. + /// In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. + /// + /// + /// The features listed by this API are a combination of built-in features and features defined by plugins. + /// In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +137,18 @@ public virtual GetFeaturesResponse GetFeatures() /// /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// Get the features. + /// Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. + /// You can use this API to determine which feature states to include when taking a snapshot. + /// By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. + /// + /// + /// A feature state includes one or more system indices necessary for a given feature to function. + /// In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. + /// + /// + /// The features listed by this API are a combination of built-in features and features defined by plugins. + /// In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +163,18 @@ public virtual GetFeaturesResponse GetFeatures(Action /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// Get the features. + /// Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. + /// You can use this API to determine which feature states to include when taking a snapshot. + /// By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. + /// + /// + /// A feature state includes one or more system indices necessary for a given feature to function. + /// In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. + /// + /// + /// The features listed by this API are a combination of built-in features and features defined by plugins. + /// In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -120,7 +186,18 @@ public virtual Task GetFeaturesAsync(GetFeaturesRequestDesc /// /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// Get the features. + /// Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. + /// You can use this API to determine which feature states to include when taking a snapshot. + /// By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. + /// + /// + /// A feature state includes one or more system indices necessary for a given feature to function. + /// In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. + /// + /// + /// The features listed by this API are a combination of built-in features and features defined by plugins. + /// In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -133,7 +210,18 @@ public virtual Task GetFeaturesAsync(CancellationToken canc /// /// - /// Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + /// Get the features. + /// Get a list of features that can be included in snapshots using the feature_states field when creating a snapshot. + /// You can use this API to determine which feature states to include when taking a snapshot. + /// By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. + /// + /// + /// A feature state includes one or more system indices necessary for a given feature to function. + /// In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. + /// + /// + /// The features listed by this API are a combination of built-in features and features defined by plugins. + /// In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -147,7 +235,29 @@ public virtual Task GetFeaturesAsync(Action /// - /// Resets the internal state of features, usually by deleting system indices + /// Reset the features. + /// Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. + /// + /// + /// WARNING: Intended for development and testing use only. Do not reset features on a production cluster. + /// + /// + /// Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. + /// This deletes all state information stored in system indices. + /// + /// + /// The response code is HTTP 200 if the state is successfully reset for all features. + /// It is HTTP 500 if the reset operation failed for any feature. + /// + /// + /// Note that select features might provide a way to reset particular system indices. + /// Using this API resets all features, both those that are built-in and implemented as plugins. + /// + /// + /// To list the features that will be affected, use the get features API. + /// + /// + /// IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -160,7 +270,29 @@ public virtual ResetFeaturesResponse ResetFeatures(ResetFeaturesRequest request) /// /// - /// Resets the internal state of features, usually by deleting system indices + /// Reset the features. + /// Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. + /// + /// + /// WARNING: Intended for development and testing use only. Do not reset features on a production cluster. + /// + /// + /// Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. + /// This deletes all state information stored in system indices. + /// + /// + /// The response code is HTTP 200 if the state is successfully reset for all features. + /// It is HTTP 500 if the reset operation failed for any feature. + /// + /// + /// Note that select features might provide a way to reset particular system indices. + /// Using this API resets all features, both those that are built-in and implemented as plugins. + /// + /// + /// To list the features that will be affected, use the get features API. + /// + /// + /// IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -172,7 +304,29 @@ public virtual Task ResetFeaturesAsync(ResetFeaturesReque /// /// - /// Resets the internal state of features, usually by deleting system indices + /// Reset the features. + /// Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. + /// + /// + /// WARNING: Intended for development and testing use only. Do not reset features on a production cluster. + /// + /// + /// Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. + /// This deletes all state information stored in system indices. + /// + /// + /// The response code is HTTP 200 if the state is successfully reset for all features. + /// It is HTTP 500 if the reset operation failed for any feature. + /// + /// + /// Note that select features might provide a way to reset particular system indices. + /// Using this API resets all features, both those that are built-in and implemented as plugins. + /// + /// + /// To list the features that will be affected, use the get features API. + /// + /// + /// IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -185,7 +339,29 @@ public virtual ResetFeaturesResponse ResetFeatures(ResetFeaturesRequestDescripto /// /// - /// Resets the internal state of features, usually by deleting system indices + /// Reset the features. + /// Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. + /// + /// + /// WARNING: Intended for development and testing use only. Do not reset features on a production cluster. + /// + /// + /// Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. + /// This deletes all state information stored in system indices. + /// + /// + /// The response code is HTTP 200 if the state is successfully reset for all features. + /// It is HTTP 500 if the reset operation failed for any feature. + /// + /// + /// Note that select features might provide a way to reset particular system indices. + /// Using this API resets all features, both those that are built-in and implemented as plugins. + /// + /// + /// To list the features that will be affected, use the get features API. + /// + /// + /// IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -199,7 +375,29 @@ public virtual ResetFeaturesResponse ResetFeatures() /// /// - /// Resets the internal state of features, usually by deleting system indices + /// Reset the features. + /// Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. + /// + /// + /// WARNING: Intended for development and testing use only. Do not reset features on a production cluster. + /// + /// + /// Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. + /// This deletes all state information stored in system indices. + /// + /// + /// The response code is HTTP 200 if the state is successfully reset for all features. + /// It is HTTP 500 if the reset operation failed for any feature. + /// + /// + /// Note that select features might provide a way to reset particular system indices. + /// Using this API resets all features, both those that are built-in and implemented as plugins. + /// + /// + /// To list the features that will be affected, use the get features API. + /// + /// + /// IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -214,7 +412,29 @@ public virtual ResetFeaturesResponse ResetFeatures(Action /// - /// Resets the internal state of features, usually by deleting system indices + /// Reset the features. + /// Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. + /// + /// + /// WARNING: Intended for development and testing use only. Do not reset features on a production cluster. + /// + /// + /// Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. + /// This deletes all state information stored in system indices. + /// + /// + /// The response code is HTTP 200 if the state is successfully reset for all features. + /// It is HTTP 500 if the reset operation failed for any feature. + /// + /// + /// Note that select features might provide a way to reset particular system indices. + /// Using this API resets all features, both those that are built-in and implemented as plugins. + /// + /// + /// To list the features that will be affected, use the get features API. + /// + /// + /// IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -226,7 +446,29 @@ public virtual Task ResetFeaturesAsync(ResetFeaturesReque /// /// - /// Resets the internal state of features, usually by deleting system indices + /// Reset the features. + /// Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. + /// + /// + /// WARNING: Intended for development and testing use only. Do not reset features on a production cluster. + /// + /// + /// Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. + /// This deletes all state information stored in system indices. + /// + /// + /// The response code is HTTP 200 if the state is successfully reset for all features. + /// It is HTTP 500 if the reset operation failed for any feature. + /// + /// + /// Note that select features might provide a way to reset particular system indices. + /// Using this API resets all features, both those that are built-in and implemented as plugins. + /// + /// + /// To list the features that will be affected, use the get features API. + /// + /// + /// IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -239,7 +481,29 @@ public virtual Task ResetFeaturesAsync(CancellationToken /// /// - /// Resets the internal state of features, usually by deleting system indices + /// Reset the features. + /// Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. + /// + /// + /// WARNING: Intended for development and testing use only. Do not reset features on a production cluster. + /// + /// + /// Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. + /// This deletes all state information stored in system indices. + /// + /// + /// The response code is HTTP 200 if the state is successfully reset for all features. + /// It is HTTP 500 if the reset operation failed for any feature. + /// + /// + /// Note that select features might provide a way to reset particular system indices. + /// Using this API resets all features, both those that are built-in and implemented as plugins. + /// + /// + /// To list the features that will be affected, use the get features API. + /// + /// + /// IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 81edb557a37..39ec68a30d6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Graph.g.cs @@ -41,9 +41,14 @@ internal GraphNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// Learn more about this API in the Elasticsearch 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) @@ -54,9 +59,14 @@ public virtual ExploreResponse Explore(ExploreRequest request) /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -66,9 +76,14 @@ public virtual Task ExploreAsync(ExploreRequest request, Cancel /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// Learn more about this API in the Elasticsearch 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) @@ -79,9 +94,14 @@ public virtual ExploreResponse Explore(ExploreRequestDescriptor /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// Learn more about this API in the Elasticsearch 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) @@ -93,9 +113,14 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch. /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// Learn more about this API in the Elasticsearch 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) @@ -108,9 +133,14 @@ public virtual ExploreResponse Explore(Elastic.Clients.Elasticsearch. /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// Learn more about this API in the Elasticsearch 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() @@ -122,9 +152,14 @@ public virtual ExploreResponse Explore() /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// Learn more about this API in the Elasticsearch 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) @@ -137,9 +172,14 @@ public virtual ExploreResponse Explore(Action /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// Learn more about this API in the Elasticsearch 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) @@ -150,9 +190,14 @@ public virtual ExploreResponse Explore(ExploreRequestDescriptor descriptor) /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// Learn more about this API in the Elasticsearch 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) @@ -164,9 +209,14 @@ 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. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// Learn more about this API in the Elasticsearch 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) @@ -179,9 +229,14 @@ 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. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -191,9 +246,14 @@ public virtual Task ExploreAsync(ExploreRequestDescr /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -204,9 +264,14 @@ public virtual Task ExploreAsync(Elastic.Clients.Ela /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -218,9 +283,14 @@ public virtual Task ExploreAsync(Elastic.Clients.Ela /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -231,9 +301,14 @@ public virtual Task ExploreAsync(CancellationToken c /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -245,9 +320,14 @@ public virtual Task ExploreAsync(Action /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -257,9 +337,14 @@ public virtual Task ExploreAsync(ExploreRequestDescriptor descr /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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) { @@ -270,9 +355,14 @@ public virtual Task ExploreAsync(Elastic.Clients.Elasticsearch. /// /// - /// Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index. + /// Explore graph analytics. + /// Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + /// The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + /// An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + /// Subsequent requests enable you to spider out from one more vertices of interest. + /// You can exclude vertices that have already been returned. /// - /// 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.Ilm.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ilm.g.cs index 9088cb19413..0b4267d04ba 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ilm.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ilm.g.cs @@ -41,7 +41,8 @@ internal IndexLifecycleManagementNamespacedClient(ElasticsearchClient client) : /// /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// Delete a lifecycle policy. + /// You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +55,8 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(DeleteLifecycleRequest re /// /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// Delete a lifecycle policy. + /// You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +68,8 @@ public virtual Task DeleteLifecycleAsync(DeleteLifecycl /// /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// Delete a lifecycle policy. + /// You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +82,8 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(DeleteLifecycleRequestDes /// /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// Delete a lifecycle policy. + /// You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +97,8 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(Elastic.Clients.Elasticse /// /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// Delete a lifecycle policy. + /// You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +113,8 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(Elastic.Clients.Elasticse /// /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// Delete a lifecycle policy. + /// You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -120,7 +126,8 @@ public virtual Task DeleteLifecycleAsync(DeleteLifecycl /// /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// Delete a lifecycle policy. + /// You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -133,7 +140,8 @@ public virtual Task DeleteLifecycleAsync(Elastic.Client /// /// - /// Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. + /// Delete a lifecycle policy. + /// You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -147,7 +155,7 @@ public virtual Task DeleteLifecycleAsync(Elastic.Client /// /// - /// Retrieves a lifecycle policy. + /// Get lifecycle policies. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -160,7 +168,7 @@ public virtual GetLifecycleResponse GetLifecycle(GetLifecycleRequest request) /// /// - /// Retrieves a lifecycle policy. + /// Get lifecycle policies. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -172,7 +180,7 @@ public virtual Task GetLifecycleAsync(GetLifecycleRequest /// /// - /// Retrieves a lifecycle policy. + /// Get lifecycle policies. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -185,7 +193,7 @@ public virtual GetLifecycleResponse GetLifecycle(GetLifecycleRequestDescriptor d /// /// - /// Retrieves a lifecycle policy. + /// Get lifecycle policies. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -199,7 +207,7 @@ public virtual GetLifecycleResponse GetLifecycle(Elastic.Clients.Elasticsearch.N /// /// - /// Retrieves a lifecycle policy. + /// Get lifecycle policies. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -214,7 +222,7 @@ public virtual GetLifecycleResponse GetLifecycle(Elastic.Clients.Elasticsearch.N /// /// - /// Retrieves a lifecycle policy. + /// Get lifecycle policies. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -228,7 +236,7 @@ public virtual GetLifecycleResponse GetLifecycle() /// /// - /// Retrieves a lifecycle policy. + /// Get lifecycle policies. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -243,7 +251,7 @@ public virtual GetLifecycleResponse GetLifecycle(Action /// - /// Retrieves a lifecycle policy. + /// Get lifecycle policies. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -255,7 +263,7 @@ public virtual Task GetLifecycleAsync(GetLifecycleRequestD /// /// - /// Retrieves a lifecycle policy. + /// Get lifecycle policies. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -268,7 +276,7 @@ public virtual Task GetLifecycleAsync(Elastic.Clients.Elas /// /// - /// Retrieves a lifecycle policy. + /// Get lifecycle policies. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -282,7 +290,7 @@ public virtual Task GetLifecycleAsync(Elastic.Clients.Elas /// /// - /// Retrieves a lifecycle policy. + /// Get lifecycle policies. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -295,7 +303,7 @@ public virtual Task GetLifecycleAsync(CancellationToken ca /// /// - /// Retrieves a lifecycle policy. + /// Get lifecycle policies. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -309,7 +317,8 @@ public virtual Task GetLifecycleAsync(Action /// - /// Retrieves the current index lifecycle management (ILM) status. + /// Get the ILM status. + /// Get the current index lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -322,7 +331,8 @@ public virtual GetIlmStatusResponse GetStatus(GetIlmStatusRequest request) /// /// - /// Retrieves the current index lifecycle management (ILM) status. + /// Get the ILM status. + /// Get the current index lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -334,7 +344,8 @@ public virtual Task GetStatusAsync(GetIlmStatusRequest req /// /// - /// Retrieves the current index lifecycle management (ILM) status. + /// Get the ILM status. + /// Get the current index lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -347,7 +358,8 @@ public virtual GetIlmStatusResponse GetStatus(GetIlmStatusRequestDescriptor desc /// /// - /// Retrieves the current index lifecycle management (ILM) status. + /// Get the ILM status. + /// Get the current index lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -361,7 +373,8 @@ public virtual GetIlmStatusResponse GetStatus() /// /// - /// Retrieves the current index lifecycle management (ILM) status. + /// Get the ILM status. + /// Get the current index lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -376,7 +389,8 @@ public virtual GetIlmStatusResponse GetStatus(Action /// - /// Retrieves the current index lifecycle management (ILM) status. + /// Get the ILM status. + /// Get the current index lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -388,7 +402,8 @@ public virtual Task GetStatusAsync(GetIlmStatusRequestDesc /// /// - /// Retrieves the current index lifecycle management (ILM) status. + /// Get the ILM status. + /// Get the current index lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -401,7 +416,8 @@ public virtual Task GetStatusAsync(CancellationToken cance /// /// - /// Retrieves the current index lifecycle management (ILM) status. + /// Get the ILM status. + /// Get the current index lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -415,10 +431,36 @@ public virtual Task GetStatusAsync(Action /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and - /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Migrate to data tiers routing. + /// Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. + /// Optionally, delete one legacy index template. /// Using node roles enables ILM to automatically move the indices between data tiers. /// + /// + /// Migrating away from custom node attributes routing can be manually performed. + /// This API provides an automated way of performing three out of the four manual steps listed in the migration guide: + /// + /// + /// + /// + /// Stop setting the custom hot attribute on new indices. + /// + /// + /// + /// + /// Remove custom allocation settings from existing ILM policies. + /// + /// + /// + /// + /// Replace custom allocation settings from existing indices with the corresponding tier preference. + /// + /// + /// + /// + /// ILM must be stopped before performing the migration. + /// Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -430,10 +472,36 @@ public virtual MigrateToDataTiersResponse MigrateToDataTiers(MigrateToDataTiersR /// /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and - /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Migrate to data tiers routing. + /// Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. + /// Optionally, delete one legacy index template. /// Using node roles enables ILM to automatically move the indices between data tiers. /// + /// + /// Migrating away from custom node attributes routing can be manually performed. + /// This API provides an automated way of performing three out of the four manual steps listed in the migration guide: + /// + /// + /// + /// + /// Stop setting the custom hot attribute on new indices. + /// + /// + /// + /// + /// Remove custom allocation settings from existing ILM policies. + /// + /// + /// + /// + /// Replace custom allocation settings from existing indices with the corresponding tier preference. + /// + /// + /// + /// + /// ILM must be stopped before performing the migration. + /// Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataTiersAsync(MigrateToDataTiersRequest request, CancellationToken cancellationToken = default) @@ -444,10 +512,36 @@ public virtual Task MigrateToDataTiersAsync(MigrateT /// /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and - /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Migrate to data tiers routing. + /// Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. + /// Optionally, delete one legacy index template. /// Using node roles enables ILM to automatically move the indices between data tiers. /// + /// + /// Migrating away from custom node attributes routing can be manually performed. + /// This API provides an automated way of performing three out of the four manual steps listed in the migration guide: + /// + /// + /// + /// + /// Stop setting the custom hot attribute on new indices. + /// + /// + /// + /// + /// Remove custom allocation settings from existing ILM policies. + /// + /// + /// + /// + /// Replace custom allocation settings from existing indices with the corresponding tier preference. + /// + /// + /// + /// + /// ILM must be stopped before performing the migration. + /// Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -459,10 +553,36 @@ public virtual MigrateToDataTiersResponse MigrateToDataTiers(MigrateToDataTiersR /// /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and - /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Migrate to data tiers routing. + /// Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. + /// Optionally, delete one legacy index template. /// Using node roles enables ILM to automatically move the indices between data tiers. /// + /// + /// Migrating away from custom node attributes routing can be manually performed. + /// This API provides an automated way of performing three out of the four manual steps listed in the migration guide: + /// + /// + /// + /// + /// Stop setting the custom hot attribute on new indices. + /// + /// + /// + /// + /// Remove custom allocation settings from existing ILM policies. + /// + /// + /// + /// + /// Replace custom allocation settings from existing indices with the corresponding tier preference. + /// + /// + /// + /// + /// ILM must be stopped before performing the migration. + /// Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -475,10 +595,36 @@ public virtual MigrateToDataTiersResponse MigrateToDataTiers() /// /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and - /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Migrate to data tiers routing. + /// Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. + /// Optionally, delete one legacy index template. /// Using node roles enables ILM to automatically move the indices between data tiers. /// + /// + /// Migrating away from custom node attributes routing can be manually performed. + /// This API provides an automated way of performing three out of the four manual steps listed in the migration guide: + /// + /// + /// + /// + /// Stop setting the custom hot attribute on new indices. + /// + /// + /// + /// + /// Remove custom allocation settings from existing ILM policies. + /// + /// + /// + /// + /// Replace custom allocation settings from existing indices with the corresponding tier preference. + /// + /// + /// + /// + /// ILM must be stopped before performing the migration. + /// Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED. + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -492,10 +638,36 @@ public virtual MigrateToDataTiersResponse MigrateToDataTiers(Action /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and - /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Migrate to data tiers routing. + /// Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. + /// Optionally, delete one legacy index template. /// Using node roles enables ILM to automatically move the indices between data tiers. /// + /// + /// Migrating away from custom node attributes routing can be manually performed. + /// This API provides an automated way of performing three out of the four manual steps listed in the migration guide: + /// + /// + /// + /// + /// Stop setting the custom hot attribute on new indices. + /// + /// + /// + /// + /// Remove custom allocation settings from existing ILM policies. + /// + /// + /// + /// + /// Replace custom allocation settings from existing indices with the corresponding tier preference. + /// + /// + /// + /// + /// ILM must be stopped before performing the migration. + /// Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataTiersAsync(MigrateToDataTiersRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -506,10 +678,36 @@ public virtual Task MigrateToDataTiersAsync(MigrateT /// /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and - /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Migrate to data tiers routing. + /// Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. + /// Optionally, delete one legacy index template. /// Using node roles enables ILM to automatically move the indices between data tiers. /// + /// + /// Migrating away from custom node attributes routing can be manually performed. + /// This API provides an automated way of performing three out of the four manual steps listed in the migration guide: + /// + /// + /// + /// + /// Stop setting the custom hot attribute on new indices. + /// + /// + /// + /// + /// Remove custom allocation settings from existing ILM policies. + /// + /// + /// + /// + /// Replace custom allocation settings from existing indices with the corresponding tier preference. + /// + /// + /// + /// + /// ILM must be stopped before performing the migration. + /// Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataTiersAsync(CancellationToken cancellationToken = default) @@ -521,10 +719,36 @@ public virtual Task MigrateToDataTiersAsync(Cancella /// /// - /// Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and - /// attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ + /// Migrate to data tiers routing. + /// Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. + /// Optionally, delete one legacy index template. /// Using node roles enables ILM to automatically move the indices between data tiers. /// + /// + /// Migrating away from custom node attributes routing can be manually performed. + /// This API provides an automated way of performing three out of the four manual steps listed in the migration guide: + /// + /// + /// + /// + /// Stop setting the custom hot attribute on new indices. + /// + /// + /// + /// + /// Remove custom allocation settings from existing ILM policies. + /// + /// + /// + /// + /// Replace custom allocation settings from existing indices with the corresponding tier preference. + /// + /// + /// + /// + /// ILM must be stopped before performing the migration. + /// Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED. + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task MigrateToDataTiersAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -537,7 +761,23 @@ public virtual Task MigrateToDataTiersAsync(Action /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -550,7 +790,23 @@ public virtual MoveToStepResponse MoveToStep(MoveToStepRequest request) /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -562,7 +818,23 @@ public virtual Task MoveToStepAsync(MoveToStepRequest reques /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -575,7 +847,23 @@ public virtual MoveToStepResponse MoveToStep(MoveToStepRequestDescrip /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -589,7 +877,23 @@ public virtual MoveToStepResponse MoveToStep(Elastic.Clients.Elastics /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -604,7 +908,23 @@ public virtual MoveToStepResponse MoveToStep(Elastic.Clients.Elastics /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -618,7 +938,23 @@ public virtual MoveToStepResponse MoveToStep() /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -633,7 +969,23 @@ public virtual MoveToStepResponse MoveToStep(Action /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -646,7 +998,23 @@ public virtual MoveToStepResponse MoveToStep(MoveToStepRequestDescriptor descrip /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -660,7 +1028,23 @@ public virtual MoveToStepResponse MoveToStep(Elastic.Clients.Elasticsearch.Index /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -675,7 +1059,23 @@ public virtual MoveToStepResponse MoveToStep(Elastic.Clients.Elasticsearch.Index /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -687,7 +1087,23 @@ public virtual Task MoveToStepAsync(MoveToStepReq /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -700,7 +1116,23 @@ public virtual Task MoveToStepAsync(Elastic.Clien /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -714,7 +1146,23 @@ public virtual Task MoveToStepAsync(Elastic.Clien /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -727,7 +1175,23 @@ public virtual Task MoveToStepAsync(CancellationT /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -741,7 +1205,23 @@ public virtual Task MoveToStepAsync(Action /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -753,7 +1233,23 @@ public virtual Task MoveToStepAsync(MoveToStepRequestDescrip /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -766,7 +1262,23 @@ public virtual Task MoveToStepAsync(Elastic.Clients.Elastics /// /// - /// Manually moves an index into the specified step and executes that step. + /// Move to a lifecycle step. + /// Manually move an index into a specific step in the lifecycle policy and run that step. + /// + /// + /// WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + /// + /// + /// You must specify both the current step and the step to be executed in the body of the request. + /// The request will fail if the current step does not match the step currently running for the index + /// This is to prevent the index from being moved from an unexpected step into the next step. + /// + /// + /// When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. + /// If only the phase is specified, the index will move to the first step of the first action in the target phase. + /// If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + /// Only actions specified in the ILM policy are considered valid. + /// An index cannot move to a step that is not part of its policy. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -780,7 +1292,11 @@ public virtual Task MoveToStepAsync(Elastic.Clients.Elastics /// /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// Create or update a lifecycle policy. + /// If the specified policy exists, it is replaced and the policy version is incremented. + /// + /// + /// NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -793,7 +1309,11 @@ public virtual PutLifecycleResponse PutLifecycle(PutLifecycleRequest request) /// /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// Create or update a lifecycle policy. + /// If the specified policy exists, it is replaced and the policy version is incremented. + /// + /// + /// NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -805,7 +1325,11 @@ public virtual Task PutLifecycleAsync(PutLifecycleRequest /// /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// Create or update a lifecycle policy. + /// If the specified policy exists, it is replaced and the policy version is incremented. + /// + /// + /// NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -818,7 +1342,11 @@ public virtual PutLifecycleResponse PutLifecycle(PutLifecycleRequestDescriptor d /// /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// Create or update a lifecycle policy. + /// If the specified policy exists, it is replaced and the policy version is incremented. + /// + /// + /// NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -832,7 +1360,11 @@ public virtual PutLifecycleResponse PutLifecycle(Elastic.Clients.Elasticsearch.N /// /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// Create or update a lifecycle policy. + /// If the specified policy exists, it is replaced and the policy version is incremented. + /// + /// + /// NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -847,7 +1379,11 @@ public virtual PutLifecycleResponse PutLifecycle(Elastic.Clients.Elasticsearch.N /// /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// Create or update a lifecycle policy. + /// If the specified policy exists, it is replaced and the policy version is incremented. + /// + /// + /// NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -859,7 +1395,11 @@ public virtual Task PutLifecycleAsync(PutLifecycleRequestD /// /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// Create or update a lifecycle policy. + /// If the specified policy exists, it is replaced and the policy version is incremented. + /// + /// + /// NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -872,7 +1412,11 @@ public virtual Task PutLifecycleAsync(Elastic.Clients.Elas /// /// - /// Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented. + /// Create or update a lifecycle policy. + /// If the specified policy exists, it is replaced and the policy version is incremented. + /// + /// + /// NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -886,7 +1430,9 @@ public virtual Task PutLifecycleAsync(Elastic.Clients.Elas /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -899,7 +1445,9 @@ public virtual RemovePolicyResponse RemovePolicy(RemovePolicyRequest request) /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -911,7 +1459,9 @@ public virtual Task RemovePolicyAsync(RemovePolicyRequest /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -924,7 +1474,9 @@ public virtual RemovePolicyResponse RemovePolicy(RemovePolicyRequestD /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -938,7 +1490,9 @@ public virtual RemovePolicyResponse RemovePolicy(Elastic.Clients.Elas /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -953,7 +1507,9 @@ public virtual RemovePolicyResponse RemovePolicy(Elastic.Clients.Elas /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -967,7 +1523,9 @@ public virtual RemovePolicyResponse RemovePolicy() /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -982,7 +1540,9 @@ public virtual RemovePolicyResponse RemovePolicy(Action /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -995,7 +1555,9 @@ public virtual RemovePolicyResponse RemovePolicy(RemovePolicyRequestDescriptor d /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1009,7 +1571,9 @@ public virtual RemovePolicyResponse RemovePolicy(Elastic.Clients.Elasticsearch.I /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1024,7 +1588,9 @@ public virtual RemovePolicyResponse RemovePolicy(Elastic.Clients.Elasticsearch.I /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1036,7 +1602,9 @@ public virtual Task RemovePolicyAsync(RemovePol /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1049,7 +1617,9 @@ public virtual Task RemovePolicyAsync(Elastic.C /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1063,7 +1633,9 @@ public virtual Task RemovePolicyAsync(Elastic.C /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1076,7 +1648,9 @@ public virtual Task RemovePolicyAsync(Cancellat /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1090,7 +1664,9 @@ public virtual Task RemovePolicyAsync(Action /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1102,7 +1678,9 @@ public virtual Task RemovePolicyAsync(RemovePolicyRequestD /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1115,7 +1693,9 @@ public virtual Task RemovePolicyAsync(Elastic.Clients.Elas /// /// - /// Removes the assigned lifecycle policy and stops managing the specified index + /// Remove policies from an index. + /// Remove the assigned lifecycle policies from an index or a data stream's backing indices. + /// It also stops managing the indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1129,7 +1709,10 @@ public virtual Task RemovePolicyAsync(Elastic.Clients.Elas /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1142,7 +1725,10 @@ public virtual RetryResponse Retry(RetryRequest request) /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1154,7 +1740,10 @@ public virtual Task RetryAsync(RetryRequest request, Cancellation /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1167,7 +1756,10 @@ public virtual RetryResponse Retry(RetryRequestDescriptor /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1181,7 +1773,10 @@ public virtual RetryResponse Retry(Elastic.Clients.Elasticsearch.Inde /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1196,7 +1791,10 @@ public virtual RetryResponse Retry(Elastic.Clients.Elasticsearch.Inde /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1210,7 +1808,10 @@ public virtual RetryResponse Retry() /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1225,7 +1826,10 @@ public virtual RetryResponse Retry(Action /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1238,7 +1842,10 @@ public virtual RetryResponse Retry(RetryRequestDescriptor descriptor) /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1252,7 +1859,10 @@ public virtual RetryResponse Retry(Elastic.Clients.Elasticsearch.IndexName index /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1267,7 +1877,10 @@ public virtual RetryResponse Retry(Elastic.Clients.Elasticsearch.IndexName index /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1279,7 +1892,10 @@ public virtual Task RetryAsync(RetryRequestDescriptor< /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1292,7 +1908,10 @@ public virtual Task RetryAsync(Elastic.Clients.Elastic /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1306,7 +1925,10 @@ public virtual Task RetryAsync(Elastic.Clients.Elastic /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1319,7 +1941,10 @@ public virtual Task RetryAsync(CancellationToken cance /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1333,7 +1958,10 @@ public virtual Task RetryAsync(Action /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1345,7 +1973,10 @@ public virtual Task RetryAsync(RetryRequestDescriptor descriptor, /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1358,7 +1989,10 @@ public virtual Task RetryAsync(Elastic.Clients.Elasticsearch.Inde /// /// - /// Retries executing the policy for an index that is in the ERROR step. + /// Retry a policy. + /// Retry running the lifecycle policy for an index that is in the ERROR step. + /// The API sets the policy back to the step where the error occurred and runs the step. + /// Use the explain lifecycle state API to determine whether an index is in the ERROR step. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1372,7 +2006,10 @@ public virtual Task RetryAsync(Elastic.Clients.Elasticsearch.Inde /// /// - /// Start the index lifecycle management (ILM) plugin. + /// Start the ILM plugin. + /// Start the index lifecycle management plugin if it is currently stopped. + /// ILM is started automatically when the cluster is formed. + /// Restarting ILM is necessary only when it has been stopped using the stop ILM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1385,7 +2022,10 @@ public virtual StartIlmResponse Start(StartIlmRequest request) /// /// - /// Start the index lifecycle management (ILM) plugin. + /// Start the ILM plugin. + /// Start the index lifecycle management plugin if it is currently stopped. + /// ILM is started automatically when the cluster is formed. + /// Restarting ILM is necessary only when it has been stopped using the stop ILM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1397,7 +2037,10 @@ public virtual Task StartAsync(StartIlmRequest request, Cancel /// /// - /// Start the index lifecycle management (ILM) plugin. + /// Start the ILM plugin. + /// Start the index lifecycle management plugin if it is currently stopped. + /// ILM is started automatically when the cluster is formed. + /// Restarting ILM is necessary only when it has been stopped using the stop ILM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1410,7 +2053,10 @@ public virtual StartIlmResponse Start(StartIlmRequestDescriptor descriptor) /// /// - /// Start the index lifecycle management (ILM) plugin. + /// Start the ILM plugin. + /// Start the index lifecycle management plugin if it is currently stopped. + /// ILM is started automatically when the cluster is formed. + /// Restarting ILM is necessary only when it has been stopped using the stop ILM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1424,7 +2070,10 @@ public virtual StartIlmResponse Start() /// /// - /// Start the index lifecycle management (ILM) plugin. + /// Start the ILM plugin. + /// Start the index lifecycle management plugin if it is currently stopped. + /// ILM is started automatically when the cluster is formed. + /// Restarting ILM is necessary only when it has been stopped using the stop ILM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1439,7 +2088,10 @@ public virtual StartIlmResponse Start(Action configur /// /// - /// Start the index lifecycle management (ILM) plugin. + /// Start the ILM plugin. + /// Start the index lifecycle management plugin if it is currently stopped. + /// ILM is started automatically when the cluster is formed. + /// Restarting ILM is necessary only when it has been stopped using the stop ILM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1451,7 +2103,10 @@ public virtual Task StartAsync(StartIlmRequestDescriptor descr /// /// - /// Start the index lifecycle management (ILM) plugin. + /// Start the ILM plugin. + /// Start the index lifecycle management plugin if it is currently stopped. + /// ILM is started automatically when the cluster is formed. + /// Restarting ILM is necessary only when it has been stopped using the stop ILM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1464,7 +2119,10 @@ public virtual Task StartAsync(CancellationToken cancellationT /// /// - /// Start the index lifecycle management (ILM) plugin. + /// Start the ILM plugin. + /// Start the index lifecycle management plugin if it is currently stopped. + /// ILM is started automatically when the cluster is formed. + /// Restarting ILM is necessary only when it has been stopped using the stop ILM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1478,7 +2136,13 @@ public virtual Task StartAsync(Action /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// Stop the ILM plugin. + /// Halt all lifecycle management operations and stop the index lifecycle management plugin. + /// This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. + /// + /// + /// The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. + /// Use the get ILM status API to check whether ILM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1491,7 +2155,13 @@ public virtual StopIlmResponse Stop(StopIlmRequest request) /// /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// Stop the ILM plugin. + /// Halt all lifecycle management operations and stop the index lifecycle management plugin. + /// This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. + /// + /// + /// The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. + /// Use the get ILM status API to check whether ILM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1503,7 +2173,13 @@ public virtual Task StopAsync(StopIlmRequest request, Cancellat /// /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// Stop the ILM plugin. + /// Halt all lifecycle management operations and stop the index lifecycle management plugin. + /// This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. + /// + /// + /// The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. + /// Use the get ILM status API to check whether ILM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1516,7 +2192,13 @@ public virtual StopIlmResponse Stop(StopIlmRequestDescriptor descriptor) /// /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// Stop the ILM plugin. + /// Halt all lifecycle management operations and stop the index lifecycle management plugin. + /// This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. + /// + /// + /// The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. + /// Use the get ILM status API to check whether ILM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1530,7 +2212,13 @@ public virtual StopIlmResponse Stop() /// /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// Stop the ILM plugin. + /// Halt all lifecycle management operations and stop the index lifecycle management plugin. + /// This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. + /// + /// + /// The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. + /// Use the get ILM status API to check whether ILM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1545,7 +2233,13 @@ public virtual StopIlmResponse Stop(Action configureRe /// /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// Stop the ILM plugin. + /// Halt all lifecycle management operations and stop the index lifecycle management plugin. + /// This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. + /// + /// + /// The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. + /// Use the get ILM status API to check whether ILM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1557,7 +2251,13 @@ public virtual Task StopAsync(StopIlmRequestDescriptor descript /// /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// Stop the ILM plugin. + /// Halt all lifecycle management operations and stop the index lifecycle management plugin. + /// This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. + /// + /// + /// The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. + /// Use the get ILM status API to check whether ILM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1570,7 +2270,13 @@ public virtual Task StopAsync(CancellationToken cancellationTok /// /// - /// Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + /// Stop the ILM plugin. + /// Halt all lifecycle management operations and stop the index lifecycle management plugin. + /// This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. + /// + /// + /// The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. + /// Use the get ILM status API to check whether ILM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 db556857ddd..a47f5e10434 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) { @@ -340,8 +362,9 @@ public virtual Task AnalyzeAsync(Action /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -354,8 +377,9 @@ public virtual ClearCacheResponse ClearCache(ClearCacheRequest request) /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -367,8 +391,9 @@ public virtual Task ClearCacheAsync(ClearCacheRequest reques /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -381,8 +406,9 @@ public virtual ClearCacheResponse ClearCache(ClearCacheRequestDescrip /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -396,8 +422,9 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elastics /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -412,8 +439,9 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elastics /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -427,8 +455,9 @@ public virtual ClearCacheResponse ClearCache() /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -443,8 +472,9 @@ public virtual ClearCacheResponse ClearCache(Action /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -457,8 +487,9 @@ public virtual ClearCacheResponse ClearCache(ClearCacheRequestDescriptor descrip /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -472,8 +503,9 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elasticsearch.Indic /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -488,8 +520,9 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elasticsearch.Indic /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -503,8 +536,9 @@ public virtual ClearCacheResponse ClearCache() /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -519,8 +553,9 @@ public virtual ClearCacheResponse ClearCache(Action /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -532,8 +567,9 @@ public virtual Task ClearCacheAsync(ClearCacheReq /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -546,8 +582,9 @@ public virtual Task ClearCacheAsync(Elastic.Clien /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -561,8 +598,9 @@ public virtual Task ClearCacheAsync(Elastic.Clien /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -575,8 +613,9 @@ public virtual Task ClearCacheAsync(CancellationT /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -590,8 +629,9 @@ public virtual Task ClearCacheAsync(Action /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -603,8 +643,9 @@ public virtual Task ClearCacheAsync(ClearCacheRequestDescrip /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -617,8 +658,9 @@ public virtual Task ClearCacheAsync(Elastic.Clients.Elastics /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -632,8 +674,9 @@ public virtual Task ClearCacheAsync(Elastic.Clients.Elastics /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -646,8 +689,9 @@ public virtual Task ClearCacheAsync(CancellationToken cancel /// /// - /// Clears the caches of one or more indices. - /// For data streams, the API clears the caches of the stream’s backing indices. + /// Clear the cache. + /// Clear the cache of one or more indices. + /// For data streams, the API clears the caches of the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -661,8 +705,60 @@ public virtual Task ClearCacheAsync(Action /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -674,8 +770,60 @@ public virtual CloneIndexResponse Clone(CloneIndexRequest request) /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(CloneIndexRequest request, CancellationToken cancellationToken = default) @@ -686,8 +834,60 @@ public virtual Task CloneAsync(CloneIndexRequest request, Ca /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -699,8 +899,60 @@ public virtual CloneIndexResponse Clone(CloneIndexRequestDescriptor /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -713,8 +965,60 @@ public virtual CloneIndexResponse Clone(Elastic.Clients.Elasticsearch /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -728,8 +1032,60 @@ public virtual CloneIndexResponse Clone(Elastic.Clients.Elasticsearch /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -742,8 +1098,60 @@ public virtual CloneIndexResponse Clone(Elastic.Clients.Elasticsearch /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -757,8 +1165,60 @@ public virtual CloneIndexResponse Clone(Elastic.Clients.Elasticsearch /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -770,8 +1230,60 @@ public virtual CloneIndexResponse Clone(CloneIndexRequestDescriptor descriptor) /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -784,8 +1296,60 @@ public virtual CloneIndexResponse Clone(Elastic.Clients.Elasticsearch.IndexName /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -799,8 +1363,60 @@ public virtual CloneIndexResponse Clone(Elastic.Clients.Elasticsearch.IndexName /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(CloneIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -811,8 +1427,60 @@ public virtual Task CloneAsync(CloneIndexRequestD /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Name target, CancellationToken cancellationToken = default) @@ -824,35 +1492,191 @@ public virtual Task CloneAsync(Elastic.Clients.El /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Name target, Action> configureRequest, CancellationToken cancellationToken = default) - { - var descriptor = new CloneIndexRequestDescriptor(index, target); - configureRequest?.Invoke(descriptor); - descriptor.BeforeRequest(); - return DoRequestAsync, CloneIndexResponse, CloneIndexRequestParameters>(descriptor, cancellationToken); - } - - /// /// - /// Clones an existing index. + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.Name target, CancellationToken cancellationToken = default) - { - var descriptor = new CloneIndexRequestDescriptor(target); + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Name target, Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new CloneIndexRequestDescriptor(index, target); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, CloneIndexResponse, CloneIndexRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.Name target, CancellationToken cancellationToken = default) + { + var descriptor = new CloneIndexRequestDescriptor(target); descriptor.BeforeRequest(); return DoRequestAsync, CloneIndexResponse, CloneIndexRequestParameters>(descriptor, cancellationToken); } /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.Name target, Action> configureRequest, CancellationToken cancellationToken = default) @@ -865,8 +1689,60 @@ public virtual Task CloneAsync(Elastic.Clients.El /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(CloneIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -877,8 +1753,60 @@ public virtual Task CloneAsync(CloneIndexRequestDescriptor d /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Name target, CancellationToken cancellationToken = default) @@ -890,8 +1818,60 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsearch /// /// - /// Clones an existing index. + /// Clone an index. + /// Clone an existing index into a new index. + /// Each original primary shard is cloned into a new primary shard in the new index. + /// + /// + /// IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + /// The API also does not copy index metadata from the original index. + /// Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + /// For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + /// + /// + /// The clone API copies most index settings from the source index to the resulting index, with the exception of index.number_of_replicas and index.auto_expand_replicas. + /// To set the number of replicas in the resulting index, configure these settings in the clone request. + /// + /// + /// Cloning works as follows: + /// + /// + /// + /// + /// First, it creates a new target index with the same definition as the source index. + /// + /// + /// + /// + /// Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Finally, it recovers the target index as though it were a closed index which had just been re-opened. /// + /// + /// + /// + /// IMPORTANT: Indices can only be cloned if they meet the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have the same number of primary shards as the target index. + /// + /// + /// + /// + /// The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloneAsync(Elastic.Clients.Elasticsearch.IndexName index, Elastic.Clients.Elasticsearch.Name target, Action configureRequest, CancellationToken cancellationToken = default) @@ -904,9 +1884,30 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsearch /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// - /// Learn more about this API in the Elasticsearch 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) @@ -917,9 +1918,30 @@ public virtual CloseIndexResponse Close(CloseIndexRequest request) /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequest request, CancellationToken cancellationToken = default) { @@ -929,9 +1951,30 @@ public virtual Task CloseAsync(CloseIndexRequest request, Ca /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// - /// Learn more about this API in the Elasticsearch 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) @@ -942,9 +1985,30 @@ public virtual CloseIndexResponse Close(CloseIndexRequestDescriptor /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// 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) @@ -956,9 +2020,30 @@ public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// - /// Learn more about this API in the Elasticsearch 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) @@ -971,9 +2056,30 @@ public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// 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() @@ -985,9 +2091,30 @@ public virtual CloseIndexResponse Close() /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1000,9 +2127,30 @@ public virtual CloseIndexResponse Close(Action /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// 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) @@ -1013,9 +2161,30 @@ public virtual CloseIndexResponse Close(CloseIndexRequestDescriptor descriptor) /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// - /// Learn more about this API in the Elasticsearch 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) @@ -1027,9 +2196,30 @@ public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices in /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// 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) @@ -1042,9 +2232,30 @@ public virtual CloseIndexResponse Close(Elastic.Clients.Elasticsearch.Indices in /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// - /// 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) { @@ -1054,9 +2265,30 @@ public virtual Task CloseAsync(CloseIndexRequestD /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(Elastic.Clients.Elasticsearch.Indices indices, CancellationToken cancellationToken = default) { @@ -1067,9 +2299,30 @@ public virtual Task CloseAsync(Elastic.Clients.El /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// - /// 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) { @@ -1081,9 +2334,30 @@ public virtual Task CloseAsync(Elastic.Clients.El /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CancellationToken cancellationToken = default) { @@ -1094,9 +2368,30 @@ public virtual Task CloseAsync(CancellationToken /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// - /// 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) { @@ -1108,9 +2403,30 @@ public virtual Task CloseAsync(Action /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CloseAsync(CloseIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -1120,9 +2436,30 @@ public virtual Task CloseAsync(CloseIndexRequestDescriptor d /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + /// + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. /// - /// 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) { @@ -1133,9 +2470,30 @@ public virtual Task CloseAsync(Elastic.Clients.Elasticsearch /// /// - /// Closes an index. + /// Close an index. + /// A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + /// It is not possible to index documents or to search for documents in a closed index. + /// Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + /// The shards will then go through the normal recovery process. + /// The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + /// + /// + /// You can open and close multiple indices. + /// An error is thrown if the request explicitly refers to a missing index. + /// This behaviour can be turned off using the ignore_unavailable=true parameter. + /// + /// + /// By default, you must explicitly name the indices you are opening or closing. + /// To open or close indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. This setting can also be changed with the cluster update settings API. + /// + /// + /// Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + /// Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false. + /// + /// 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 +2508,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 +2522,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 +2535,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 +2549,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 +2564,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 +2580,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 +2595,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 +2611,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 +2625,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 +2640,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 +2656,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 +2669,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 +2683,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 +2698,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 +2712,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 +2727,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 +2740,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 +2754,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) { @@ -2690,9 +4048,12 @@ public virtual Task DeleteTemplateAsync(Elastic.Clients. /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the 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 DiskUsageResponse DiskUsage(DiskUsageRequest request) @@ -2703,9 +4064,12 @@ public virtual DiskUsageResponse DiskUsage(DiskUsageRequest request) /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. /// - /// 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) { @@ -2715,9 +4079,12 @@ public virtual Task DiskUsageAsync(DiskUsageRequest request, /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the 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 DiskUsageResponse DiskUsage(DiskUsageRequestDescriptor descriptor) @@ -2728,9 +4095,12 @@ public virtual DiskUsageResponse DiskUsage(DiskUsageRequestDescriptor /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the 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 DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices indices) @@ -2742,9 +4112,12 @@ public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsea /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the 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 DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices indices, Action> configureRequest) @@ -2757,9 +4130,12 @@ public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsea /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the 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 DiskUsageResponse DiskUsage() @@ -2771,9 +4147,12 @@ public virtual DiskUsageResponse DiskUsage() /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the 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 DiskUsageResponse DiskUsage(Action> configureRequest) @@ -2786,9 +4165,12 @@ public virtual DiskUsageResponse DiskUsage(Action /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the 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 DiskUsageResponse DiskUsage(DiskUsageRequestDescriptor descriptor) @@ -2799,9 +4181,12 @@ public virtual DiskUsageResponse DiskUsage(DiskUsageRequestDescriptor descriptor /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the 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 DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices indices) @@ -2813,9 +4198,12 @@ public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the 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 DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices indices, Action configureRequest) @@ -2828,9 +4216,12 @@ public virtual DiskUsageResponse DiskUsage(Elastic.Clients.Elasticsearch.Indices /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. /// - /// 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) { @@ -2840,9 +4231,12 @@ public virtual Task DiskUsageAsync(DiskUsageReques /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. /// - /// 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) { @@ -2853,9 +4247,12 @@ public virtual Task DiskUsageAsync(Elastic.Clients /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. /// - /// 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) { @@ -2867,9 +4264,12 @@ public virtual Task DiskUsageAsync(Elastic.Clients /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. /// - /// 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) { @@ -2880,9 +4280,12 @@ public virtual Task DiskUsageAsync(CancellationTok /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. /// - /// 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) { @@ -2894,9 +4297,12 @@ public virtual Task DiskUsageAsync(Action /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. /// - /// 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) { @@ -2906,9 +4312,12 @@ public virtual Task DiskUsageAsync(DiskUsageRequestDescriptor /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. /// - /// 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) { @@ -2919,9 +4328,12 @@ public virtual Task DiskUsageAsync(Elastic.Clients.Elasticsea /// /// - /// Analyzes the disk usage of each field of an index or data stream. + /// Analyze the index disk usage. + /// Analyze the disk usage of each field of an index or data stream. + /// This API might not support indices created in previous Elasticsearch versions. + /// The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. /// - /// 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) { @@ -2933,9 +4345,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). + /// + /// 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) @@ -2946,9 +4366,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. + /// + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). /// - /// 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) { @@ -2958,9 +4386,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). + /// + /// 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) @@ -2971,9 +4407,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. + /// + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). /// - /// Learn more about this API in the Elasticsearch 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) @@ -2985,9 +4429,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). + /// + /// 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) @@ -3000,9 +4452,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. + /// + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). /// - /// Learn more about this API in the Elasticsearch 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) @@ -3013,9 +4473,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). + /// + /// 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) @@ -3027,9 +4495,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. + /// + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). /// - /// Learn more about this API in the Elasticsearch 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) @@ -3042,9 +4518,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DownsampleAsync(DownsampleRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -3054,9 +4538,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. + /// + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). /// - /// 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) { @@ -3067,9 +4559,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). + /// + /// 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) { @@ -3081,9 +4581,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. + /// + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). /// - /// 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) { @@ -3093,9 +4601,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). + /// + /// 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) { @@ -3106,9 +4622,17 @@ 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. + /// Downsample an index. + /// Aggregate a time series (TSDS) index and store pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. + /// For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + /// All documents within an hour interval are summarized and stored as a single document in the downsample index. + /// + /// + /// NOTE: Only indices in a time series data stream are supported. + /// Neither field nor document level security can be defined on the source index. + /// The source index must be read only (index.blocks.write: true). /// - /// 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) { @@ -3702,7 +5226,8 @@ public virtual Task ExistsAliasAsync(Elastic.Clients.Elasti /// /// - /// Returns information about whether a particular index template exists. + /// Check index templates. + /// Check whether index templates exist. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3715,7 +5240,8 @@ public virtual ExistsIndexTemplateResponse ExistsIndexTemplate(ExistsIndexTempla /// /// - /// Returns information about whether a particular index template exists. + /// Check index templates. + /// Check whether index templates exist. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3727,7 +5253,8 @@ public virtual Task ExistsIndexTemplateAsync(Exists /// /// - /// Returns information about whether a particular index template exists. + /// Check index templates. + /// Check whether index templates exist. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3740,7 +5267,8 @@ public virtual ExistsIndexTemplateResponse ExistsIndexTemplate(ExistsIndexTempla /// /// - /// Returns information about whether a particular index template exists. + /// Check index templates. + /// Check whether index templates exist. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3754,7 +5282,8 @@ public virtual ExistsIndexTemplateResponse ExistsIndexTemplate(Elastic.Clients.E /// /// - /// Returns information about whether a particular index template exists. + /// Check index templates. + /// Check whether index templates exist. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3769,7 +5298,8 @@ public virtual ExistsIndexTemplateResponse ExistsIndexTemplate(Elastic.Clients.E /// /// - /// Returns information about whether a particular index template exists. + /// Check index templates. + /// Check whether index templates exist. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3781,7 +5311,8 @@ public virtual Task ExistsIndexTemplateAsync(Exists /// /// - /// Returns information about whether a particular index template exists. + /// Check index templates. + /// Check whether index templates exist. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3794,7 +5325,8 @@ public virtual Task ExistsIndexTemplateAsync(Elasti /// /// - /// Returns information about whether a particular index template exists. + /// Check index templates. + /// Check whether index templates exist. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3923,7 +5455,7 @@ public virtual Task ExistsTemplateAsync(Elastic.Clients. /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3937,7 +5469,7 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(ExplainDataLife /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3950,7 +5482,7 @@ public virtual Task ExplainDataLifecycleAsync(Expl /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3964,7 +5496,7 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(Expl /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3979,7 +5511,7 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(Elas /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -3995,7 +5527,7 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(Elas /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4010,7 +5542,7 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle() /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4026,7 +5558,7 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(Acti /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4040,7 +5572,7 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(ExplainDataLife /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4055,7 +5587,7 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(Elastic.Clients /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4071,7 +5603,7 @@ public virtual ExplainDataLifecycleResponse ExplainDataLifecycle(Elastic.Clients /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4084,7 +5616,7 @@ public virtual Task ExplainDataLifecycleAsync /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4098,7 +5630,7 @@ public virtual Task ExplainDataLifecycleAsync /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4113,7 +5645,7 @@ public virtual Task ExplainDataLifecycleAsync /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4127,7 +5659,7 @@ public virtual Task ExplainDataLifecycleAsync /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4142,7 +5674,7 @@ public virtual Task ExplainDataLifecycleAsync /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4155,7 +5687,7 @@ public virtual Task ExplainDataLifecycleAsync(Expl /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4169,7 +5701,7 @@ public virtual Task ExplainDataLifecycleAsync(Elas /// /// /// Get the status for a data stream lifecycle. - /// Retrieves information about an index or data stream’s current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. + /// Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4183,7 +5715,10 @@ public virtual Task ExplainDataLifecycleAsync(Elas /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4196,7 +5731,10 @@ public virtual FieldUsageStatsResponse FieldUsageStats(FieldUsageStatsRequest re /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4208,7 +5746,10 @@ public virtual Task FieldUsageStatsAsync(FieldUsageStat /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4221,7 +5762,10 @@ public virtual FieldUsageStatsResponse FieldUsageStats(FieldUsageStat /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4235,7 +5779,10 @@ public virtual FieldUsageStatsResponse FieldUsageStats(Elastic.Client /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4250,7 +5797,10 @@ public virtual FieldUsageStatsResponse FieldUsageStats(Elastic.Client /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4264,7 +5814,10 @@ public virtual FieldUsageStatsResponse FieldUsageStats() /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4279,7 +5832,10 @@ public virtual FieldUsageStatsResponse FieldUsageStats(Action /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4292,7 +5848,10 @@ public virtual FieldUsageStatsResponse FieldUsageStats(FieldUsageStatsRequestDes /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4306,7 +5865,10 @@ public virtual FieldUsageStatsResponse FieldUsageStats(Elastic.Clients.Elasticse /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4321,7 +5883,10 @@ public virtual FieldUsageStatsResponse FieldUsageStats(Elastic.Clients.Elasticse /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4333,7 +5898,10 @@ public virtual Task FieldUsageStatsAsync(Fie /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4346,7 +5914,10 @@ public virtual Task FieldUsageStatsAsync(Ela /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4360,7 +5931,10 @@ public virtual Task FieldUsageStatsAsync(Ela /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4373,7 +5947,10 @@ public virtual Task FieldUsageStatsAsync(Can /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4387,7 +5964,10 @@ public virtual Task FieldUsageStatsAsync(Act /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4399,7 +5979,10 @@ public virtual Task FieldUsageStatsAsync(FieldUsageStat /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4412,7 +5995,10 @@ public virtual Task FieldUsageStatsAsync(Elastic.Client /// /// - /// Returns field usage information for each shard and field of an index. + /// Get field usage stats. + /// Get field usage information for each shard and field of an index. + /// Field usage statistics are automatically captured when queries are running on a cluster. + /// A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4426,9 +6012,21 @@ public virtual Task FieldUsageStatsAsync(Elastic.Client /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// Learn more about this API in the Elasticsearch 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) @@ -4439,9 +6037,21 @@ public virtual FlushResponse Flush(FlushRequest request) /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequest request, CancellationToken cancellationToken = default) { @@ -4451,9 +6061,21 @@ public virtual Task FlushAsync(FlushRequest request, Cancellation /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// Learn more about this API in the Elasticsearch 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) @@ -4464,9 +6086,21 @@ public virtual FlushResponse Flush(FlushRequestDescriptor /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// 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) @@ -4478,9 +6112,21 @@ public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indi /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// Learn more about this API in the Elasticsearch 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) @@ -4493,9 +6139,21 @@ public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indi /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// 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() @@ -4507,9 +6165,21 @@ public virtual FlushResponse Flush() /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// Learn more about this API in the Elasticsearch 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) @@ -4522,9 +6192,21 @@ public virtual FlushResponse Flush(Action /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// 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) @@ -4535,9 +6217,21 @@ public virtual FlushResponse Flush(FlushRequestDescriptor descriptor) /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// Learn more about this API in the Elasticsearch 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) @@ -4549,9 +6243,21 @@ public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indices? indice /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// 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) @@ -4564,9 +6270,21 @@ public virtual FlushResponse Flush(Elastic.Clients.Elasticsearch.Indices? indice /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// Learn more about this API in the Elasticsearch 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() @@ -4578,9 +6296,21 @@ public virtual FlushResponse Flush() /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// 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) @@ -4593,9 +6323,21 @@ public virtual FlushResponse Flush(Action configureReque /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// 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) { @@ -4605,9 +6347,21 @@ public virtual Task FlushAsync(FlushRequestDescriptor< /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indices? indices, CancellationToken cancellationToken = default) { @@ -4618,9 +6372,21 @@ public virtual Task FlushAsync(Elastic.Clients.Elastic /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// 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) { @@ -4632,9 +6398,21 @@ public virtual Task FlushAsync(Elastic.Clients.Elastic /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(CancellationToken cancellationToken = default) { @@ -4645,9 +6423,21 @@ public virtual Task FlushAsync(CancellationToken cance /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// 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) { @@ -4659,9 +6449,21 @@ public virtual Task FlushAsync(Action /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(FlushRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -4671,9 +6473,21 @@ public virtual Task FlushAsync(FlushRequestDescriptor descriptor, /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// 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) { @@ -4684,9 +6498,21 @@ public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indi /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indices? indices, Action configureRequest, CancellationToken cancellationToken = default) { @@ -4698,9 +6524,21 @@ public virtual Task FlushAsync(Elastic.Clients.Elasticsearch.Indi /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + /// + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. /// - /// 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) { @@ -4711,9 +6549,21 @@ public virtual Task FlushAsync(CancellationToken cancellationToke /// /// - /// Flushes one or more data streams or indices. + /// Flush data streams or indices. + /// Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + /// When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + /// Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// After each operation has been flushed it is permanently stored in the Lucene index. + /// This may mean that there is no need to maintain an additional copy of it in the transaction log. + /// The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + /// + /// + /// It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + /// If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task FlushAsync(Action configureRequest, CancellationToken cancellationToken = default) { @@ -4725,7 +6575,21 @@ public virtual Task FlushAsync(Action con /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4738,7 +6602,21 @@ public virtual ForcemergeResponse Forcemerge(ForcemergeRequest request) /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4750,7 +6628,21 @@ public virtual Task ForcemergeAsync(ForcemergeRequest reques /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4763,7 +6655,21 @@ public virtual ForcemergeResponse Forcemerge(ForcemergeRequestDescrip /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4777,7 +6683,21 @@ public virtual ForcemergeResponse Forcemerge(Elastic.Clients.Elastics /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4792,7 +6712,21 @@ public virtual ForcemergeResponse Forcemerge(Elastic.Clients.Elastics /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4806,7 +6740,21 @@ public virtual ForcemergeResponse Forcemerge() /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4821,7 +6769,21 @@ public virtual ForcemergeResponse Forcemerge(Action /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4834,7 +6796,21 @@ public virtual ForcemergeResponse Forcemerge(ForcemergeRequestDescriptor descrip /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4848,7 +6824,21 @@ public virtual ForcemergeResponse Forcemerge(Elastic.Clients.Elasticsearch.Indic /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4863,7 +6853,21 @@ public virtual ForcemergeResponse Forcemerge(Elastic.Clients.Elasticsearch.Indic /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4877,7 +6881,21 @@ public virtual ForcemergeResponse Forcemerge() /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4892,7 +6910,21 @@ public virtual ForcemergeResponse Forcemerge(Action /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4904,7 +6936,21 @@ public virtual Task ForcemergeAsync(ForcemergeReq /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4917,7 +6963,21 @@ public virtual Task ForcemergeAsync(Elastic.Clien /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4931,7 +6991,21 @@ public virtual Task ForcemergeAsync(Elastic.Clien /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4944,7 +7018,21 @@ public virtual Task ForcemergeAsync(CancellationT /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4958,7 +7046,21 @@ public virtual Task ForcemergeAsync(Action /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4970,7 +7072,21 @@ public virtual Task ForcemergeAsync(ForcemergeRequestDescrip /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4983,7 +7099,21 @@ public virtual Task ForcemergeAsync(Elastic.Clients.Elastics /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -4997,7 +7127,21 @@ public virtual Task ForcemergeAsync(Elastic.Clients.Elastics /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5010,7 +7154,21 @@ public virtual Task ForcemergeAsync(CancellationToken cancel /// /// - /// Performs the force merge operation on one or more indices. + /// Force a merge. + /// Perform the force merge operation on the shards of one or more indices. + /// For data streams, the API forces a merge on the shards of the stream's backing indices. + /// + /// + /// Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + /// Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + /// + /// + /// WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + /// When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + /// These soft-deleted documents are automatically cleaned up during regular segment merges. + /// But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + /// So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + /// If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7850,7 +10008,19 @@ public virtual Task OpenAsync(Elastic.Clients.Elasticsearch.I /// /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// Promote a data stream. + /// Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. + /// + /// + /// With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. + /// These data streams can't be rolled over in the local cluster. + /// These replicated data streams roll over only if the upstream data stream rolls over. + /// In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. + /// + /// + /// NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. + /// If this is missing, the data stream will not be able to roll over until a matching index template is created. + /// This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7863,7 +10033,19 @@ public virtual PromoteDataStreamResponse PromoteDataStream(PromoteDataStreamRequ /// /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// Promote a data stream. + /// Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. + /// + /// + /// With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. + /// These data streams can't be rolled over in the local cluster. + /// These replicated data streams roll over only if the upstream data stream rolls over. + /// In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. + /// + /// + /// NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. + /// If this is missing, the data stream will not be able to roll over until a matching index template is created. + /// This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7875,7 +10057,19 @@ public virtual Task PromoteDataStreamAsync(PromoteDat /// /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// Promote a data stream. + /// Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. + /// + /// + /// With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. + /// These data streams can't be rolled over in the local cluster. + /// These replicated data streams roll over only if the upstream data stream rolls over. + /// In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. + /// + /// + /// NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. + /// If this is missing, the data stream will not be able to roll over until a matching index template is created. + /// This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7888,7 +10082,19 @@ public virtual PromoteDataStreamResponse PromoteDataStream(PromoteDataStreamRequ /// /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// Promote a data stream. + /// Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. + /// + /// + /// With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. + /// These data streams can't be rolled over in the local cluster. + /// These replicated data streams roll over only if the upstream data stream rolls over. + /// In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. + /// + /// + /// NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. + /// If this is missing, the data stream will not be able to roll over until a matching index template is created. + /// This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7902,7 +10108,19 @@ public virtual PromoteDataStreamResponse PromoteDataStream(Elastic.Clients.Elast /// /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// Promote a data stream. + /// Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. + /// + /// + /// With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. + /// These data streams can't be rolled over in the local cluster. + /// These replicated data streams roll over only if the upstream data stream rolls over. + /// In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. + /// + /// + /// NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. + /// If this is missing, the data stream will not be able to roll over until a matching index template is created. + /// This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7917,7 +10135,19 @@ public virtual PromoteDataStreamResponse PromoteDataStream(Elastic.Clients.Elast /// /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// Promote a data stream. + /// Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. + /// + /// + /// With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. + /// These data streams can't be rolled over in the local cluster. + /// These replicated data streams roll over only if the upstream data stream rolls over. + /// In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. + /// + /// + /// NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. + /// If this is missing, the data stream will not be able to roll over until a matching index template is created. + /// This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7929,7 +10159,19 @@ public virtual Task PromoteDataStreamAsync(PromoteDat /// /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// Promote a data stream. + /// Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. + /// + /// + /// With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. + /// These data streams can't be rolled over in the local cluster. + /// These replicated data streams roll over only if the upstream data stream rolls over. + /// In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. + /// + /// + /// NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. + /// If this is missing, the data stream will not be able to roll over until a matching index template is created. + /// This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7942,7 +10184,19 @@ public virtual Task PromoteDataStreamAsync(Elastic.Cl /// /// - /// Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + /// Promote a data stream. + /// Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. + /// + /// + /// With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. + /// These data streams can't be rolled over in the local cluster. + /// These replicated data streams roll over only if the upstream data stream rolls over. + /// In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. + /// + /// + /// NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. + /// If this is missing, the data stream will not be able to roll over until a matching index template is created. + /// This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -8264,9 +10518,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 +10533,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 +10561,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 +10575,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); @@ -9174,6 +11428,19 @@ public virtual Task PutSettingsAsync(Elastic.Clients /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9188,6 +11455,19 @@ public virtual PutTemplateResponse PutTemplate(PutTemplateRequest request) /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9201,6 +11481,19 @@ public virtual Task PutTemplateAsync(PutTemplateRequest req /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9215,6 +11508,19 @@ public virtual PutTemplateResponse PutTemplate(PutTemplateRequestDesc /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9230,6 +11536,19 @@ public virtual PutTemplateResponse PutTemplate(Elastic.Clients.Elasti /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9246,6 +11565,19 @@ public virtual PutTemplateResponse PutTemplate(Elastic.Clients.Elasti /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9260,6 +11592,19 @@ public virtual PutTemplateResponse PutTemplate(PutTemplateRequestDescriptor desc /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9275,6 +11620,19 @@ public virtual PutTemplateResponse PutTemplate(Elastic.Clients.Elasticsearch.Nam /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9291,6 +11649,19 @@ public virtual PutTemplateResponse PutTemplate(Elastic.Clients.Elasticsearch.Nam /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9304,6 +11675,19 @@ public virtual Task PutTemplateAsync(PutTemplate /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9318,6 +11702,19 @@ public virtual Task PutTemplateAsync(Elastic.Cli /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9333,6 +11730,19 @@ public virtual Task PutTemplateAsync(Elastic.Cli /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9346,6 +11756,19 @@ public virtual Task PutTemplateAsync(PutTemplateRequestDesc /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9360,6 +11783,19 @@ public virtual Task PutTemplateAsync(Elastic.Clients.Elasti /// /// Create or update an index template. /// Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + /// Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + /// + /// + /// IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + /// + /// + /// Composable templates always take precedence over legacy templates. + /// If no composable template matches a new index, matching legacy templates are applied according to their order. + /// + /// + /// Index templates are only applied during index creation. + /// Changes to index templates do not affect existing indices. + /// Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9373,8 +11809,56 @@ public virtual Task PutTemplateAsync(Elastic.Clients.Elasti /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9387,8 +11871,56 @@ public virtual RecoveryResponse Recovery(RecoveryRequest request) /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9400,8 +11932,56 @@ public virtual Task RecoveryAsync(RecoveryRequest request, Can /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9414,8 +11994,56 @@ public virtual RecoveryResponse Recovery(RecoveryRequestDescriptor /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9429,8 +12057,56 @@ public virtual RecoveryResponse Recovery(Elastic.Clients.Elasticsearc /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9445,8 +12121,56 @@ public virtual RecoveryResponse Recovery(Elastic.Clients.Elasticsearc /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9460,8 +12184,56 @@ public virtual RecoveryResponse Recovery() /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9476,8 +12248,56 @@ public virtual RecoveryResponse Recovery(Action /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9490,8 +12310,56 @@ public virtual RecoveryResponse Recovery(RecoveryRequestDescriptor descriptor) /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9505,8 +12373,56 @@ public virtual RecoveryResponse Recovery(Elastic.Clients.Elasticsearch.Indices? /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9521,8 +12437,56 @@ public virtual RecoveryResponse Recovery(Elastic.Clients.Elasticsearch.Indices? /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9536,8 +12500,56 @@ public virtual RecoveryResponse Recovery() /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9552,8 +12564,56 @@ public virtual RecoveryResponse Recovery(Action confi /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9565,8 +12625,56 @@ public virtual Task RecoveryAsync(RecoveryRequestDe /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9579,8 +12687,56 @@ public virtual Task RecoveryAsync(Elastic.Clients.E /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9594,8 +12750,56 @@ public virtual Task RecoveryAsync(Elastic.Clients.E /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9608,8 +12812,56 @@ public virtual Task RecoveryAsync(CancellationToken /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9623,8 +12875,56 @@ public virtual Task RecoveryAsync(Action /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9636,8 +12936,56 @@ public virtual Task RecoveryAsync(RecoveryRequestDescriptor de /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9650,8 +12998,56 @@ public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -9665,29 +13061,125 @@ public virtual Task RecoveryAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task RecoveryAsync(CancellationToken cancellationToken = default) - { - var descriptor = new RecoveryRequestDescriptor(); - descriptor.BeforeRequest(); - return DoRequestAsync(descriptor, cancellationToken); - } - - /// /// - /// Returns information about ongoing and completed shard recoveries for one or more indices. - /// For data streams, the API returns information for the stream’s backing indices. + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task RecoveryAsync(Action configureRequest, CancellationToken cancellationToken = default) - { - var descriptor = new RecoveryRequestDescriptor(); - configureRequest?.Invoke(descriptor); + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task RecoveryAsync(CancellationToken cancellationToken = default) + { + var descriptor = new RecoveryRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get index recovery information. + /// Get information about ongoing and completed shard recoveries for one or more indices. + /// For data streams, the API returns information for the stream's backing indices. + /// + /// + /// Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + /// When a shard recovery completes, the recovered shard is available for search and indexing. + /// + /// + /// Recovery automatically occurs during the following processes: + /// + /// + /// + /// + /// When creating an index for the first time. + /// + /// + /// + /// + /// When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + /// + /// + /// + /// + /// Creation of new replica shard copies from the primary. + /// + /// + /// + /// + /// Relocation of a shard copy to a different node in the same cluster. + /// + /// + /// + /// + /// A snapshot restore operation. + /// + /// + /// + /// + /// A clone, shrink, or split operation. + /// + /// + /// + /// + /// You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + /// + /// + /// The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + /// It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + /// This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task RecoveryAsync(Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new RecoveryRequestDescriptor(); + configureRequest?.Invoke(descriptor); descriptor.BeforeRequest(); return DoRequestAsync(descriptor, cancellationToken); } @@ -10037,7 +13529,23 @@ public virtual Task RefreshAsync(Action /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10050,7 +13558,23 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(ReloadSearchA /// /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10062,7 +13586,23 @@ public virtual Task ReloadSearchAnalyzersAsync(Re /// /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10075,7 +13615,23 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(Re /// /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10089,7 +13645,23 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(El /// /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10104,7 +13676,23 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(El /// /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10118,7 +13706,23 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers() /// /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10133,7 +13737,23 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(Ac /// /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10146,7 +13766,23 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(ReloadSearchA /// /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10160,7 +13796,23 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(Elastic.Clien /// /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10175,7 +13827,23 @@ public virtual ReloadSearchAnalyzersResponse ReloadSearchAnalyzers(Elastic.Clien /// /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10187,7 +13855,23 @@ public virtual Task ReloadSearchAnalyzersAsync /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10200,7 +13884,23 @@ public virtual Task ReloadSearchAnalyzersAsync /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10214,7 +13914,23 @@ public virtual Task ReloadSearchAnalyzersAsync /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10227,7 +13943,23 @@ public virtual Task ReloadSearchAnalyzersAsync /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10241,7 +13973,23 @@ public virtual Task ReloadSearchAnalyzersAsync /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10253,7 +14001,23 @@ public virtual Task ReloadSearchAnalyzersAsync(Re /// /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10266,7 +14030,23 @@ public virtual Task ReloadSearchAnalyzersAsync(El /// /// - /// Reloads an index's search analyzers and their resources. + /// Reload search analyzers. + /// Reload an index's search analyzers and their resources. + /// For data streams, the API reloads search analyzers and resources for the stream's backing indices. + /// + /// + /// IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + /// + /// + /// You can use the reload search analyzers API to pick up changes to synonym files used in the synonym_graph or synonym token filter of a search analyzer. + /// To be eligible, the token filter must have an updateable flag of true and only be used in search analyzers. + /// + /// + /// NOTE: This API does not perform a reload for each shard of an index. + /// Instead, it performs a reload for each node containing index shards. + /// As a result, the total shard count returned by the API can differ from the number of index shards. + /// Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + /// This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10280,10 +14060,47 @@ public virtual Task ReloadSearchAnalyzersAsync(El /// /// - /// Resolves the specified index expressions to return information about each cluster, including - /// the local cluster, if included. + /// Resolve the cluster. + /// Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. /// Multiple patterns and remote clusters are supported. /// + /// + /// This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. + /// + /// + /// You use the same index expression with this endpoint as you would for cross-cluster search. + /// Index and cluster exclusions are also supported with this endpoint. + /// + /// + /// For each cluster in the index expression, information is returned about: + /// + /// + /// + /// + /// Whether the querying ("local") cluster is currently connected to each remote cluster in the index expression scope. + /// + /// + /// + /// + /// Whether each remote cluster is configured with skip_unavailable as true or false. + /// + /// + /// + /// + /// Whether there are any indices, aliases, or data streams on that cluster that match the index expression. + /// + /// + /// + /// + /// Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). + /// + /// + /// + /// + /// Cluster version information, including the Elasticsearch server version. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10295,10 +14112,47 @@ public virtual ResolveClusterResponse ResolveCluster(ResolveClusterRequest reque /// /// - /// Resolves the specified index expressions to return information about each cluster, including - /// the local cluster, if included. + /// Resolve the cluster. + /// Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. /// Multiple patterns and remote clusters are supported. /// + /// + /// This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. + /// + /// + /// You use the same index expression with this endpoint as you would for cross-cluster search. + /// Index and cluster exclusions are also supported with this endpoint. + /// + /// + /// For each cluster in the index expression, information is returned about: + /// + /// + /// + /// + /// Whether the querying ("local") cluster is currently connected to each remote cluster in the index expression scope. + /// + /// + /// + /// + /// Whether each remote cluster is configured with skip_unavailable as true or false. + /// + /// + /// + /// + /// Whether there are any indices, aliases, or data streams on that cluster that match the index expression. + /// + /// + /// + /// + /// Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). + /// + /// + /// + /// + /// Cluster version information, including the Elasticsearch server version. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveClusterAsync(ResolveClusterRequest request, CancellationToken cancellationToken = default) @@ -10309,10 +14163,47 @@ public virtual Task ResolveClusterAsync(ResolveClusterRe /// /// - /// Resolves the specified index expressions to return information about each cluster, including - /// the local cluster, if included. + /// Resolve the cluster. + /// Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. /// Multiple patterns and remote clusters are supported. /// + /// + /// This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. + /// + /// + /// You use the same index expression with this endpoint as you would for cross-cluster search. + /// Index and cluster exclusions are also supported with this endpoint. + /// + /// + /// For each cluster in the index expression, information is returned about: + /// + /// + /// + /// + /// Whether the querying ("local") cluster is currently connected to each remote cluster in the index expression scope. + /// + /// + /// + /// + /// Whether each remote cluster is configured with skip_unavailable as true or false. + /// + /// + /// + /// + /// Whether there are any indices, aliases, or data streams on that cluster that match the index expression. + /// + /// + /// + /// + /// Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). + /// + /// + /// + /// + /// Cluster version information, including the Elasticsearch server version. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10324,10 +14215,47 @@ public virtual ResolveClusterResponse ResolveCluster(ResolveClusterRequestDescri /// /// - /// Resolves the specified index expressions to return information about each cluster, including - /// the local cluster, if included. + /// Resolve the cluster. + /// Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. /// Multiple patterns and remote clusters are supported. /// + /// + /// This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. + /// + /// + /// You use the same index expression with this endpoint as you would for cross-cluster search. + /// Index and cluster exclusions are also supported with this endpoint. + /// + /// + /// For each cluster in the index expression, information is returned about: + /// + /// + /// + /// + /// Whether the querying ("local") cluster is currently connected to each remote cluster in the index expression scope. + /// + /// + /// + /// + /// Whether each remote cluster is configured with skip_unavailable as true or false. + /// + /// + /// + /// + /// Whether there are any indices, aliases, or data streams on that cluster that match the index expression. + /// + /// + /// + /// + /// Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). + /// + /// + /// + /// + /// Cluster version information, including the Elasticsearch server version. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10340,10 +14268,47 @@ public virtual ResolveClusterResponse ResolveCluster(Elastic.Clients.Elasticsear /// /// - /// Resolves the specified index expressions to return information about each cluster, including - /// the local cluster, if included. + /// Resolve the cluster. + /// Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. /// Multiple patterns and remote clusters are supported. /// + /// + /// This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. + /// + /// + /// You use the same index expression with this endpoint as you would for cross-cluster search. + /// Index and cluster exclusions are also supported with this endpoint. + /// + /// + /// For each cluster in the index expression, information is returned about: + /// + /// + /// + /// + /// Whether the querying ("local") cluster is currently connected to each remote cluster in the index expression scope. + /// + /// + /// + /// + /// Whether each remote cluster is configured with skip_unavailable as true or false. + /// + /// + /// + /// + /// Whether there are any indices, aliases, or data streams on that cluster that match the index expression. + /// + /// + /// + /// + /// Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). + /// + /// + /// + /// + /// Cluster version information, including the Elasticsearch server version. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -10357,26 +14322,100 @@ public virtual ResolveClusterResponse ResolveCluster(Elastic.Clients.Elasticsear /// /// - /// Resolves the specified index expressions to return information about each cluster, including - /// the local cluster, if included. + /// Resolve the cluster. + /// Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. /// Multiple patterns and remote clusters are supported. /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task ResolveClusterAsync(ResolveClusterRequestDescriptor descriptor, CancellationToken cancellationToken = default) - { - descriptor.BeforeRequest(); - return DoRequestAsync(descriptor, cancellationToken); - } - - /// /// - /// Resolves the specified index expressions to return information about each cluster, including - /// the local cluster, if included. - /// Multiple patterns and remote clusters are supported. + /// This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. /// - /// Learn more about this API in the Elasticsearch documentation. - /// + /// + /// You use the same index expression with this endpoint as you would for cross-cluster search. + /// Index and cluster exclusions are also supported with this endpoint. + /// + /// + /// For each cluster in the index expression, information is returned about: + /// + /// + /// + /// + /// Whether the querying ("local") cluster is currently connected to each remote cluster in the index expression scope. + /// + /// + /// + /// + /// Whether each remote cluster is configured with skip_unavailable as true or false. + /// + /// + /// + /// + /// Whether there are any indices, aliases, or data streams on that cluster that match the index expression. + /// + /// + /// + /// + /// Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). + /// + /// + /// + /// + /// Cluster version information, including the Elasticsearch server version. + /// + /// + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task ResolveClusterAsync(ResolveClusterRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Resolve the cluster. + /// Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. + /// Multiple patterns and remote clusters are supported. + /// + /// + /// This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. + /// + /// + /// You use the same index expression with this endpoint as you would for cross-cluster search. + /// Index and cluster exclusions are also supported with this endpoint. + /// + /// + /// For each cluster in the index expression, information is returned about: + /// + /// + /// + /// + /// Whether the querying ("local") cluster is currently connected to each remote cluster in the index expression scope. + /// + /// + /// + /// + /// Whether each remote cluster is configured with skip_unavailable as true or false. + /// + /// + /// + /// + /// Whether there are any indices, aliases, or data streams on that cluster that match the index expression. + /// + /// + /// + /// + /// Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). + /// + /// + /// + /// + /// Cluster version information, including the Elasticsearch server version. + /// + /// + /// + /// Learn more about this API in the Elasticsearch documentation. + /// public virtual Task ResolveClusterAsync(Elastic.Clients.Elasticsearch.Names name, CancellationToken cancellationToken = default) { var descriptor = new ResolveClusterRequestDescriptor(name); @@ -10386,10 +14425,47 @@ public virtual Task ResolveClusterAsync(Elastic.Clients. /// /// - /// Resolves the specified index expressions to return information about each cluster, including - /// the local cluster, if included. + /// Resolve the cluster. + /// Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. /// Multiple patterns and remote clusters are supported. /// + /// + /// This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. + /// + /// + /// You use the same index expression with this endpoint as you would for cross-cluster search. + /// Index and cluster exclusions are also supported with this endpoint. + /// + /// + /// For each cluster in the index expression, information is returned about: + /// + /// + /// + /// + /// Whether the querying ("local") cluster is currently connected to each remote cluster in the index expression scope. + /// + /// + /// + /// + /// Whether each remote cluster is configured with skip_unavailable as true or false. + /// + /// + /// + /// + /// Whether there are any indices, aliases, or data streams on that cluster that match the index expression. + /// + /// + /// + /// + /// Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). + /// + /// + /// + /// + /// Cluster version information, including the Elasticsearch server version. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ResolveClusterAsync(Elastic.Clients.Elasticsearch.Names name, Action configureRequest, CancellationToken cancellationToken = default) @@ -10402,7 +14478,8 @@ public virtual Task ResolveClusterAsync(Elastic.Clients. /// /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Resolve indices. + /// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// Learn more about this API in the Elasticsearch documentation. @@ -10416,7 +14493,8 @@ public virtual ResolveIndexResponse ResolveIndex(ResolveIndexRequest request) /// /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Resolve indices. + /// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// Learn more about this API in the Elasticsearch documentation. @@ -10429,7 +14507,8 @@ public virtual Task ResolveIndexAsync(ResolveIndexRequest /// /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Resolve indices. + /// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// Learn more about this API in the Elasticsearch documentation. @@ -10443,7 +14522,8 @@ public virtual ResolveIndexResponse ResolveIndex(ResolveIndexRequestDescriptor d /// /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Resolve indices. + /// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// Learn more about this API in the Elasticsearch documentation. @@ -10458,7 +14538,8 @@ public virtual ResolveIndexResponse ResolveIndex(Elastic.Clients.Elasticsearch.N /// /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Resolve indices. + /// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// Learn more about this API in the Elasticsearch documentation. @@ -10474,7 +14555,8 @@ public virtual ResolveIndexResponse ResolveIndex(Elastic.Clients.Elasticsearch.N /// /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Resolve indices. + /// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// Learn more about this API in the Elasticsearch documentation. @@ -10487,7 +14569,8 @@ public virtual Task ResolveIndexAsync(ResolveIndexRequestD /// /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Resolve indices. + /// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// Learn more about this API in the Elasticsearch documentation. @@ -10501,7 +14584,8 @@ public virtual Task ResolveIndexAsync(Elastic.Clients.Elas /// /// - /// Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. + /// Resolve indices. + /// Resolve the names and/or index patterns for indices, aliases, and data streams. /// Multiple patterns and remote clusters are supported. /// /// Learn more about this API in the Elasticsearch documentation. @@ -10519,7 +14603,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 +14617,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 +14630,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 +14644,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 +14659,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 +14675,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 +14690,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 +14706,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 +14720,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 +14735,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 +14751,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 +14766,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 +14782,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 +14795,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 +14809,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 +14824,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 +14838,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 +14853,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 +14866,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 +14880,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 +14895,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 +14909,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) { @@ -10837,8 +14921,9 @@ public virtual Task RolloverAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10851,8 +14936,9 @@ public virtual SegmentsResponse Segments(SegmentsRequest request) /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10864,8 +14950,9 @@ public virtual Task SegmentsAsync(SegmentsRequest request, Can /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10878,8 +14965,9 @@ public virtual SegmentsResponse Segments(SegmentsRequestDescriptor /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10893,8 +14981,9 @@ public virtual SegmentsResponse Segments(Elastic.Clients.Elasticsearc /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10909,8 +14998,9 @@ public virtual SegmentsResponse Segments(Elastic.Clients.Elasticsearc /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10924,8 +15014,9 @@ public virtual SegmentsResponse Segments() /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10940,8 +15031,9 @@ public virtual SegmentsResponse Segments(Action /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10954,8 +15046,9 @@ public virtual SegmentsResponse Segments(SegmentsRequestDescriptor descriptor) /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10969,8 +15062,9 @@ public virtual SegmentsResponse Segments(Elastic.Clients.Elasticsearch.Indices? /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -10985,8 +15079,9 @@ public virtual SegmentsResponse Segments(Elastic.Clients.Elasticsearch.Indices? /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11000,8 +15095,9 @@ public virtual SegmentsResponse Segments() /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11016,8 +15112,9 @@ public virtual SegmentsResponse Segments(Action confi /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11029,8 +15126,9 @@ public virtual Task SegmentsAsync(SegmentsRequestDe /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11043,8 +15141,9 @@ public virtual Task SegmentsAsync(Elastic.Clients.E /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11058,8 +15157,9 @@ public virtual Task SegmentsAsync(Elastic.Clients.E /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11072,8 +15172,9 @@ public virtual Task SegmentsAsync(CancellationToken /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11087,8 +15188,9 @@ public virtual Task SegmentsAsync(Action /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11100,8 +15202,9 @@ public virtual Task SegmentsAsync(SegmentsRequestDescriptor de /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11114,8 +15217,9 @@ public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11129,8 +15233,9 @@ public virtual Task SegmentsAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11143,8 +15248,9 @@ public virtual Task SegmentsAsync(CancellationToken cancellati /// /// - /// Returns low-level information about the Lucene segments in index shards. - /// For data streams, the API returns information about the stream’s backing indices. + /// Get index segments. + /// Get low-level information about the Lucene segments in index shards. + /// For data streams, the API returns information about the stream's backing indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11158,8 +15264,37 @@ public virtual Task SegmentsAsync(Action /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11172,8 +15307,37 @@ public virtual ShardStoresResponse ShardStores(ShardStoresRequest request) /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11185,8 +15349,37 @@ public virtual Task ShardStoresAsync(ShardStoresRequest req /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11199,8 +15392,37 @@ public virtual ShardStoresResponse ShardStores(ShardStoresRequestDesc /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11214,8 +15436,37 @@ public virtual ShardStoresResponse ShardStores(Elastic.Clients.Elasti /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11230,8 +15481,37 @@ public virtual ShardStoresResponse ShardStores(Elastic.Clients.Elasti /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11245,8 +15525,37 @@ public virtual ShardStoresResponse ShardStores() /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11261,8 +15570,37 @@ public virtual ShardStoresResponse ShardStores(Action /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11275,8 +15613,37 @@ public virtual ShardStoresResponse ShardStores(ShardStoresRequestDescriptor desc /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11290,8 +15657,37 @@ public virtual ShardStoresResponse ShardStores(Elastic.Clients.Elasticsearch.Ind /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11306,8 +15702,37 @@ public virtual ShardStoresResponse ShardStores(Elastic.Clients.Elasticsearch.Ind /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11321,8 +15746,37 @@ public virtual ShardStoresResponse ShardStores() /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11337,8 +15791,37 @@ public virtual ShardStoresResponse ShardStores(Action /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11350,8 +15833,37 @@ public virtual Task ShardStoresAsync(ShardStores /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11364,8 +15876,37 @@ public virtual Task ShardStoresAsync(Elastic.Cli /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11379,8 +15920,37 @@ public virtual Task ShardStoresAsync(Elastic.Cli /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11393,13 +15963,42 @@ public virtual Task ShardStoresAsync(Cancellatio /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task ShardStoresAsync(Action> configureRequest, CancellationToken cancellationToken = default) - { + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task ShardStoresAsync(Action> configureRequest, CancellationToken cancellationToken = default) + { var descriptor = new ShardStoresRequestDescriptor(); configureRequest?.Invoke(descriptor); descriptor.BeforeRequest(); @@ -11408,8 +16007,37 @@ public virtual Task ShardStoresAsync(Action /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11421,8 +16049,37 @@ public virtual Task ShardStoresAsync(ShardStoresRequestDesc /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11435,8 +16092,37 @@ public virtual Task ShardStoresAsync(Elastic.Clients.Elasti /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11450,8 +16136,37 @@ public virtual Task ShardStoresAsync(Elastic.Clients.Elasti /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11464,8 +16179,37 @@ public virtual Task ShardStoresAsync(CancellationToken canc /// /// - /// Retrieves store information about replica shards in one or more indices. - /// For data streams, the API retrieves store information for the stream’s backing indices. + /// Get index shard stores. + /// Get store information about replica shards in one or more indices. + /// For data streams, the API retrieves store information for the stream's backing indices. + /// + /// + /// The index shard stores API returns the following information: + /// + /// + /// + /// + /// The node on which each replica shard exists. + /// + /// + /// + /// + /// The allocation ID for each replica shard. + /// + /// + /// + /// + /// A unique ID for each replica shard. + /// + /// + /// + /// + /// Any errors encountered while opening the shard index or from an earlier failure. + /// + /// + /// + /// + /// By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -11479,9 +16223,93 @@ public virtual Task ShardStoresAsync(Action /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + /// + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + /// + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) @@ -11492,9 +16320,93 @@ public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequest request) /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + /// + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + /// + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(ShrinkIndexRequest request, CancellationToken cancellationToken = default) { @@ -11504,9 +16416,93 @@ public virtual Task ShrinkAsync(ShrinkIndexRequest request, /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + /// + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + /// + /// + /// A shrink operation: /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) @@ -11517,9 +16513,93 @@ public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequestDescripto /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + /// + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) @@ -11531,9 +16611,93 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsear /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + /// + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) @@ -11546,23 +16710,191 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsear /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. /// - /// Learn more about this API in the Elasticsearch documentation. - /// - [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] - public virtual ShrinkIndexResponse Shrink(ShrinkIndexRequestDescriptor descriptor) - { - descriptor.BeforeRequest(); - return DoRequest(descriptor); - } - - /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Before you can shrink an index: /// - /// Learn more about this API in the Elasticsearch documentation. - /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + /// + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + /// + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) + { + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + /// + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + /// + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) { @@ -11573,9 +16905,93 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexNam /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + /// + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + /// + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) @@ -11588,9 +17004,93 @@ public virtual ShrinkIndexResponse Shrink(Elastic.Clients.Elasticsearch.IndexNam /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + /// + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + /// + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(ShrinkIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -11600,9 +17100,93 @@ public virtual Task ShrinkAsync(ShrinkIndexReque /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + /// + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + /// + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) { @@ -11613,9 +17197,93 @@ public virtual Task ShrinkAsync(Elastic.Clients. /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + /// + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) { @@ -11627,9 +17295,93 @@ public virtual Task ShrinkAsync(Elastic.Clients. /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + /// + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task ShrinkAsync(ShrinkIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -11639,9 +17391,93 @@ public virtual Task ShrinkAsync(ShrinkIndexRequestDescripto /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + /// + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + /// + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) { @@ -11652,9 +17488,93 @@ public virtual Task ShrinkAsync(Elastic.Clients.Elasticsear /// /// - /// Shrinks an existing index into a new index with fewer primary shards. + /// Shrink an index. + /// Shrink an index into a new index with fewer primary shards. + /// + /// + /// Before you can shrink an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// A copy of every shard in the index must reside on the same node. + /// + /// + /// + /// + /// The index must have a green health status. + /// + /// + /// + /// + /// To make shard allocation easier, we recommend you also remove the index's replica shards. + /// You can later re-add replica shards as part of the shrink operation. + /// + /// + /// The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + /// For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + /// If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + /// Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + /// + /// + /// The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + /// + /// + /// A shrink operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the .routing.allocation.initial_recovery._id index setting. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have more primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + /// + /// + /// + /// + /// The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) { @@ -12101,9 +18021,82 @@ public virtual Task SimulateTemplateAsync(Action /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. + /// + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing 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 SplitIndexResponse Split(SplitIndexRequest request) @@ -12114,9 +18107,82 @@ public virtual SplitIndexResponse Split(SplitIndexRequest request) /// /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(SplitIndexRequest request, CancellationToken cancellationToken = default) { @@ -12126,9 +18192,82 @@ public virtual Task SplitAsync(SplitIndexRequest request, Ca /// /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. + /// + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) @@ -12139,9 +18278,82 @@ public virtual SplitIndexResponse Split(SplitIndexRequestDescriptor /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. + /// + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) @@ -12153,9 +18365,82 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch /// /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. + /// + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) @@ -12168,9 +18453,82 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch /// /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. + /// + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) @@ -12181,9 +18539,82 @@ public virtual SplitIndexResponse Split(SplitIndexRequestDescriptor descriptor) /// /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. + /// + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) @@ -12195,9 +18626,82 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName /// /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. + /// + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) @@ -12210,21 +18714,167 @@ public virtual SplitIndexResponse Split(Elastic.Clients.Elasticsearch.IndexName /// /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. + /// + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task SplitAsync(SplitIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync, SplitIndexResponse, SplitIndexRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Split an index. + /// Split an index into a new index with more primary shards. + /// + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task SplitAsync(SplitIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) - { - descriptor.BeforeRequest(); - return DoRequestAsync, SplitIndexResponse, SplitIndexRequestParameters>(descriptor, cancellationToken); - } - - /// + /// + /// /// - /// Splits an existing index into a new index with more primary shards. + /// The source index must have fewer primary shards than the target index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) { @@ -12235,9 +18885,82 @@ public virtual Task SplitAsync(Elastic.Clients.El /// /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. + /// + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) { @@ -12249,9 +18972,82 @@ public virtual Task SplitAsync(Elastic.Clients.El /// /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. + /// + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task SplitAsync(SplitIndexRequestDescriptor descriptor, CancellationToken cancellationToken = default) { @@ -12261,9 +19057,82 @@ public virtual Task SplitAsync(SplitIndexRequestDescriptor d /// /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. + /// + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. /// - /// 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) { @@ -12274,9 +19143,82 @@ public virtual Task SplitAsync(Elastic.Clients.Elasticsearch /// /// - /// Splits an existing index into a new index with more primary shards. + /// Split an index. + /// Split an index into a new index with more primary shards. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// + /// + /// Before you can split an index: + /// + /// + /// + /// + /// The index must be read-only. + /// + /// + /// + /// + /// The cluster health status must be green. + /// + /// + /// + /// + /// The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the index.number_of_routing_shards setting. + /// The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + /// For instance, a 5 shard index with number_of_routing_shards set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + /// + /// + /// A split operation: + /// + /// + /// + /// + /// Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + /// + /// + /// + /// + /// Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + /// + /// + /// + /// + /// Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + /// + /// + /// + /// + /// Recovers the target index as though it were a closed index which had just been re-opened. + /// + /// + /// + /// + /// IMPORTANT: Indices can only be split if they satisfy the following requirements: + /// + /// + /// + /// + /// The target index must not exist. + /// + /// + /// + /// + /// The source index must have fewer primary shards than the target index. + /// + /// + /// + /// + /// The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + /// + /// + /// + /// + /// The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. + /// + /// + /// + /// 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) { @@ -12288,8 +19230,20 @@ public virtual Task SplitAsync(Elastic.Clients.Elasticsearch /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12302,8 +19256,20 @@ public virtual IndicesStatsResponse Stats(IndicesStatsRequest request) /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12315,8 +19281,20 @@ public virtual Task StatsAsync(IndicesStatsRequest request /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12329,8 +19307,20 @@ public virtual IndicesStatsResponse Stats(IndicesStatsRequestDescript /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12344,8 +19334,20 @@ public virtual IndicesStatsResponse Stats(Elastic.Clients.Elasticsear /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12360,8 +19362,20 @@ public virtual IndicesStatsResponse Stats(Elastic.Clients.Elasticsear /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12375,8 +19389,20 @@ public virtual IndicesStatsResponse Stats() /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12391,8 +19417,20 @@ public virtual IndicesStatsResponse Stats(Action /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12405,8 +19443,20 @@ public virtual IndicesStatsResponse Stats(IndicesStatsRequestDescriptor descript /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12420,8 +19470,20 @@ public virtual IndicesStatsResponse Stats(Elastic.Clients.Elasticsearch.Indices? /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12436,8 +19498,20 @@ public virtual IndicesStatsResponse Stats(Elastic.Clients.Elasticsearch.Indices? /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12451,8 +19525,20 @@ public virtual IndicesStatsResponse Stats() /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12467,8 +19553,20 @@ public virtual IndicesStatsResponse Stats(Action /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12480,8 +19578,20 @@ public virtual Task StatsAsync(IndicesStatsRequ /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12494,8 +19604,20 @@ public virtual Task StatsAsync(Elastic.Clients. /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12509,8 +19631,20 @@ public virtual Task StatsAsync(Elastic.Clients. /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12523,8 +19657,20 @@ public virtual Task StatsAsync(CancellationToke /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12538,8 +19684,20 @@ public virtual Task StatsAsync(Action /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12551,8 +19709,20 @@ public virtual Task StatsAsync(IndicesStatsRequestDescript /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12565,8 +19735,20 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12580,8 +19762,20 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsear /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -12594,8 +19788,20 @@ public virtual Task StatsAsync(CancellationToken cancellat /// /// - /// Returns statistics for one or more indices. - /// For data streams, the API retrieves statistics for the stream’s backing indices. + /// Get index statistics. + /// For data streams, the API retrieves statistics for the stream's backing indices. + /// + /// + /// By default, the returned statistics are index-level with primaries and total aggregations. + /// primaries are the values for only the primary shards. + /// total are the accumulated values for both primary and replica shards. + /// + /// + /// To get shard-level statistics, set the level parameter to shards. + /// + /// + /// NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + /// Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Inference.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Inference.g.cs index d6d2bd5eb7b..42d1bec24e3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Inference.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Inference.g.cs @@ -527,7 +527,17 @@ public virtual Task InferenceAsync(Elastic.Clients.Elasticsea /// /// - /// Create an inference endpoint + /// Create an inference endpoint. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -540,7 +550,17 @@ public virtual PutInferenceResponse Put(PutInferenceRequest request) /// /// - /// Create an inference endpoint + /// Create an inference endpoint. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -552,7 +572,17 @@ public virtual Task PutAsync(PutInferenceRequest request, /// /// - /// Create an inference endpoint + /// Create an inference endpoint. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -565,7 +595,17 @@ public virtual PutInferenceResponse Put(PutInferenceRequestDescriptor descriptor /// /// - /// Create an inference endpoint + /// Create an inference endpoint. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -579,7 +619,17 @@ public virtual PutInferenceResponse Put(Elastic.Clients.Elasticsearch.Inference. /// /// - /// Create an inference endpoint + /// Create an inference endpoint. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -594,7 +644,17 @@ public virtual PutInferenceResponse Put(Elastic.Clients.Elasticsearch.Inference. /// /// - /// Create an inference endpoint + /// Create an inference endpoint. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -608,7 +668,17 @@ public virtual PutInferenceResponse Put(Elastic.Clients.Elasticsearch.Inference. /// /// - /// Create an inference endpoint + /// Create an inference endpoint. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -623,7 +693,17 @@ public virtual PutInferenceResponse Put(Elastic.Clients.Elasticsearch.Inference. /// /// - /// Create an inference endpoint + /// Create an inference endpoint. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -635,7 +715,17 @@ public virtual Task PutAsync(PutInferenceRequestDescriptor /// /// - /// Create an inference endpoint + /// Create an inference endpoint. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -648,7 +738,17 @@ public virtual Task PutAsync(Elastic.Clients.Elasticsearch /// /// - /// Create an inference endpoint + /// Create an inference endpoint. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -662,7 +762,17 @@ public virtual Task PutAsync(Elastic.Clients.Elasticsearch /// /// - /// Create an inference endpoint + /// Create an inference endpoint. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -675,7 +785,17 @@ public virtual Task PutAsync(Elastic.Clients.Elasticsearch /// /// - /// Create an inference endpoint + /// Create an inference endpoint. + /// When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. + /// After creating the endpoint, wait for the model deployment to complete before using it. + /// To verify the deployment status, use the get trained model statistics API. + /// Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". + /// Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + /// + /// + /// IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + /// For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + /// However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 c9102687c74..dd4bc32e2a3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ingest.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Ingest.g.cs @@ -41,7 +41,8 @@ internal IngestNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +55,8 @@ public virtual DeleteGeoipDatabaseResponse DeleteGeoipDatabase(DeleteGeoipDataba /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +68,8 @@ public virtual Task DeleteGeoipDatabaseAsync(Delete /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +82,8 @@ public virtual DeleteGeoipDatabaseResponse DeleteGeoipDatabase(Delete /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +97,8 @@ public virtual DeleteGeoipDatabaseResponse DeleteGeoipDatabase(Elasti /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +113,8 @@ public virtual DeleteGeoipDatabaseResponse DeleteGeoipDatabase(Elasti /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -121,7 +127,8 @@ public virtual DeleteGeoipDatabaseResponse DeleteGeoipDatabase(DeleteGeoipDataba /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -135,7 +142,8 @@ public virtual DeleteGeoipDatabaseResponse DeleteGeoipDatabase(Elastic.Clients.E /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -150,7 +158,8 @@ public virtual DeleteGeoipDatabaseResponse DeleteGeoipDatabase(Elastic.Clients.E /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -162,7 +171,8 @@ public virtual Task DeleteGeoipDatabaseAsync /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -175,7 +185,8 @@ public virtual Task DeleteGeoipDatabaseAsync /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -189,7 +200,8 @@ public virtual Task DeleteGeoipDatabaseAsync /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -201,7 +213,8 @@ public virtual Task DeleteGeoipDatabaseAsync(Delete /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -214,7 +227,8 @@ public virtual Task DeleteGeoipDatabaseAsync(Elasti /// /// - /// Deletes a geoip database configuration. + /// Delete GeoIP database configurations. + /// Delete one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -228,7 +242,195 @@ public virtual Task DeleteGeoipDatabaseAsync(Elasti /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual DeleteIpLocationDatabaseResponse DeleteIpLocationDatabase(DeleteIpLocationDatabaseRequest request) + { + request.BeforeRequest(); + return DoRequest(request); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(DeleteIpLocationDatabaseRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual DeleteIpLocationDatabaseResponse DeleteIpLocationDatabase(DeleteIpLocationDatabaseRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest, DeleteIpLocationDatabaseResponse, DeleteIpLocationDatabaseRequestParameters>(descriptor); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual DeleteIpLocationDatabaseResponse DeleteIpLocationDatabase(Elastic.Clients.Elasticsearch.Ids id) + { + var descriptor = new DeleteIpLocationDatabaseRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequest, DeleteIpLocationDatabaseResponse, DeleteIpLocationDatabaseRequestParameters>(descriptor); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual DeleteIpLocationDatabaseResponse DeleteIpLocationDatabase(Elastic.Clients.Elasticsearch.Ids id, Action> configureRequest) + { + var descriptor = new DeleteIpLocationDatabaseRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest, DeleteIpLocationDatabaseResponse, DeleteIpLocationDatabaseRequestParameters>(descriptor); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual DeleteIpLocationDatabaseResponse DeleteIpLocationDatabase(DeleteIpLocationDatabaseRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual DeleteIpLocationDatabaseResponse DeleteIpLocationDatabase(Elastic.Clients.Elasticsearch.Ids id) + { + var descriptor = new DeleteIpLocationDatabaseRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual DeleteIpLocationDatabaseResponse DeleteIpLocationDatabase(Elastic.Clients.Elasticsearch.Ids id, Action configureRequest) + { + var descriptor = new DeleteIpLocationDatabaseRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(DeleteIpLocationDatabaseRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync, DeleteIpLocationDatabaseResponse, DeleteIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Ids id, CancellationToken cancellationToken = default) + { + var descriptor = new DeleteIpLocationDatabaseRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequestAsync, DeleteIpLocationDatabaseResponse, DeleteIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Ids id, Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new DeleteIpLocationDatabaseRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, DeleteIpLocationDatabaseResponse, DeleteIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(DeleteIpLocationDatabaseRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Ids id, CancellationToken cancellationToken = default) + { + var descriptor = new DeleteIpLocationDatabaseRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Delete IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task DeleteIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Ids id, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new DeleteIpLocationDatabaseRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -241,7 +443,8 @@ public virtual DeletePipelineResponse DeletePipeline(DeletePipelineRequest reque /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -253,7 +456,8 @@ public virtual Task DeletePipelineAsync(DeletePipelineRe /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -266,7 +470,8 @@ public virtual DeletePipelineResponse DeletePipeline(DeletePipelineRe /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -280,7 +485,8 @@ public virtual DeletePipelineResponse DeletePipeline(Elastic.Clients. /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -295,7 +501,8 @@ public virtual DeletePipelineResponse DeletePipeline(Elastic.Clients. /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -308,7 +515,8 @@ public virtual DeletePipelineResponse DeletePipeline(DeletePipelineRequestDescri /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -322,7 +530,8 @@ public virtual DeletePipelineResponse DeletePipeline(Elastic.Clients.Elasticsear /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -337,7 +546,8 @@ public virtual DeletePipelineResponse DeletePipeline(Elastic.Clients.Elasticsear /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -349,7 +559,8 @@ public virtual Task DeletePipelineAsync(Delet /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -362,7 +573,8 @@ public virtual Task DeletePipelineAsync(Elast /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -376,7 +588,8 @@ public virtual Task DeletePipelineAsync(Elast /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -388,7 +601,8 @@ public virtual Task DeletePipelineAsync(DeletePipelineRe /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -401,7 +615,8 @@ public virtual Task DeletePipelineAsync(Elastic.Clients. /// /// - /// Deletes one or more existing ingest pipeline. + /// Delete pipelines. + /// Delete one or more ingest pipelines. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -415,9 +630,10 @@ public virtual Task DeletePipelineAsync(Elastic.Clients. /// /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// Get GeoIP statistics. + /// Get download statistics for GeoIP2 databases that are 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) @@ -428,9 +644,10 @@ public virtual GeoIpStatsResponse GeoIpStats(GeoIpStatsRequest request) /// /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// Get GeoIP statistics. + /// Get download statistics for GeoIP2 databases that are 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) { @@ -440,9 +657,10 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequest reques /// /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// Get GeoIP statistics. + /// Get download statistics for GeoIP2 databases that are 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) @@ -453,9 +671,10 @@ public virtual GeoIpStatsResponse GeoIpStats(GeoIpStatsRequestDescriptor descrip /// /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// Get GeoIP statistics. + /// Get download statistics for GeoIP2 databases that are 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() @@ -467,9 +686,10 @@ public virtual GeoIpStatsResponse GeoIpStats() /// /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// Get GeoIP statistics. + /// Get download statistics for GeoIP2 databases that are 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) @@ -482,9 +702,10 @@ public virtual GeoIpStatsResponse GeoIpStats(Action /// /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// Get GeoIP statistics. + /// Get download statistics for GeoIP2 databases that are 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) { @@ -494,9 +715,10 @@ public virtual Task GeoIpStatsAsync(GeoIpStatsRequestDescrip /// /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// Get GeoIP statistics. + /// Get download statistics for GeoIP2 databases that are 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) { @@ -507,9 +729,10 @@ public virtual Task GeoIpStatsAsync(CancellationToken cancel /// /// - /// Gets download statistics for GeoIP2 databases used with the geoip processor. + /// Get GeoIP statistics. + /// Get download statistics for GeoIP2 databases that are 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) { @@ -521,7 +744,8 @@ public virtual Task GeoIpStatsAsync(Action /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -534,7 +758,8 @@ public virtual GetGeoipDatabaseResponse GetGeoipDatabase(GetGeoipDatabaseRequest /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -546,7 +771,8 @@ public virtual Task GetGeoipDatabaseAsync(GetGeoipData /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -559,7 +785,8 @@ public virtual GetGeoipDatabaseResponse GetGeoipDatabase(GetGeoipData /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -573,7 +800,8 @@ public virtual GetGeoipDatabaseResponse GetGeoipDatabase(Elastic.Clie /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -588,7 +816,8 @@ public virtual GetGeoipDatabaseResponse GetGeoipDatabase(Elastic.Clie /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -602,7 +831,8 @@ public virtual GetGeoipDatabaseResponse GetGeoipDatabase() /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -617,7 +847,8 @@ public virtual GetGeoipDatabaseResponse GetGeoipDatabase(Action /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -630,7 +861,8 @@ public virtual GetGeoipDatabaseResponse GetGeoipDatabase(GetGeoipDatabaseRequest /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -644,7 +876,8 @@ public virtual GetGeoipDatabaseResponse GetGeoipDatabase(Elastic.Clients.Elastic /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -659,7 +892,8 @@ public virtual GetGeoipDatabaseResponse GetGeoipDatabase(Elastic.Clients.Elastic /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -673,7 +907,8 @@ public virtual GetGeoipDatabaseResponse GetGeoipDatabase() /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -688,7 +923,8 @@ public virtual GetGeoipDatabaseResponse GetGeoipDatabase(Action /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -700,7 +936,8 @@ public virtual Task GetGeoipDatabaseAsync(G /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -713,7 +950,8 @@ public virtual Task GetGeoipDatabaseAsync(E /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -727,7 +965,8 @@ public virtual Task GetGeoipDatabaseAsync(E /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -740,7 +979,8 @@ public virtual Task GetGeoipDatabaseAsync(C /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -754,7 +994,8 @@ public virtual Task GetGeoipDatabaseAsync(A /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -766,7 +1007,8 @@ public virtual Task GetGeoipDatabaseAsync(GetGeoipData /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -779,7 +1021,8 @@ public virtual Task GetGeoipDatabaseAsync(Elastic.Clie /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -793,7 +1036,8 @@ public virtual Task GetGeoipDatabaseAsync(Elastic.Clie /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -806,7 +1050,8 @@ public virtual Task GetGeoipDatabaseAsync(Cancellation /// /// - /// Returns information about one or more geoip database configurations. + /// Get GeoIP database configurations. + /// Get information about one or more IP geolocation database configurations. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -820,7 +1065,307 @@ public virtual Task GetGeoipDatabaseAsync(Action /// - /// Returns information about one or more ingest pipelines. + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual GetIpLocationDatabaseResponse GetIpLocationDatabase(GetIpLocationDatabaseRequest request) + { + request.BeforeRequest(); + return DoRequest(request); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(GetIpLocationDatabaseRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual GetIpLocationDatabaseResponse GetIpLocationDatabase(GetIpLocationDatabaseRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual GetIpLocationDatabaseResponse GetIpLocationDatabase(Elastic.Clients.Elasticsearch.Ids? id) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequest, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual GetIpLocationDatabaseResponse GetIpLocationDatabase(Elastic.Clients.Elasticsearch.Ids? id, Action> configureRequest) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual GetIpLocationDatabaseResponse GetIpLocationDatabase() + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequest, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual GetIpLocationDatabaseResponse GetIpLocationDatabase(Action> configureRequest) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual GetIpLocationDatabaseResponse GetIpLocationDatabase(GetIpLocationDatabaseRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual GetIpLocationDatabaseResponse GetIpLocationDatabase(Elastic.Clients.Elasticsearch.Ids? id) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual GetIpLocationDatabaseResponse GetIpLocationDatabase(Elastic.Clients.Elasticsearch.Ids? id, Action configureRequest) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual GetIpLocationDatabaseResponse GetIpLocationDatabase() + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual GetIpLocationDatabaseResponse GetIpLocationDatabase(Action configureRequest) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(GetIpLocationDatabaseRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Ids? id, CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequestAsync, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Ids? id, Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequestAsync, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, GetIpLocationDatabaseResponse, GetIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(GetIpLocationDatabaseRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Ids? id, CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(id); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Ids? id, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get IP geolocation database configurations. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task GetIpLocationDatabaseAsync(Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new GetIpLocationDatabaseRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -834,7 +1379,8 @@ public virtual GetPipelineResponse GetPipeline(GetPipelineRequest request) /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -847,7 +1393,8 @@ public virtual Task GetPipelineAsync(GetPipelineRequest req /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -861,7 +1408,8 @@ public virtual GetPipelineResponse GetPipeline(GetPipelineRequestDesc /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -876,7 +1424,8 @@ public virtual GetPipelineResponse GetPipeline(Elastic.Clients.Elasti /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -892,7 +1441,8 @@ public virtual GetPipelineResponse GetPipeline(Elastic.Clients.Elasti /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -907,7 +1457,8 @@ public virtual GetPipelineResponse GetPipeline() /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -923,7 +1474,8 @@ public virtual GetPipelineResponse GetPipeline(Action /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -937,7 +1489,8 @@ public virtual GetPipelineResponse GetPipeline(GetPipelineRequestDescriptor desc /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -952,7 +1505,8 @@ public virtual GetPipelineResponse GetPipeline(Elastic.Clients.Elasticsearch.Id? /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -968,7 +1522,8 @@ public virtual GetPipelineResponse GetPipeline(Elastic.Clients.Elasticsearch.Id? /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -983,7 +1538,8 @@ public virtual GetPipelineResponse GetPipeline() /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -999,7 +1555,8 @@ public virtual GetPipelineResponse GetPipeline(Action /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -1012,7 +1569,8 @@ public virtual Task GetPipelineAsync(GetPipeline /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -1026,7 +1584,8 @@ public virtual Task GetPipelineAsync(Elastic.Cli /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -1041,7 +1600,8 @@ public virtual Task GetPipelineAsync(Elastic.Cli /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -1055,7 +1615,8 @@ public virtual Task GetPipelineAsync(Cancellatio /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -1070,7 +1631,8 @@ public virtual Task GetPipelineAsync(Action /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -1083,7 +1645,8 @@ public virtual Task GetPipelineAsync(GetPipelineRequestDesc /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -1097,7 +1660,8 @@ public virtual Task GetPipelineAsync(Elastic.Clients.Elasti /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -1112,7 +1676,8 @@ public virtual Task GetPipelineAsync(Elastic.Clients.Elasti /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -1126,7 +1691,8 @@ public virtual Task GetPipelineAsync(CancellationToken canc /// /// - /// Returns information about one or more ingest pipelines. + /// Get pipelines. + /// Get information about one or more ingest pipelines. /// This API returns a local reference of the pipeline. /// /// Learn more about this API in the Elasticsearch documentation. @@ -1141,11 +1707,12 @@ public virtual Task GetPipelineAsync(Action /// - /// Extracts structured fields out of a single text field within a document. - /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// Run a grok processor. + /// Extract structured fields out of a single text field within a document. + /// You must 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(ProcessorGrokRequest request) @@ -1156,11 +1723,12 @@ public virtual ProcessorGrokResponse ProcessorGrok(ProcessorGrokRequest request) /// /// - /// Extracts structured fields out of a single text field within a document. - /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// Run a grok processor. + /// Extract structured fields out of a single text field within a document. + /// You must 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) { @@ -1170,11 +1738,12 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque /// /// - /// Extracts structured fields out of a single text field within a document. - /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// Run a grok processor. + /// Extract structured fields out of a single text field within a document. + /// You must 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) @@ -1185,11 +1754,12 @@ public virtual ProcessorGrokResponse ProcessorGrok(ProcessorGrokRequestDescripto /// /// - /// Extracts structured fields out of a single text field within a document. - /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// Run a grok processor. + /// Extract structured fields out of a single text field within a document. + /// You must 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() @@ -1201,11 +1771,12 @@ public virtual ProcessorGrokResponse ProcessorGrok() /// /// - /// Extracts structured fields out of a single text field within a document. - /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// Run a grok processor. + /// Extract structured fields out of a single text field within a document. + /// You must 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) @@ -1218,11 +1789,12 @@ public virtual ProcessorGrokResponse ProcessorGrok(Action /// - /// Extracts structured fields out of a single text field within a document. - /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// Run a grok processor. + /// Extract structured fields out of a single text field within a document. + /// You must 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) { @@ -1232,11 +1804,12 @@ public virtual Task ProcessorGrokAsync(ProcessorGrokReque /// /// - /// Extracts structured fields out of a single text field within a document. - /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// Run a grok processor. + /// Extract structured fields out of a single text field within a document. + /// You must 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) { @@ -1247,11 +1820,12 @@ public virtual Task ProcessorGrokAsync(CancellationToken /// /// - /// Extracts structured fields out of a single text field within a document. - /// You choose which field to extract matched fields from, as well as the grok pattern you expect will match. + /// Run a grok processor. + /// Extract structured fields out of a single text field within a document. + /// You must 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) { @@ -1263,7 +1837,8 @@ public virtual Task ProcessorGrokAsync(Action /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1276,7 +1851,8 @@ public virtual PutGeoipDatabaseResponse PutGeoipDatabase(PutGeoipDatabaseRequest /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1288,7 +1864,8 @@ public virtual Task PutGeoipDatabaseAsync(PutGeoipData /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1301,7 +1878,8 @@ public virtual PutGeoipDatabaseResponse PutGeoipDatabase(PutGeoipData /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1315,7 +1893,8 @@ public virtual PutGeoipDatabaseResponse PutGeoipDatabase(Elastic.Clie /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1330,7 +1909,8 @@ public virtual PutGeoipDatabaseResponse PutGeoipDatabase(Elastic.Clie /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1343,7 +1923,8 @@ public virtual PutGeoipDatabaseResponse PutGeoipDatabase(PutGeoipDatabaseRequest /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1357,7 +1938,8 @@ public virtual PutGeoipDatabaseResponse PutGeoipDatabase(Elastic.Clients.Elastic /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1372,7 +1954,8 @@ public virtual PutGeoipDatabaseResponse PutGeoipDatabase(Elastic.Clients.Elastic /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1384,7 +1967,8 @@ public virtual Task PutGeoipDatabaseAsync(P /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1397,7 +1981,8 @@ public virtual Task PutGeoipDatabaseAsync(E /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1411,7 +1996,8 @@ public virtual Task PutGeoipDatabaseAsync(E /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1423,7 +2009,8 @@ public virtual Task PutGeoipDatabaseAsync(PutGeoipData /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1436,7 +2023,8 @@ public virtual Task PutGeoipDatabaseAsync(Elastic.Clie /// /// - /// Returns information about one or more geoip database configurations. + /// Create or update a GeoIP database configuration. + /// Refer to the create or update IP geolocation database configuration API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1450,10 +2038,197 @@ public virtual Task PutGeoipDatabaseAsync(Elastic.Clie /// /// - /// Creates or updates an ingest pipeline. + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual PutIpLocationDatabaseResponse PutIpLocationDatabase(PutIpLocationDatabaseRequest request) + { + request.BeforeRequest(); + return DoRequest(request); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(PutIpLocationDatabaseRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual PutIpLocationDatabaseResponse PutIpLocationDatabase(PutIpLocationDatabaseRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest, PutIpLocationDatabaseResponse, PutIpLocationDatabaseRequestParameters>(descriptor); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual PutIpLocationDatabaseResponse PutIpLocationDatabase(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Id id) + { + var descriptor = new PutIpLocationDatabaseRequestDescriptor(configuration, id); + descriptor.BeforeRequest(); + return DoRequest, PutIpLocationDatabaseResponse, PutIpLocationDatabaseRequestParameters>(descriptor); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual PutIpLocationDatabaseResponse PutIpLocationDatabase(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest) + { + var descriptor = new PutIpLocationDatabaseRequestDescriptor(configuration, id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest, PutIpLocationDatabaseResponse, PutIpLocationDatabaseRequestParameters>(descriptor); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual PutIpLocationDatabaseResponse PutIpLocationDatabase(PutIpLocationDatabaseRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual PutIpLocationDatabaseResponse PutIpLocationDatabase(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Id id) + { + var descriptor = new PutIpLocationDatabaseRequestDescriptor(configuration, id); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual PutIpLocationDatabaseResponse PutIpLocationDatabase(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Id id, Action configureRequest) + { + var descriptor = new PutIpLocationDatabaseRequestDescriptor(configuration, id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(PutIpLocationDatabaseRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync, PutIpLocationDatabaseResponse, PutIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) + { + var descriptor = new PutIpLocationDatabaseRequestDescriptor(configuration, id); + descriptor.BeforeRequest(); + return DoRequestAsync, PutIpLocationDatabaseResponse, PutIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new PutIpLocationDatabaseRequestDescriptor(configuration, id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, PutIpLocationDatabaseResponse, PutIpLocationDatabaseRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(PutIpLocationDatabaseRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) + { + var descriptor = new PutIpLocationDatabaseRequestDescriptor(configuration, id); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create or update an IP geolocation database configuration. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task PutIpLocationDatabaseAsync(Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration configuration, Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new PutIpLocationDatabaseRequestDescriptor(configuration, id); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Create or update a 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) @@ -1464,10 +2239,10 @@ public virtual PutPipelineResponse PutPipeline(PutPipelineRequest request) /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -1477,10 +2252,10 @@ public virtual Task PutPipelineAsync(PutPipelineRequest req /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) @@ -1491,10 +2266,10 @@ public virtual PutPipelineResponse PutPipeline(PutPipelineRequestDesc /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) @@ -1506,10 +2281,10 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasti /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) @@ -1522,10 +2297,10 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasti /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) @@ -1536,10 +2311,10 @@ public virtual PutPipelineResponse PutPipeline(PutPipelineRequestDescriptor desc /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) @@ -1551,10 +2326,10 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) @@ -1567,10 +2342,10 @@ public virtual PutPipelineResponse PutPipeline(Elastic.Clients.Elasticsearch.Id /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -1580,10 +2355,10 @@ public virtual Task PutPipelineAsync(PutPipeline /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -1594,10 +2369,10 @@ public virtual Task PutPipelineAsync(Elastic.Cli /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -1609,10 +2384,10 @@ public virtual Task PutPipelineAsync(Elastic.Cli /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -1622,10 +2397,10 @@ public virtual Task PutPipelineAsync(PutPipelineRequestDesc /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -1636,10 +2411,10 @@ public virtual Task PutPipelineAsync(Elastic.Clients.Elasti /// /// - /// Creates or updates an ingest pipeline. + /// Create or update a 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) { @@ -1651,7 +2426,9 @@ public virtual Task PutPipelineAsync(Elastic.Clients.Elasti /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1664,7 +2441,9 @@ public virtual SimulateResponse Simulate(SimulateRequest request) /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1676,7 +2455,9 @@ public virtual Task SimulateAsync(SimulateRequest request, Can /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1689,7 +2470,9 @@ public virtual SimulateResponse Simulate(SimulateRequestDescriptor /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1703,7 +2486,9 @@ public virtual SimulateResponse Simulate(Elastic.Clients.Elasticsearc /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1718,7 +2503,9 @@ public virtual SimulateResponse Simulate(Elastic.Clients.Elasticsearc /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1732,7 +2519,9 @@ public virtual SimulateResponse Simulate() /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1747,7 +2536,9 @@ public virtual SimulateResponse Simulate(Action /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1760,7 +2551,9 @@ public virtual SimulateResponse Simulate(SimulateRequestDescriptor descriptor) /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1774,7 +2567,9 @@ public virtual SimulateResponse Simulate(Elastic.Clients.Elasticsearch.Id? id) /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1789,7 +2584,9 @@ public virtual SimulateResponse Simulate(Elastic.Clients.Elasticsearch.Id? id, A /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1803,7 +2600,9 @@ public virtual SimulateResponse Simulate() /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1818,7 +2617,9 @@ public virtual SimulateResponse Simulate(Action confi /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1830,7 +2631,9 @@ public virtual Task SimulateAsync(SimulateRequestDe /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1843,7 +2646,9 @@ public virtual Task SimulateAsync(Elastic.Clients.E /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1857,7 +2662,9 @@ public virtual Task SimulateAsync(Elastic.Clients.E /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1870,7 +2677,9 @@ public virtual Task SimulateAsync(CancellationToken /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1884,7 +2693,9 @@ public virtual Task SimulateAsync(Action /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1896,7 +2707,9 @@ public virtual Task SimulateAsync(SimulateRequestDescriptor de /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1909,7 +2722,9 @@ public virtual Task SimulateAsync(Elastic.Clients.Elasticsearc /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1923,7 +2738,9 @@ public virtual Task SimulateAsync(Elastic.Clients.Elasticsearc /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1936,7 +2753,9 @@ public virtual Task SimulateAsync(CancellationToken cancellati /// /// - /// Executes an ingest pipeline against a set of provided documents. + /// Simulate a pipeline. + /// Run an ingest pipeline against a set of provided documents. + /// You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.License.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.License.g.cs index d1a8a6d4843..af43b48f478 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.License.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.License.g.cs @@ -41,7 +41,11 @@ internal LicenseManagementNamespacedClient(ElasticsearchClient client) : base(cl /// /// - /// Deletes licensing information for the cluster + /// Delete the license. + /// When the license expires, your subscription level reverts to Basic. + /// + /// + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +58,11 @@ public virtual DeleteLicenseResponse Delete(DeleteLicenseRequest request) /// /// - /// Deletes licensing information for the cluster + /// Delete the license. + /// When the license expires, your subscription level reverts to Basic. + /// + /// + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +74,11 @@ public virtual Task DeleteAsync(DeleteLicenseRequest requ /// /// - /// Deletes licensing information for the cluster + /// Delete the license. + /// When the license expires, your subscription level reverts to Basic. + /// + /// + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +91,11 @@ public virtual DeleteLicenseResponse Delete(DeleteLicenseRequestDescriptor descr /// /// - /// Deletes licensing information for the cluster + /// Delete the license. + /// When the license expires, your subscription level reverts to Basic. + /// + /// + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +109,11 @@ public virtual DeleteLicenseResponse Delete() /// /// - /// Deletes licensing information for the cluster + /// Delete the license. + /// When the license expires, your subscription level reverts to Basic. + /// + /// + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +128,11 @@ public virtual DeleteLicenseResponse Delete(Action /// - /// Deletes licensing information for the cluster + /// Delete the license. + /// When the license expires, your subscription level reverts to Basic. + /// + /// + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -120,7 +144,11 @@ public virtual Task DeleteAsync(DeleteLicenseRequestDescr /// /// - /// Deletes licensing information for the cluster + /// Delete the license. + /// When the license expires, your subscription level reverts to Basic. + /// + /// + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -133,7 +161,11 @@ public virtual Task DeleteAsync(CancellationToken cancell /// /// - /// Deletes licensing information for the cluster + /// Delete the license. + /// When the license expires, your subscription level reverts to Basic. + /// + /// + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -148,8 +180,11 @@ public virtual Task DeleteAsync(Action /// /// Get license information. - /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + /// + /// + /// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. + /// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -163,8 +198,11 @@ public virtual GetLicenseResponse Get(GetLicenseRequest request) /// /// /// Get license information. - /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + /// + /// + /// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. + /// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -177,8 +215,11 @@ public virtual Task GetAsync(GetLicenseRequest request, Canc /// /// /// Get license information. - /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + /// + /// + /// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. + /// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -192,8 +233,11 @@ public virtual GetLicenseResponse Get(GetLicenseRequestDescriptor descriptor) /// /// /// Get license information. - /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + /// + /// + /// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. + /// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -208,8 +252,11 @@ public virtual GetLicenseResponse Get() /// /// /// Get license information. - /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + /// + /// + /// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. + /// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -225,8 +272,11 @@ public virtual GetLicenseResponse Get(Action config /// /// /// Get license information. - /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + /// + /// + /// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. + /// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -239,8 +289,11 @@ public virtual Task GetAsync(GetLicenseRequestDescriptor des /// /// /// Get license information. - /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + /// + /// + /// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. + /// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -254,8 +307,11 @@ public virtual Task GetAsync(CancellationToken cancellationT /// /// /// Get license information. - /// Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - /// For more information about the different types of licenses, refer to Elastic Stack subscriptions. + /// Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + /// + /// + /// NOTE: If the master node is generating a new cluster state, the get license API may return a 404 Not Found response. + /// If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -269,7 +325,7 @@ public virtual Task GetAsync(Action /// - /// Retrieves information about the status of the basic license. + /// Get the basic license status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -282,7 +338,7 @@ public virtual GetBasicStatusResponse GetBasicStatus(GetBasicStatusRequest reque /// /// - /// Retrieves information about the status of the basic license. + /// Get the basic license status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -294,7 +350,7 @@ public virtual Task GetBasicStatusAsync(GetBasicStatusRe /// /// - /// Retrieves information about the status of the basic license. + /// Get the basic license status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -307,7 +363,7 @@ public virtual GetBasicStatusResponse GetBasicStatus(GetBasicStatusRequestDescri /// /// - /// Retrieves information about the status of the basic license. + /// Get the basic license status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -321,7 +377,7 @@ public virtual GetBasicStatusResponse GetBasicStatus() /// /// - /// Retrieves information about the status of the basic license. + /// Get the basic license status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -336,7 +392,7 @@ public virtual GetBasicStatusResponse GetBasicStatus(Action /// - /// Retrieves information about the status of the basic license. + /// Get the basic license status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -348,7 +404,7 @@ public virtual Task GetBasicStatusAsync(GetBasicStatusRe /// /// - /// Retrieves information about the status of the basic license. + /// Get the basic license status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -361,7 +417,7 @@ public virtual Task GetBasicStatusAsync(CancellationToke /// /// - /// Retrieves information about the status of the basic license. + /// Get the basic license status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -375,7 +431,7 @@ public virtual Task GetBasicStatusAsync(Action /// - /// Retrieves information about the status of the trial license. + /// Get the trial status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -388,7 +444,7 @@ public virtual GetTrialStatusResponse GetTrialStatus(GetTrialStatusRequest reque /// /// - /// Retrieves information about the status of the trial license. + /// Get the trial status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -400,7 +456,7 @@ public virtual Task GetTrialStatusAsync(GetTrialStatusRe /// /// - /// Retrieves information about the status of the trial license. + /// Get the trial status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -413,7 +469,7 @@ public virtual GetTrialStatusResponse GetTrialStatus(GetTrialStatusRequestDescri /// /// - /// Retrieves information about the status of the trial license. + /// Get the trial status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -427,7 +483,7 @@ public virtual GetTrialStatusResponse GetTrialStatus() /// /// - /// Retrieves information about the status of the trial license. + /// Get the trial status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -442,7 +498,7 @@ public virtual GetTrialStatusResponse GetTrialStatus(Action /// - /// Retrieves information about the status of the trial license. + /// Get the trial status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -454,7 +510,7 @@ public virtual Task GetTrialStatusAsync(GetTrialStatusRe /// /// - /// Retrieves information about the status of the trial license. + /// Get the trial status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -467,7 +523,7 @@ public virtual Task GetTrialStatusAsync(CancellationToke /// /// - /// Retrieves information about the status of the trial license. + /// Get the trial status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -481,7 +537,15 @@ public virtual Task GetTrialStatusAsync(Action /// - /// Updates the license for the cluster. + /// Update the license. + /// You can update your license at runtime without shutting down your nodes. + /// License updates take effect immediately. + /// If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -494,7 +558,15 @@ public virtual PostResponse Post(PostRequest request) /// /// - /// Updates the license for the cluster. + /// Update the license. + /// You can update your license at runtime without shutting down your nodes. + /// License updates take effect immediately. + /// If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -506,7 +578,15 @@ public virtual Task PostAsync(PostRequest request, CancellationTok /// /// - /// Updates the license for the cluster. + /// Update the license. + /// You can update your license at runtime without shutting down your nodes. + /// License updates take effect immediately. + /// If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -519,7 +599,15 @@ public virtual PostResponse Post(PostRequestDescriptor descriptor) /// /// - /// Updates the license for the cluster. + /// Update the license. + /// You can update your license at runtime without shutting down your nodes. + /// License updates take effect immediately. + /// If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -533,7 +621,15 @@ public virtual PostResponse Post() /// /// - /// Updates the license for the cluster. + /// Update the license. + /// You can update your license at runtime without shutting down your nodes. + /// License updates take effect immediately. + /// If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -548,7 +644,15 @@ public virtual PostResponse Post(Action configureRequest) /// /// - /// Updates the license for the cluster. + /// Update the license. + /// You can update your license at runtime without shutting down your nodes. + /// License updates take effect immediately. + /// If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -560,7 +664,15 @@ public virtual Task PostAsync(PostRequestDescriptor descriptor, Ca /// /// - /// Updates the license for the cluster. + /// Update the license. + /// You can update your license at runtime without shutting down your nodes. + /// License updates take effect immediately. + /// If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -573,7 +685,15 @@ public virtual Task PostAsync(CancellationToken cancellationToken /// /// - /// Updates the license for the cluster. + /// Update the license. + /// You can update your license at runtime without shutting down your nodes. + /// License updates take effect immediately. + /// If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. + /// If the operator privileges feature is enabled, only operator users can use this API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -587,8 +707,18 @@ public virtual Task PostAsync(Action config /// /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. - /// To check the status of your basic license, use the following API: Get basic status. + /// Start a basic license. + /// Start an indefinite basic license, which gives access to all the basic features. + /// + /// + /// NOTE: In order to start a basic license, you must not currently have a basic license. + /// + /// + /// If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// To check the status of your basic license, use the get basic license API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -601,8 +731,18 @@ public virtual PostStartBasicResponse PostStartBasic(PostStartBasicRequest reque /// /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. - /// To check the status of your basic license, use the following API: Get basic status. + /// Start a basic license. + /// Start an indefinite basic license, which gives access to all the basic features. + /// + /// + /// NOTE: In order to start a basic license, you must not currently have a basic license. + /// + /// + /// If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// To check the status of your basic license, use the get basic license API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -614,8 +754,18 @@ public virtual Task PostStartBasicAsync(PostStartBasicRe /// /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. - /// To check the status of your basic license, use the following API: Get basic status. + /// Start a basic license. + /// Start an indefinite basic license, which gives access to all the basic features. + /// + /// + /// NOTE: In order to start a basic license, you must not currently have a basic license. + /// + /// + /// If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// To check the status of your basic license, use the get basic license API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -628,8 +778,18 @@ public virtual PostStartBasicResponse PostStartBasic(PostStartBasicRequestDescri /// /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. - /// To check the status of your basic license, use the following API: Get basic status. + /// Start a basic license. + /// Start an indefinite basic license, which gives access to all the basic features. + /// + /// + /// NOTE: In order to start a basic license, you must not currently have a basic license. + /// + /// + /// If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// To check the status of your basic license, use the get basic license API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -643,8 +803,18 @@ public virtual PostStartBasicResponse PostStartBasic() /// /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. - /// To check the status of your basic license, use the following API: Get basic status. + /// Start a basic license. + /// Start an indefinite basic license, which gives access to all the basic features. + /// + /// + /// NOTE: In order to start a basic license, you must not currently have a basic license. + /// + /// + /// If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// To check the status of your basic license, use the get basic license API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -659,8 +829,18 @@ public virtual PostStartBasicResponse PostStartBasic(Action /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. - /// To check the status of your basic license, use the following API: Get basic status. + /// Start a basic license. + /// Start an indefinite basic license, which gives access to all the basic features. + /// + /// + /// NOTE: In order to start a basic license, you must not currently have a basic license. + /// + /// + /// If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// To check the status of your basic license, use the get basic license API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -672,8 +852,18 @@ public virtual Task PostStartBasicAsync(PostStartBasicRe /// /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. - /// To check the status of your basic license, use the following API: Get basic status. + /// Start a basic license. + /// Start an indefinite basic license, which gives access to all the basic features. + /// + /// + /// NOTE: In order to start a basic license, you must not currently have a basic license. + /// + /// + /// If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// To check the status of your basic license, use the get basic license API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -686,8 +876,18 @@ public virtual Task PostStartBasicAsync(CancellationToke /// /// - /// The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. - /// To check the status of your basic license, use the following API: Get basic status. + /// Start a basic license. + /// Start an indefinite basic license, which gives access to all the basic features. + /// + /// + /// NOTE: In order to start a basic license, you must not currently have a basic license. + /// + /// + /// If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. + /// You must then re-submit the API request with the acknowledge parameter set to true. + /// + /// + /// To check the status of your basic license, use the get basic license API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -701,7 +901,15 @@ public virtual Task PostStartBasicAsync(Action /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// Start a trial. + /// Start a 30-day trial, which gives access to all subscription features. + /// + /// + /// NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. + /// For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. + /// + /// + /// To check the status of your trial, use the get trial status API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -714,7 +922,15 @@ public virtual PostStartTrialResponse PostStartTrial(PostStartTrialRequest reque /// /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// Start a trial. + /// Start a 30-day trial, which gives access to all subscription features. + /// + /// + /// NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. + /// For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. + /// + /// + /// To check the status of your trial, use the get trial status API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -726,7 +942,15 @@ public virtual Task PostStartTrialAsync(PostStartTrialRe /// /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// Start a trial. + /// Start a 30-day trial, which gives access to all subscription features. + /// + /// + /// NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. + /// For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. + /// + /// + /// To check the status of your trial, use the get trial status API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -739,7 +963,15 @@ public virtual PostStartTrialResponse PostStartTrial(PostStartTrialRequestDescri /// /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// Start a trial. + /// Start a 30-day trial, which gives access to all subscription features. + /// + /// + /// NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. + /// For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. + /// + /// + /// To check the status of your trial, use the get trial status API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -753,7 +985,15 @@ public virtual PostStartTrialResponse PostStartTrial() /// /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// Start a trial. + /// Start a 30-day trial, which gives access to all subscription features. + /// + /// + /// NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. + /// For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. + /// + /// + /// To check the status of your trial, use the get trial status API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -768,7 +1008,15 @@ public virtual PostStartTrialResponse PostStartTrial(Action /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// Start a trial. + /// Start a 30-day trial, which gives access to all subscription features. + /// + /// + /// NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. + /// For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. + /// + /// + /// To check the status of your trial, use the get trial status API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -780,7 +1028,15 @@ public virtual Task PostStartTrialAsync(PostStartTrialRe /// /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// Start a trial. + /// Start a 30-day trial, which gives access to all subscription features. + /// + /// + /// NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. + /// For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. + /// + /// + /// To check the status of your trial, use the get trial status API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -793,7 +1049,15 @@ public virtual Task PostStartTrialAsync(CancellationToke /// /// - /// The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + /// Start a trial. + /// Start a 30-day trial, which gives access to all subscription features. + /// + /// + /// NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. + /// For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. + /// + /// + /// To check the status of your trial, use the get trial status API. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 3ac1051ceb5..abdd42fa477 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) { @@ -7866,8 +7866,8 @@ public virtual Task InferTrainedModelAsync(Elastic.Cl /// /// - /// Return ML defaults and limits. - /// Returns defaults and limits used by machine learning. + /// Get machine learning information. + /// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -7886,8 +7886,8 @@ public virtual MlInfoResponse Info(MlInfoRequest request) /// /// - /// Return ML defaults and limits. - /// Returns defaults and limits used by machine learning. + /// Get machine learning information. + /// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -7905,8 +7905,8 @@ public virtual Task InfoAsync(MlInfoRequest request, Cancellatio /// /// - /// Return ML defaults and limits. - /// Returns defaults and limits used by machine learning. + /// Get machine learning information. + /// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -7925,8 +7925,8 @@ public virtual MlInfoResponse Info(MlInfoRequestDescriptor descriptor) /// /// - /// Return ML defaults and limits. - /// Returns defaults and limits used by machine learning. + /// Get machine learning information. + /// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -7946,8 +7946,8 @@ public virtual MlInfoResponse Info() /// /// - /// Return ML defaults and limits. - /// Returns defaults and limits used by machine learning. + /// Get machine learning information. + /// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -7968,8 +7968,8 @@ public virtual MlInfoResponse Info(Action configureRequ /// /// - /// Return ML defaults and limits. - /// Returns defaults and limits used by machine learning. + /// Get machine learning information. + /// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -7987,8 +7987,8 @@ public virtual Task InfoAsync(MlInfoRequestDescriptor descriptor /// /// - /// Return ML defaults and limits. - /// Returns defaults and limits used by machine learning. + /// Get machine learning information. + /// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -8007,8 +8007,8 @@ public virtual Task InfoAsync(CancellationToken cancellationToke /// /// - /// Return ML defaults and limits. - /// Returns defaults and limits used by machine learning. + /// Get machine learning information. + /// Get defaults and limits used by machine learning. /// This endpoint is designed to be used by a user interface that needs to fully /// understand machine learning configurations where some options are not /// specified, meaning that the defaults should be used. This endpoint may be @@ -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) { @@ -9440,37 +9510,6 @@ public virtual PutJobResponse PutJob(PutJobRequestDescriptor, PutJobResponse, PutJobRequestParameters>(descriptor); } - /// - /// - /// Create an anomaly detection job. - /// If you include a datafeed_config, you must have read index privileges on the source index. - /// - /// Learn more about this API in the Elasticsearch documentation. - /// - [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] - public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id jobId) - { - var descriptor = new PutJobRequestDescriptor(jobId); - descriptor.BeforeRequest(); - return DoRequest, PutJobResponse, PutJobRequestParameters>(descriptor); - } - - /// - /// - /// Create an anomaly detection job. - /// If you include a datafeed_config, you must have read index privileges on the source index. - /// - /// Learn more about this API in the Elasticsearch documentation. - /// - [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] - public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id jobId, Action> configureRequest) - { - var descriptor = new PutJobRequestDescriptor(jobId); - configureRequest?.Invoke(descriptor); - descriptor.BeforeRequest(); - return DoRequest, PutJobResponse, PutJobRequestParameters>(descriptor); - } - /// /// /// Create an anomaly detection job. @@ -9485,37 +9524,6 @@ public virtual PutJobResponse PutJob(PutJobRequestDescriptor descriptor) return DoRequest(descriptor); } - /// - /// - /// Create an anomaly detection job. - /// If you include a datafeed_config, you must have read index privileges on the source index. - /// - /// Learn more about this API in the Elasticsearch documentation. - /// - [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] - public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id jobId) - { - var descriptor = new PutJobRequestDescriptor(jobId); - descriptor.BeforeRequest(); - return DoRequest(descriptor); - } - - /// - /// - /// Create an anomaly detection job. - /// If you include a datafeed_config, you must have read index privileges on the source index. - /// - /// Learn more about this API in the Elasticsearch documentation. - /// - [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] - public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest) - { - var descriptor = new PutJobRequestDescriptor(jobId); - configureRequest?.Invoke(descriptor); - descriptor.BeforeRequest(); - return DoRequest(descriptor); - } - /// /// /// Create an anomaly detection job. @@ -9529,35 +9537,6 @@ public virtual Task PutJobAsync(PutJobRequestDescript return DoRequestAsync, PutJobResponse, PutJobRequestParameters>(descriptor, cancellationToken); } - /// - /// - /// Create an anomaly detection job. - /// If you include a datafeed_config, you must have read index privileges on the source index. - /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) - { - var descriptor = new PutJobRequestDescriptor(jobId); - descriptor.BeforeRequest(); - return DoRequestAsync, PutJobResponse, PutJobRequestParameters>(descriptor, cancellationToken); - } - - /// - /// - /// Create an anomaly detection job. - /// If you include a datafeed_config, you must have read index privileges on the source index. - /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id jobId, Action> configureRequest, CancellationToken cancellationToken = default) - { - var descriptor = new PutJobRequestDescriptor(jobId); - configureRequest?.Invoke(descriptor); - descriptor.BeforeRequest(); - return DoRequestAsync, PutJobResponse, PutJobRequestParameters>(descriptor, cancellationToken); - } - /// /// /// Create an anomaly detection job. @@ -9571,35 +9550,6 @@ public virtual Task PutJobAsync(PutJobRequestDescriptor descript return DoRequestAsync(descriptor, cancellationToken); } - /// - /// - /// Create an anomaly detection job. - /// If you include a datafeed_config, you must have read index privileges on the source index. - /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id jobId, CancellationToken cancellationToken = default) - { - var descriptor = new PutJobRequestDescriptor(jobId); - descriptor.BeforeRequest(); - return DoRequestAsync(descriptor, cancellationToken); - } - - /// - /// - /// Create an anomaly detection job. - /// If you include a datafeed_config, you must have read index privileges on the source index. - /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id jobId, Action configureRequest, CancellationToken cancellationToken = default) - { - var descriptor = new PutJobRequestDescriptor(jobId); - configureRequest?.Invoke(descriptor); - descriptor.BeforeRequest(); - return DoRequestAsync(descriptor, cancellationToken); - } - /// /// /// Create a trained model. @@ -13229,7 +13179,7 @@ public virtual Task ValidateAsync(Action /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13242,7 +13192,7 @@ public virtual ValidateDetectorResponse ValidateDetector(ValidateDetectorRequest /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13254,7 +13204,7 @@ public virtual Task ValidateDetectorAsync(ValidateDete /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13267,7 +13217,7 @@ public virtual ValidateDetectorResponse ValidateDetector(ValidateDete /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13281,7 +13231,7 @@ public virtual ValidateDetectorResponse ValidateDetector(Elastic.Clie /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13296,7 +13246,7 @@ public virtual ValidateDetectorResponse ValidateDetector(Elastic.Clie /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13309,7 +13259,7 @@ public virtual ValidateDetectorResponse ValidateDetector(ValidateDetectorRequest /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13323,7 +13273,7 @@ public virtual ValidateDetectorResponse ValidateDetector(Elastic.Clients.Elastic /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13338,7 +13288,7 @@ public virtual ValidateDetectorResponse ValidateDetector(Elastic.Clients.Elastic /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13350,7 +13300,7 @@ public virtual Task ValidateDetectorAsync(V /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13363,7 +13313,7 @@ public virtual Task ValidateDetectorAsync(E /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13377,7 +13327,7 @@ public virtual Task ValidateDetectorAsync(E /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13389,7 +13339,7 @@ public virtual Task ValidateDetectorAsync(ValidateDete /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -13402,7 +13352,7 @@ public virtual Task ValidateDetectorAsync(Elastic.Clie /// /// - /// Validates an anomaly detection detector. + /// Validate an anomaly detection job. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 7588571dea4..72850e0b230 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Nodes.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Nodes.g.cs @@ -41,7 +41,8 @@ internal NodesNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// Clear the archived repositories metering. + /// Clear the archived repositories metering information in the cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +55,8 @@ public virtual ClearRepositoriesMeteringArchiveResponse ClearRepositoriesMeterin /// /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// Clear the archived repositories metering. + /// Clear the archived repositories metering information in the cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +68,8 @@ public virtual Task ClearRepositoriesM /// /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// Clear the archived repositories metering. + /// Clear the archived repositories metering information in the cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +82,8 @@ public virtual ClearRepositoriesMeteringArchiveResponse ClearRepositoriesMeterin /// /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// Clear the archived repositories metering. + /// Clear the archived repositories metering information in the cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +97,8 @@ public virtual ClearRepositoriesMeteringArchiveResponse ClearRepositoriesMeterin /// /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// Clear the archived repositories metering. + /// Clear the archived repositories metering information in the cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +113,8 @@ public virtual ClearRepositoriesMeteringArchiveResponse ClearRepositoriesMeterin /// /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// Clear the archived repositories metering. + /// Clear the archived repositories metering information in the cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -120,7 +126,8 @@ public virtual Task ClearRepositoriesM /// /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// Clear the archived repositories metering. + /// Clear the archived repositories metering information in the cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -133,7 +140,8 @@ public virtual Task ClearRepositoriesM /// /// - /// You can use this API to clear the archived repositories metering information in the cluster. + /// Clear the archived repositories metering. + /// Clear the archived repositories metering information in the cluster. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -147,10 +155,10 @@ public virtual Task ClearRepositoriesM /// /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. - /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the - /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this - /// API is volatile, meaning that it won’t be present after node restarts. + /// Get cluster repositories metering. + /// Get repositories metering information for a cluster. + /// This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. + /// Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -163,10 +171,10 @@ public virtual GetRepositoriesMeteringInfoResponse GetRepositoriesMeteringInfo(G /// /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. - /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the - /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this - /// API is volatile, meaning that it won’t be present after node restarts. + /// Get cluster repositories metering. + /// Get repositories metering information for a cluster. + /// This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. + /// Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -178,10 +186,10 @@ public virtual Task GetRepositoriesMetering /// /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. - /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the - /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this - /// API is volatile, meaning that it won’t be present after node restarts. + /// Get cluster repositories metering. + /// Get repositories metering information for a cluster. + /// This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. + /// Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -194,10 +202,10 @@ public virtual GetRepositoriesMeteringInfoResponse GetRepositoriesMeteringInfo(G /// /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. - /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the - /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this - /// API is volatile, meaning that it won’t be present after node restarts. + /// Get cluster repositories metering. + /// Get repositories metering information for a cluster. + /// This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. + /// Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -211,10 +219,10 @@ public virtual GetRepositoriesMeteringInfoResponse GetRepositoriesMeteringInfo(E /// /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. - /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the - /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this - /// API is volatile, meaning that it won’t be present after node restarts. + /// Get cluster repositories metering. + /// Get repositories metering information for a cluster. + /// This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. + /// Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -229,10 +237,10 @@ public virtual GetRepositoriesMeteringInfoResponse GetRepositoriesMeteringInfo(E /// /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. - /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the - /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this - /// API is volatile, meaning that it won’t be present after node restarts. + /// Get cluster repositories metering. + /// Get repositories metering information for a cluster. + /// This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. + /// Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -244,10 +252,10 @@ public virtual Task GetRepositoriesMetering /// /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. - /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the - /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this - /// API is volatile, meaning that it won’t be present after node restarts. + /// Get cluster repositories metering. + /// Get repositories metering information for a cluster. + /// This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. + /// Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -260,10 +268,10 @@ public virtual Task GetRepositoriesMetering /// /// - /// You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. - /// This API exposes monotonically non-decreasing counters and it’s expected that clients would durably store the - /// information needed to compute aggregations over a period of time. Additionally, the information exposed by this - /// API is volatile, meaning that it won’t be present after node restarts. + /// Get cluster repositories metering. + /// Get repositories metering information for a cluster. + /// This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. + /// Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -277,10 +285,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// Learn more about this API in the Elasticsearch 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) @@ -291,10 +300,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// 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) { @@ -304,10 +314,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// Learn more about this API in the Elasticsearch 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) @@ -318,10 +329,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// Learn more about this API in the Elasticsearch 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) @@ -333,10 +345,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// Learn more about this API in the Elasticsearch 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) @@ -349,10 +362,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// Learn more about this API in the Elasticsearch 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() @@ -364,10 +378,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// Learn more about this API in the Elasticsearch 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) @@ -380,10 +395,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// 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) { @@ -393,10 +409,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// 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) { @@ -407,10 +424,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// 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) { @@ -422,10 +440,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// 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) { @@ -436,10 +455,11 @@ 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. + /// Get the hot threads for nodes. + /// Get a breakdown of the hot threads on each selected node in the cluster. + /// The output is plain text with a breakdown of the top hot threads for each node. /// - /// 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) { @@ -451,9 +471,10 @@ public virtual Task HotThreadsAsync(Action /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// Learn more about this API in the Elasticsearch 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) @@ -464,9 +485,10 @@ public virtual NodesInfoResponse Info(NodesInfoRequest request) /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// 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) { @@ -476,9 +498,10 @@ public virtual Task InfoAsync(NodesInfoRequest request, Cance /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// Learn more about this API in the Elasticsearch 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) @@ -489,9 +512,10 @@ public virtual NodesInfoResponse Info(NodesInfoRequestDescriptor descriptor) /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// Learn more about this API in the Elasticsearch 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) @@ -503,9 +527,10 @@ public virtual NodesInfoResponse Info(Elastic.Clients.Elasticsearch.NodeIds? nod /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// Learn more about this API in the Elasticsearch 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) @@ -518,9 +543,10 @@ public virtual NodesInfoResponse Info(Elastic.Clients.Elasticsearch.NodeIds? nod /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// Learn more about this API in the Elasticsearch 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() @@ -532,9 +558,10 @@ public virtual NodesInfoResponse Info() /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// Learn more about this API in the Elasticsearch 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) @@ -547,9 +574,10 @@ public virtual NodesInfoResponse Info(Action configu /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// 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) { @@ -559,9 +587,10 @@ public virtual Task InfoAsync(NodesInfoRequestDescriptor desc /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// 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) { @@ -572,9 +601,10 @@ public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.N /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// 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) { @@ -586,9 +616,10 @@ public virtual Task InfoAsync(Elastic.Clients.Elasticsearch.N /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// 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) { @@ -599,9 +630,10 @@ public virtual Task InfoAsync(CancellationToken cancellationT /// /// - /// Returns cluster nodes information. + /// Get node information. + /// By default, the API returns all attributes and core settings for cluster nodes. /// - /// 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) { @@ -613,7 +645,17 @@ public virtual Task InfoAsync(Action /// - /// Reloads the keystore on nodes in the cluster. + /// Reload the keystore on nodes in the cluster. + /// + /// + /// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + /// That is, you can change them on disk and reload them without restarting any nodes in the cluster. + /// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + /// + /// + /// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + /// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + /// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -626,7 +668,17 @@ public virtual ReloadSecureSettingsResponse ReloadSecureSettings(ReloadSecureSet /// /// - /// Reloads the keystore on nodes in the cluster. + /// Reload the keystore on nodes in the cluster. + /// + /// + /// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + /// That is, you can change them on disk and reload them without restarting any nodes in the cluster. + /// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + /// + /// + /// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + /// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + /// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -638,7 +690,17 @@ public virtual Task ReloadSecureSettingsAsync(Relo /// /// - /// Reloads the keystore on nodes in the cluster. + /// Reload the keystore on nodes in the cluster. + /// + /// + /// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + /// That is, you can change them on disk and reload them without restarting any nodes in the cluster. + /// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + /// + /// + /// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + /// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + /// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -651,7 +713,17 @@ public virtual ReloadSecureSettingsResponse ReloadSecureSettings(ReloadSecureSet /// /// - /// Reloads the keystore on nodes in the cluster. + /// Reload the keystore on nodes in the cluster. + /// + /// + /// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + /// That is, you can change them on disk and reload them without restarting any nodes in the cluster. + /// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + /// + /// + /// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + /// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + /// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -665,7 +737,17 @@ public virtual ReloadSecureSettingsResponse ReloadSecureSettings(Elastic.Clients /// /// - /// Reloads the keystore on nodes in the cluster. + /// Reload the keystore on nodes in the cluster. + /// + /// + /// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + /// That is, you can change them on disk and reload them without restarting any nodes in the cluster. + /// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + /// + /// + /// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + /// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + /// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -680,7 +762,17 @@ public virtual ReloadSecureSettingsResponse ReloadSecureSettings(Elastic.Clients /// /// - /// Reloads the keystore on nodes in the cluster. + /// Reload the keystore on nodes in the cluster. + /// + /// + /// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + /// That is, you can change them on disk and reload them without restarting any nodes in the cluster. + /// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + /// + /// + /// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + /// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + /// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -694,7 +786,17 @@ public virtual ReloadSecureSettingsResponse ReloadSecureSettings() /// /// - /// Reloads the keystore on nodes in the cluster. + /// Reload the keystore on nodes in the cluster. + /// + /// + /// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + /// That is, you can change them on disk and reload them without restarting any nodes in the cluster. + /// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + /// + /// + /// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + /// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + /// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -709,7 +811,17 @@ public virtual ReloadSecureSettingsResponse ReloadSecureSettings(Action /// - /// Reloads the keystore on nodes in the cluster. + /// Reload the keystore on nodes in the cluster. + /// + /// + /// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + /// That is, you can change them on disk and reload them without restarting any nodes in the cluster. + /// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + /// + /// + /// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + /// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + /// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -721,7 +833,17 @@ public virtual Task ReloadSecureSettingsAsync(Relo /// /// - /// Reloads the keystore on nodes in the cluster. + /// Reload the keystore on nodes in the cluster. + /// + /// + /// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + /// That is, you can change them on disk and reload them without restarting any nodes in the cluster. + /// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + /// + /// + /// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + /// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + /// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -734,7 +856,17 @@ public virtual Task ReloadSecureSettingsAsync(Elas /// /// - /// Reloads the keystore on nodes in the cluster. + /// Reload the keystore on nodes in the cluster. + /// + /// + /// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + /// That is, you can change them on disk and reload them without restarting any nodes in the cluster. + /// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + /// + /// + /// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + /// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + /// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -748,7 +880,17 @@ public virtual Task ReloadSecureSettingsAsync(Elas /// /// - /// Reloads the keystore on nodes in the cluster. + /// Reload the keystore on nodes in the cluster. + /// + /// + /// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + /// That is, you can change them on disk and reload them without restarting any nodes in the cluster. + /// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + /// + /// + /// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + /// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + /// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -761,7 +903,17 @@ public virtual Task ReloadSecureSettingsAsync(Canc /// /// - /// Reloads the keystore on nodes in the cluster. + /// Reload the keystore on nodes in the cluster. + /// + /// + /// Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + /// That is, you can change them on disk and reload them without restarting any nodes in the cluster. + /// When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + /// + /// + /// When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + /// Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + /// Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -775,9 +927,11 @@ public virtual Task ReloadSecureSettingsAsync(Acti /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// Learn more about this API in the Elasticsearch 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) @@ -788,9 +942,11 @@ public virtual NodesStatsResponse Stats(NodesStatsRequest request) /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -800,9 +956,11 @@ public virtual Task StatsAsync(NodesStatsRequest request, Ca /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// Learn more about this API in the Elasticsearch 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) @@ -813,9 +971,11 @@ public virtual NodesStatsResponse Stats(NodesStatsRequestDescriptor /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// Learn more about this API in the Elasticsearch 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) @@ -827,9 +987,11 @@ public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// Learn more about this API in the Elasticsearch 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) @@ -842,9 +1004,11 @@ public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// Learn more about this API in the Elasticsearch 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() @@ -856,9 +1020,11 @@ public virtual NodesStatsResponse Stats() /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// Learn more about this API in the Elasticsearch 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) @@ -871,9 +1037,11 @@ public virtual NodesStatsResponse Stats(Action /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// Learn more about this API in the Elasticsearch 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) @@ -884,9 +1052,11 @@ public virtual NodesStatsResponse Stats(NodesStatsRequestDescriptor descriptor) /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// Learn more about this API in the Elasticsearch 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) @@ -898,9 +1068,11 @@ public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? n /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// Learn more about this API in the Elasticsearch 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) @@ -913,9 +1085,11 @@ public virtual NodesStatsResponse Stats(Elastic.Clients.Elasticsearch.NodeIds? n /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// Learn more about this API in the Elasticsearch 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() @@ -927,9 +1101,11 @@ public virtual NodesStatsResponse Stats() /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// Learn more about this API in the Elasticsearch 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) @@ -942,9 +1118,11 @@ public virtual NodesStatsResponse Stats(Action conf /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -954,9 +1132,11 @@ public virtual Task StatsAsync(NodesStatsRequestD /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -967,9 +1147,11 @@ public virtual Task StatsAsync(Elastic.Clients.El /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -981,9 +1163,11 @@ public virtual Task StatsAsync(Elastic.Clients.El /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -994,9 +1178,11 @@ public virtual Task StatsAsync(CancellationToken /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -1008,9 +1194,11 @@ public virtual Task StatsAsync(Action /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -1020,9 +1208,11 @@ public virtual Task StatsAsync(NodesStatsRequestDescriptor d /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -1033,9 +1223,11 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsearch /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -1047,9 +1239,11 @@ public virtual Task StatsAsync(Elastic.Clients.Elasticsearch /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -1060,9 +1254,11 @@ public virtual Task StatsAsync(CancellationToken cancellatio /// /// - /// Returns cluster nodes statistics. + /// Get node statistics. + /// Get statistics for nodes in a cluster. + /// By default, all stats are returned. You can limit the returned information by using metrics. /// - /// 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) { @@ -1074,9 +1270,9 @@ public virtual Task StatsAsync(Action /// - /// Returns information on the usage of features. + /// Get feature usage 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 NodesUsageResponse Usage(NodesUsageRequest request) @@ -1087,9 +1283,9 @@ public virtual NodesUsageResponse Usage(NodesUsageRequest request) /// /// - /// Returns information on the usage of features. + /// Get feature usage information. /// - /// 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) { @@ -1099,9 +1295,9 @@ public virtual Task UsageAsync(NodesUsageRequest request, Ca /// /// - /// Returns information on the usage of features. + /// Get feature usage 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 NodesUsageResponse Usage(NodesUsageRequestDescriptor descriptor) @@ -1112,9 +1308,9 @@ public virtual NodesUsageResponse Usage(NodesUsageRequestDescriptor descriptor) /// /// - /// Returns information on the usage of features. + /// Get feature usage 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 NodesUsageResponse Usage(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric) @@ -1126,9 +1322,9 @@ public virtual NodesUsageResponse Usage(Elastic.Clients.Elasticsearch.NodeIds? n /// /// - /// Returns information on the usage of features. + /// Get feature usage 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 NodesUsageResponse Usage(Elastic.Clients.Elasticsearch.NodeIds? nodeId, Elastic.Clients.Elasticsearch.Metrics? metric, Action configureRequest) @@ -1141,9 +1337,9 @@ public virtual NodesUsageResponse Usage(Elastic.Clients.Elasticsearch.NodeIds? n /// /// - /// Returns information on the usage of features. + /// Get feature usage 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 NodesUsageResponse Usage() @@ -1155,9 +1351,9 @@ public virtual NodesUsageResponse Usage() /// /// - /// Returns information on the usage of features. + /// Get feature usage 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 NodesUsageResponse Usage(Action configureRequest) @@ -1170,9 +1366,9 @@ public virtual NodesUsageResponse Usage(Action conf /// /// - /// Returns information on the usage of features. + /// Get feature usage information. /// - /// 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) { @@ -1182,9 +1378,9 @@ public virtual Task UsageAsync(NodesUsageRequestDescriptor d /// /// - /// Returns information on the usage of features. + /// Get feature usage information. /// - /// 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) { @@ -1195,9 +1391,9 @@ public virtual Task UsageAsync(Elastic.Clients.Elasticsearch /// /// - /// Returns information on the usage of features. + /// Get feature usage information. /// - /// 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) { @@ -1209,9 +1405,9 @@ public virtual Task UsageAsync(Elastic.Clients.Elasticsearch /// /// - /// Returns information on the usage of features. + /// Get feature usage information. /// - /// 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) { @@ -1222,9 +1418,9 @@ public virtual Task UsageAsync(CancellationToken cancellatio /// /// - /// Returns information on the usage of features. + /// Get feature usage information. /// - /// 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 f09318cfb7b..ea4ba5f77b9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.QueryRules.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.QueryRules.g.cs @@ -41,7 +41,8 @@ internal QueryRulesNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Deletes a query rule within a query ruleset. + /// Delete a query rule. + /// Delete a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +55,8 @@ public virtual DeleteRuleResponse DeleteRule(DeleteRuleRequest request) /// /// - /// Deletes a query rule within a query ruleset. + /// Delete a query rule. + /// Delete a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +68,8 @@ public virtual Task DeleteRuleAsync(DeleteRuleRequest reques /// /// - /// Deletes a query rule within a query ruleset. + /// Delete a query rule. + /// Delete a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +82,8 @@ public virtual DeleteRuleResponse DeleteRule(DeleteRuleRequestDescriptor descrip /// /// - /// Deletes a query rule within a query ruleset. + /// Delete a query rule. + /// Delete a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +97,8 @@ public virtual DeleteRuleResponse DeleteRule(Elastic.Clients.Elasticsearch.Id ru /// /// - /// Deletes a query rule within a query ruleset. + /// Delete a query rule. + /// Delete a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +113,8 @@ public virtual DeleteRuleResponse DeleteRule(Elastic.Clients.Elasticsearch.Id ru /// /// - /// Deletes a query rule within a query ruleset. + /// Delete a query rule. + /// Delete a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -120,7 +126,8 @@ public virtual Task DeleteRuleAsync(DeleteRuleRequestDescrip /// /// - /// Deletes a query rule within a query ruleset. + /// Delete a query rule. + /// Delete a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -133,7 +140,8 @@ public virtual Task DeleteRuleAsync(Elastic.Clients.Elastics /// /// - /// Deletes a query rule within a query ruleset. + /// Delete a query rule. + /// Delete a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -147,7 +155,7 @@ public virtual Task DeleteRuleAsync(Elastic.Clients.Elastics /// /// - /// Deletes a query ruleset. + /// Delete a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -160,7 +168,7 @@ public virtual DeleteRulesetResponse DeleteRuleset(DeleteRulesetRequest request) /// /// - /// Deletes a query ruleset. + /// Delete a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -172,7 +180,7 @@ public virtual Task DeleteRulesetAsync(DeleteRulesetReque /// /// - /// Deletes a query ruleset. + /// Delete a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -185,7 +193,7 @@ public virtual DeleteRulesetResponse DeleteRuleset(DeleteRulesetRequestDescripto /// /// - /// Deletes a query ruleset. + /// Delete a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -199,7 +207,7 @@ public virtual DeleteRulesetResponse DeleteRuleset(Elastic.Clients.Elasticsearch /// /// - /// Deletes a query ruleset. + /// Delete a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -214,7 +222,7 @@ public virtual DeleteRulesetResponse DeleteRuleset(Elastic.Clients.Elasticsearch /// /// - /// Deletes a query ruleset. + /// Delete a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -226,7 +234,7 @@ public virtual Task DeleteRulesetAsync(DeleteRulesetReque /// /// - /// Deletes a query ruleset. + /// Delete a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -239,7 +247,7 @@ public virtual Task DeleteRulesetAsync(Elastic.Clients.El /// /// - /// Deletes a query ruleset. + /// Delete a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -253,7 +261,8 @@ public virtual Task DeleteRulesetAsync(Elastic.Clients.El /// /// - /// Returns the details about a query rule within a query ruleset + /// Get a query rule. + /// Get details about a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -266,7 +275,8 @@ public virtual GetRuleResponse GetRule(GetRuleRequest request) /// /// - /// Returns the details about a query rule within a query ruleset + /// Get a query rule. + /// Get details about a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -278,7 +288,8 @@ public virtual Task GetRuleAsync(GetRuleRequest request, Cancel /// /// - /// Returns the details about a query rule within a query ruleset + /// Get a query rule. + /// Get details about a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -291,7 +302,8 @@ public virtual GetRuleResponse GetRule(GetRuleRequestDescriptor descriptor) /// /// - /// Returns the details about a query rule within a query ruleset + /// Get a query rule. + /// Get details about a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -305,7 +317,8 @@ public virtual GetRuleResponse GetRule(Elastic.Clients.Elasticsearch.Id rulesetI /// /// - /// Returns the details about a query rule within a query ruleset + /// Get a query rule. + /// Get details about a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -320,7 +333,8 @@ public virtual GetRuleResponse GetRule(Elastic.Clients.Elasticsearch.Id rulesetI /// /// - /// Returns the details about a query rule within a query ruleset + /// Get a query rule. + /// Get details about a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -332,7 +346,8 @@ public virtual Task GetRuleAsync(GetRuleRequestDescriptor descr /// /// - /// Returns the details about a query rule within a query ruleset + /// Get a query rule. + /// Get details about a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -345,7 +360,8 @@ public virtual Task GetRuleAsync(Elastic.Clients.Elasticsearch. /// /// - /// Returns the details about a query rule within a query ruleset + /// Get a query rule. + /// Get details about a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -359,7 +375,8 @@ public virtual Task GetRuleAsync(Elastic.Clients.Elasticsearch. /// /// - /// Returns the details about a query ruleset + /// Get a query ruleset. + /// Get details about a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -372,7 +389,8 @@ public virtual GetRulesetResponse GetRuleset(GetRulesetRequest request) /// /// - /// Returns the details about a query ruleset + /// Get a query ruleset. + /// Get details about a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -384,7 +402,8 @@ public virtual Task GetRulesetAsync(GetRulesetRequest reques /// /// - /// Returns the details about a query ruleset + /// Get a query ruleset. + /// Get details about a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -397,7 +416,8 @@ public virtual GetRulesetResponse GetRuleset(GetRulesetRequestDescriptor descrip /// /// - /// Returns the details about a query ruleset + /// Get a query ruleset. + /// Get details about a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -411,7 +431,8 @@ public virtual GetRulesetResponse GetRuleset(Elastic.Clients.Elasticsearch.Id ru /// /// - /// Returns the details about a query ruleset + /// Get a query ruleset. + /// Get details about a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -426,7 +447,8 @@ public virtual GetRulesetResponse GetRuleset(Elastic.Clients.Elasticsearch.Id ru /// /// - /// Returns the details about a query ruleset + /// Get a query ruleset. + /// Get details about a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -438,7 +460,8 @@ public virtual Task GetRulesetAsync(GetRulesetRequestDescrip /// /// - /// Returns the details about a query ruleset + /// Get a query ruleset. + /// Get details about a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -451,7 +474,8 @@ public virtual Task GetRulesetAsync(Elastic.Clients.Elastics /// /// - /// Returns the details about a query ruleset + /// Get a query ruleset. + /// Get details about a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -465,7 +489,8 @@ public virtual Task GetRulesetAsync(Elastic.Clients.Elastics /// /// - /// Returns summarized information about existing query rulesets. + /// Get all query rulesets. + /// Get summarized information about the query rulesets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -478,7 +503,8 @@ public virtual ListRulesetsResponse ListRulesets(ListRulesetsRequest request) /// /// - /// Returns summarized information about existing query rulesets. + /// Get all query rulesets. + /// Get summarized information about the query rulesets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -490,7 +516,8 @@ public virtual Task ListRulesetsAsync(ListRulesetsRequest /// /// - /// Returns summarized information about existing query rulesets. + /// Get all query rulesets. + /// Get summarized information about the query rulesets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -503,7 +530,8 @@ public virtual ListRulesetsResponse ListRulesets(ListRulesetsRequestDescriptor d /// /// - /// Returns summarized information about existing query rulesets. + /// Get all query rulesets. + /// Get summarized information about the query rulesets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -517,7 +545,8 @@ public virtual ListRulesetsResponse ListRulesets() /// /// - /// Returns summarized information about existing query rulesets. + /// Get all query rulesets. + /// Get summarized information about the query rulesets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -532,7 +561,8 @@ public virtual ListRulesetsResponse ListRulesets(Action /// - /// Returns summarized information about existing query rulesets. + /// Get all query rulesets. + /// Get summarized information about the query rulesets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -544,7 +574,8 @@ public virtual Task ListRulesetsAsync(ListRulesetsRequestD /// /// - /// Returns summarized information about existing query rulesets. + /// Get all query rulesets. + /// Get summarized information about the query rulesets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -557,7 +588,8 @@ public virtual Task ListRulesetsAsync(CancellationToken ca /// /// - /// Returns summarized information about existing query rulesets. + /// Get all query rulesets. + /// Get summarized information about the query rulesets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -571,7 +603,8 @@ public virtual Task ListRulesetsAsync(Action /// - /// Creates or updates a query rule within a query ruleset. + /// Create or update a query rule. + /// Create or update a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -584,7 +617,8 @@ public virtual PutRuleResponse PutRule(PutRuleRequest request) /// /// - /// Creates or updates a query rule within a query ruleset. + /// Create or update a query rule. + /// Create or update a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -596,7 +630,8 @@ public virtual Task PutRuleAsync(PutRuleRequest request, Cancel /// /// - /// Creates or updates a query rule within a query ruleset. + /// Create or update a query rule. + /// Create or update a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -609,7 +644,8 @@ public virtual PutRuleResponse PutRule(PutRuleRequestDescriptor descriptor) /// /// - /// Creates or updates a query rule within a query ruleset. + /// Create or update a query rule. + /// Create or update a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -623,7 +659,8 @@ public virtual PutRuleResponse PutRule(Elastic.Clients.Elasticsearch.Id rulesetI /// /// - /// Creates or updates a query rule within a query ruleset. + /// Create or update a query rule. + /// Create or update a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -638,7 +675,8 @@ public virtual PutRuleResponse PutRule(Elastic.Clients.Elasticsearch.Id rulesetI /// /// - /// Creates or updates a query rule within a query ruleset. + /// Create or update a query rule. + /// Create or update a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -650,7 +688,8 @@ public virtual Task PutRuleAsync(PutRuleRequestDescriptor descr /// /// - /// Creates or updates a query rule within a query ruleset. + /// Create or update a query rule. + /// Create or update a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -663,7 +702,8 @@ public virtual Task PutRuleAsync(Elastic.Clients.Elasticsearch. /// /// - /// Creates or updates a query rule within a query ruleset. + /// Create or update a query rule. + /// Create or update a query rule within a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -677,7 +717,7 @@ public virtual Task PutRuleAsync(Elastic.Clients.Elasticsearch. /// /// - /// Creates or updates a query ruleset. + /// Create or update a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -690,7 +730,7 @@ public virtual PutRulesetResponse PutRuleset(PutRulesetRequest request) /// /// - /// Creates or updates a query ruleset. + /// Create or update a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -702,7 +742,7 @@ public virtual Task PutRulesetAsync(PutRulesetRequest reques /// /// - /// Creates or updates a query ruleset. + /// Create or update a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -715,7 +755,7 @@ public virtual PutRulesetResponse PutRuleset(PutRulesetRequestDescriptor descrip /// /// - /// Creates or updates a query ruleset. + /// Create or update a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -729,7 +769,7 @@ public virtual PutRulesetResponse PutRuleset(Elastic.Clients.Elasticsearch.Id ru /// /// - /// Creates or updates a query ruleset. + /// Create or update a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -744,7 +784,7 @@ public virtual PutRulesetResponse PutRuleset(Elastic.Clients.Elasticsearch.Id ru /// /// - /// Creates or updates a query ruleset. + /// Create or update a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -756,7 +796,7 @@ public virtual Task PutRulesetAsync(PutRulesetRequestDescrip /// /// - /// Creates or updates a query ruleset. + /// Create or update a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -769,7 +809,7 @@ public virtual Task PutRulesetAsync(Elastic.Clients.Elastics /// /// - /// Creates or updates a query ruleset. + /// Create or update a query ruleset. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -780,4 +820,118 @@ public virtual Task PutRulesetAsync(Elastic.Clients.Elastics descriptor.BeforeRequest(); return DoRequestAsync(descriptor, cancellationToken); } + + /// + /// + /// Test a query ruleset. + /// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. + /// + /// 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); + } + + /// + /// + /// Test a query ruleset. + /// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task TestAsync(TestRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Test a query ruleset. + /// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. + /// + /// 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); + } + + /// + /// + /// Test a query ruleset. + /// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. + /// + /// 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); + } + + /// + /// + /// Test a query ruleset. + /// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. + /// + /// 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); + } + + /// + /// + /// Test a query ruleset. + /// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task TestAsync(TestRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Test a query ruleset. + /// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. + /// + /// 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); + } + + /// + /// + /// Test a query ruleset. + /// Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. + /// + /// 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.Rollup.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Rollup.g.cs index eb80088fdb7..c697cc783bd 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Rollup.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Rollup.g.cs @@ -41,8 +41,32 @@ internal RollupNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Deletes an existing rollup job. - /// + /// Delete a rollup job. + /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. + /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: + /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -54,8 +78,32 @@ public virtual DeleteJobResponse DeleteJob(DeleteJobRequest request) /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. + /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: + /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(DeleteJobRequest request, CancellationToken cancellationToken = default) @@ -66,8 +114,32 @@ public virtual Task DeleteJobAsync(DeleteJobRequest request, /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. + /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: + /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -79,8 +151,32 @@ public virtual DeleteJobResponse DeleteJob(DeleteJobRequestDescriptor /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. + /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. + /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -93,8 +189,32 @@ public virtual DeleteJobResponse DeleteJob(Elastic.Clients.Elasticsea /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. + /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: + /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -108,8 +228,32 @@ public virtual DeleteJobResponse DeleteJob(Elastic.Clients.Elasticsea /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. + /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: + /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -121,8 +265,32 @@ public virtual DeleteJobResponse DeleteJob(DeleteJobRequestDescriptor descriptor /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. + /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. + /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -135,8 +303,32 @@ public virtual DeleteJobResponse DeleteJob(Elastic.Clients.Elasticsearch.Id id) /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. + /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: + /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -150,8 +342,32 @@ public virtual DeleteJobResponse DeleteJob(Elastic.Clients.Elasticsearch.Id id, /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. + /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: + /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(DeleteJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -162,8 +378,32 @@ public virtual Task DeleteJobAsync(DeleteJobReques /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. + /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: + /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -175,8 +415,32 @@ public virtual Task DeleteJobAsync(Elastic.Clients /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. + /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: + /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsearch.Id id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -189,8 +453,32 @@ public virtual Task DeleteJobAsync(Elastic.Clients /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. + /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. + /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(DeleteJobRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -201,8 +489,32 @@ public virtual Task DeleteJobAsync(DeleteJobRequestDescriptor /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. + /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: + /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsearch.Id id, CancellationToken cancellationToken = default) @@ -214,8 +526,32 @@ public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsea /// /// - /// Deletes an existing rollup job. + /// Delete a rollup job. + /// + /// + /// A job must be stopped before it can be deleted. + /// If you attempt to delete a started job, an error occurs. + /// Similarly, if you attempt to delete a nonexistent job, an exception occurs. + /// + /// + /// IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. + /// The API does not delete any previously rolled up data. + /// This is by design; a user may wish to roll up a static data set. + /// Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). + /// Thus the job can be deleted, leaving behind the rolled up data for analysis. + /// If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. + /// If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: /// + /// + /// POST my_rollup_index/_delete_by_query + /// { + /// "query": { + /// "term": { + /// "_rollup.id": "the_rollup_job_id" + /// } + /// } + /// } + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsearch.Id id, Action configureRequest, CancellationToken cancellationToken = default) @@ -228,7 +564,13 @@ public virtual Task DeleteJobAsync(Elastic.Clients.Elasticsea /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -241,7 +583,13 @@ public virtual GetJobsResponse GetJobs(GetJobsRequest request) /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -253,7 +601,13 @@ public virtual Task GetJobsAsync(GetJobsRequest request, Cancel /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -266,7 +620,13 @@ public virtual GetJobsResponse GetJobs(GetJobsRequestDescriptor /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -280,7 +640,13 @@ public virtual GetJobsResponse GetJobs(Elastic.Clients.Elasticsearch. /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -295,7 +661,13 @@ public virtual GetJobsResponse GetJobs(Elastic.Clients.Elasticsearch. /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -309,7 +681,13 @@ public virtual GetJobsResponse GetJobs() /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -324,7 +702,13 @@ public virtual GetJobsResponse GetJobs(Action /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -337,7 +721,13 @@ public virtual GetJobsResponse GetJobs(GetJobsRequestDescriptor descriptor) /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -351,7 +741,13 @@ public virtual GetJobsResponse GetJobs(Elastic.Clients.Elasticsearch.Id? id) /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -366,7 +762,13 @@ public virtual GetJobsResponse GetJobs(Elastic.Clients.Elasticsearch.Id? id, Act /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -380,7 +782,13 @@ public virtual GetJobsResponse GetJobs() /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -395,7 +803,13 @@ public virtual GetJobsResponse GetJobs(Action configur /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -407,7 +821,13 @@ public virtual Task GetJobsAsync(GetJobsRequestDescr /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -420,7 +840,13 @@ public virtual Task GetJobsAsync(Elastic.Clients.Ela /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -434,7 +860,13 @@ public virtual Task GetJobsAsync(Elastic.Clients.Ela /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -447,7 +879,13 @@ public virtual Task GetJobsAsync(CancellationToken c /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -461,7 +899,13 @@ public virtual Task GetJobsAsync(Action /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -473,7 +917,13 @@ public virtual Task GetJobsAsync(GetJobsRequestDescriptor descr /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -486,7 +936,13 @@ public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch. /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -500,7 +956,13 @@ public virtual Task GetJobsAsync(Elastic.Clients.Elasticsearch. /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -513,7 +975,13 @@ public virtual Task GetJobsAsync(CancellationToken cancellation /// /// - /// Retrieves the configuration, stats, and status of rollup jobs. + /// Get rollup job information. + /// Get the configuration, stats, and status of rollup jobs. + /// + /// + /// NOTE: This API returns only active (both STARTED and STOPPED) jobs. + /// If a job was created, ran for a while, then was deleted, the API does not return any details about it. + /// For details about a historical rollup job, the rollup capabilities API may be more useful. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -527,8 +995,26 @@ public virtual Task GetJobsAsync(Action /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -540,8 +1026,26 @@ public virtual GetRollupCapsResponse GetRollupCaps(GetRollupCapsRequest request) /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(GetRollupCapsRequest request, CancellationToken cancellationToken = default) @@ -552,8 +1056,26 @@ public virtual Task GetRollupCapsAsync(GetRollupCapsReque /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -565,8 +1087,26 @@ public virtual GetRollupCapsResponse GetRollupCaps(GetRollupCapsReque /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -579,8 +1119,26 @@ public virtual GetRollupCapsResponse GetRollupCaps(Elastic.Clients.El /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -594,8 +1152,26 @@ public virtual GetRollupCapsResponse GetRollupCaps(Elastic.Clients.El /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -608,8 +1184,26 @@ public virtual GetRollupCapsResponse GetRollupCaps() /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -623,8 +1217,26 @@ public virtual GetRollupCapsResponse GetRollupCaps(Action /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -636,8 +1248,26 @@ public virtual GetRollupCapsResponse GetRollupCaps(GetRollupCapsRequestDescripto /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -650,8 +1280,26 @@ public virtual GetRollupCapsResponse GetRollupCaps(Elastic.Clients.Elasticsearch /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -665,8 +1313,26 @@ public virtual GetRollupCapsResponse GetRollupCaps(Elastic.Clients.Elasticsearch /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -679,8 +1345,26 @@ public virtual GetRollupCapsResponse GetRollupCaps() /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -694,8 +1378,26 @@ public virtual GetRollupCapsResponse GetRollupCaps(Action /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(GetRollupCapsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -706,8 +1408,26 @@ public virtual Task GetRollupCapsAsync(GetRoll /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -719,8 +1439,26 @@ public virtual Task GetRollupCapsAsync(Elastic /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(Elastic.Clients.Elasticsearch.Id? id, Action> configureRequest, CancellationToken cancellationToken = default) @@ -733,8 +1471,26 @@ public virtual Task GetRollupCapsAsync(Elastic /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(CancellationToken cancellationToken = default) @@ -746,8 +1502,26 @@ public virtual Task GetRollupCapsAsync(Cancell /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(Action> configureRequest, CancellationToken cancellationToken = default) @@ -760,8 +1534,26 @@ public virtual Task GetRollupCapsAsync(Action< /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(GetRollupCapsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -772,8 +1564,26 @@ public virtual Task GetRollupCapsAsync(GetRollupCapsReque /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(Elastic.Clients.Elasticsearch.Id? id, CancellationToken cancellationToken = default) @@ -785,8 +1595,26 @@ public virtual Task GetRollupCapsAsync(Elastic.Clients.El /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? + /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(Elastic.Clients.Elasticsearch.Id? id, Action configureRequest, CancellationToken cancellationToken = default) @@ -799,8 +1627,26 @@ public virtual Task GetRollupCapsAsync(Elastic.Clients.El /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(CancellationToken cancellationToken = default) @@ -812,8 +1658,26 @@ public virtual Task GetRollupCapsAsync(CancellationToken /// /// - /// Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// Get the rollup job capabilities. + /// Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. + /// + /// + /// This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. + /// Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. + /// This API enables you to inspect an index and determine: + /// + /// + /// + /// + /// Does this index have associated rollup data somewhere in the cluster? /// + /// + /// + /// + /// If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupCapsAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -826,8 +1690,22 @@ public virtual Task GetRollupCapsAsync(Action /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: + /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -839,8 +1717,22 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(GetRollupIndexCapsR /// /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: + /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? + /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(GetRollupIndexCapsRequest request, CancellationToken cancellationToken = default) @@ -851,8 +1743,22 @@ public virtual Task GetRollupIndexCapsAsync(GetRollu /// /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? + /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -864,8 +1770,22 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(GetRollu /// /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: + /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -878,8 +1798,22 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(Elastic. /// /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: + /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? + /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -893,8 +1827,22 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(Elastic. /// /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? + /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -906,8 +1854,22 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(GetRollupIndexCapsR /// /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? + /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -920,8 +1882,22 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(Elastic.Clients.Ela /// /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: + /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -935,8 +1911,22 @@ public virtual GetRollupIndexCapsResponse GetRollupIndexCaps(Elastic.Clients.Ela /// /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? + /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(GetRollupIndexCapsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -947,8 +1937,22 @@ public virtual Task GetRollupIndexCapsAsync /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: + /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? + /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(Elastic.Clients.Elasticsearch.Ids index, CancellationToken cancellationToken = default) @@ -960,8 +1964,22 @@ public virtual Task GetRollupIndexCapsAsync /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: + /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(Elastic.Clients.Elasticsearch.Ids index, Action> configureRequest, CancellationToken cancellationToken = default) @@ -974,8 +1992,22 @@ public virtual Task GetRollupIndexCapsAsync /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? + /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(GetRollupIndexCapsRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -986,8 +2018,22 @@ public virtual Task GetRollupIndexCapsAsync(GetRollu /// /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: + /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? + /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(Elastic.Clients.Elasticsearch.Ids index, CancellationToken cancellationToken = default) @@ -999,8 +2045,22 @@ public virtual Task GetRollupIndexCapsAsync(Elastic. /// /// - /// Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored). + /// Get the rollup index capabilities. + /// Get the rollup capabilities of all jobs inside of a rollup index. + /// A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: + /// + /// + /// + /// + /// What jobs are stored in an index (or indices specified via a pattern)? /// + /// + /// + /// + /// What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task GetRollupIndexCapsAsync(Elastic.Clients.Elasticsearch.Ids index, Action configureRequest, CancellationToken cancellationToken = default) @@ -1013,7 +2073,19 @@ public virtual Task GetRollupIndexCapsAsync(Elastic. /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1026,7 +2098,19 @@ public virtual PutJobResponse PutJob(PutJobRequest request) /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1038,7 +2122,19 @@ public virtual Task PutJobAsync(PutJobRequest request, Cancellat /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1051,7 +2147,19 @@ public virtual PutJobResponse PutJob(PutJobRequestDescriptor /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1065,7 +2173,19 @@ public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1080,7 +2200,19 @@ public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1093,7 +2225,19 @@ public virtual PutJobResponse PutJob(PutJobRequestDescriptor descriptor) /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1107,7 +2251,19 @@ public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id id) /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1122,7 +2278,19 @@ public virtual PutJobResponse PutJob(Elastic.Clients.Elasticsearch.Id id, Action /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1134,7 +2302,19 @@ public virtual Task PutJobAsync(PutJobRequestDescript /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1147,7 +2327,19 @@ public virtual Task PutJobAsync(Elastic.Clients.Elast /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1161,7 +2353,19 @@ public virtual Task PutJobAsync(Elastic.Clients.Elast /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1173,7 +2377,19 @@ public virtual Task PutJobAsync(PutJobRequestDescriptor descript /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1186,7 +2402,19 @@ public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id /// /// - /// Creates a rollup job. + /// Create a rollup job. + /// + /// + /// WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. + /// + /// + /// The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. + /// + /// + /// There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. + /// + /// + /// Jobs are created in a STOPPED state. You can start them with the start rollup jobs API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1200,7 +2428,9 @@ public virtual Task PutJobAsync(Elastic.Clients.Elasticsearch.Id /// /// - /// Enables searching rolled-up data using the standard Query DSL. + /// Search rolled-up data. + /// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + /// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1213,7 +2443,9 @@ public virtual RollupSearchResponse RollupSearch(RollupSea /// /// - /// Enables searching rolled-up data using the standard Query DSL. + /// Search rolled-up data. + /// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + /// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1225,7 +2457,9 @@ public virtual Task> RollupSearchAsync /// - /// Enables searching rolled-up data using the standard Query DSL. + /// Search rolled-up data. + /// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + /// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1238,7 +2472,9 @@ public virtual RollupSearchResponse RollupSearch(RollupSea /// /// - /// Enables searching rolled-up data using the standard Query DSL. + /// Search rolled-up data. + /// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + /// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1252,7 +2488,9 @@ public virtual RollupSearchResponse RollupSearch(Elastic.C /// /// - /// Enables searching rolled-up data using the standard Query DSL. + /// Search rolled-up data. + /// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + /// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1267,7 +2505,9 @@ public virtual RollupSearchResponse RollupSearch(Elastic.C /// /// - /// Enables searching rolled-up data using the standard Query DSL. + /// Search rolled-up data. + /// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + /// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1281,7 +2521,9 @@ public virtual RollupSearchResponse RollupSearch() /// /// - /// Enables searching rolled-up data using the standard Query DSL. + /// Search rolled-up data. + /// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + /// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1296,7 +2538,9 @@ public virtual RollupSearchResponse RollupSearch(Action /// - /// Enables searching rolled-up data using the standard Query DSL. + /// Search rolled-up data. + /// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + /// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1308,7 +2552,9 @@ public virtual Task> RollupSearchAsync /// - /// Enables searching rolled-up data using the standard Query DSL. + /// Search rolled-up data. + /// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + /// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1321,7 +2567,9 @@ public virtual Task> RollupSearchAsync /// - /// Enables searching rolled-up data using the standard Query DSL. + /// Search rolled-up data. + /// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + /// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1335,7 +2583,9 @@ public virtual Task> RollupSearchAsync /// - /// Enables searching rolled-up data using the standard Query DSL. + /// Search rolled-up data. + /// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + /// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1348,7 +2598,9 @@ public virtual Task> RollupSearchAsync /// - /// Enables searching rolled-up data using the standard Query DSL. + /// Search rolled-up data. + /// The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. + /// It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1362,7 +2614,9 @@ public virtual Task> RollupSearchAsync /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1375,7 +2629,9 @@ public virtual StartJobResponse StartJob(StartJobRequest request) /// /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1387,7 +2643,9 @@ public virtual Task StartJobAsync(StartJobRequest request, Can /// /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1400,7 +2658,9 @@ public virtual StartJobResponse StartJob(StartJobRequestDescriptor /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1414,7 +2674,9 @@ public virtual StartJobResponse StartJob(Elastic.Clients.Elasticsearc /// /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1429,7 +2691,9 @@ public virtual StartJobResponse StartJob(Elastic.Clients.Elasticsearc /// /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1442,7 +2706,9 @@ public virtual StartJobResponse StartJob(StartJobRequestDescriptor descriptor) /// /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1456,7 +2722,9 @@ public virtual StartJobResponse StartJob(Elastic.Clients.Elasticsearch.Id id) /// /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1471,7 +2739,9 @@ public virtual StartJobResponse StartJob(Elastic.Clients.Elasticsearch.Id id, Ac /// /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1483,7 +2753,9 @@ public virtual Task StartJobAsync(StartJobRequestDe /// /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1496,7 +2768,9 @@ public virtual Task StartJobAsync(Elastic.Clients.E /// /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1510,7 +2784,9 @@ public virtual Task StartJobAsync(Elastic.Clients.E /// /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1522,7 +2798,9 @@ public virtual Task StartJobAsync(StartJobRequestDescriptor de /// /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1535,7 +2813,9 @@ public virtual Task StartJobAsync(Elastic.Clients.Elasticsearc /// /// - /// Starts an existing, stopped rollup job. + /// Start rollup jobs. + /// If you try to start a job that does not exist, an exception occurs. + /// If you try to start a job that is already started, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1549,7 +2829,9 @@ public virtual Task StartJobAsync(Elastic.Clients.Elasticsearc /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1562,7 +2844,9 @@ public virtual StopJobResponse StopJob(StopJobRequest request) /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1574,7 +2858,9 @@ public virtual Task StopJobAsync(StopJobRequest request, Cancel /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1587,7 +2873,9 @@ public virtual StopJobResponse StopJob(StopJobRequestDescriptor /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1601,7 +2889,9 @@ public virtual StopJobResponse StopJob(Elastic.Clients.Elasticsearch. /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1616,7 +2906,9 @@ public virtual StopJobResponse StopJob(Elastic.Clients.Elasticsearch. /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1629,7 +2921,9 @@ public virtual StopJobResponse StopJob(StopJobRequestDescriptor descriptor) /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1643,7 +2937,9 @@ public virtual StopJobResponse StopJob(Elastic.Clients.Elasticsearch.Id id) /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1658,7 +2954,9 @@ public virtual StopJobResponse StopJob(Elastic.Clients.Elasticsearch.Id id, Acti /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1670,7 +2968,9 @@ public virtual Task StopJobAsync(StopJobRequestDescr /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1683,7 +2983,9 @@ public virtual Task StopJobAsync(Elastic.Clients.Ela /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1697,7 +2999,9 @@ public virtual Task StopJobAsync(Elastic.Clients.Ela /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1709,7 +3013,9 @@ public virtual Task StopJobAsync(StopJobRequestDescriptor descr /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1722,7 +3028,9 @@ public virtual Task StopJobAsync(Elastic.Clients.Elasticsearch. /// /// - /// Stops an existing, started rollup job. + /// Stop rollup jobs. + /// If you try to stop a job that does not exist, an exception occurs. + /// If you try to stop a job that is already stopped, nothing happens. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 fc2498eaccd..856c7d76569 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.SearchableSnapshots.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchableSnapshots.g.cs index 945240c26f2..a95a69b5f0d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchableSnapshots.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.SearchableSnapshots.g.cs @@ -41,7 +41,8 @@ internal SearchableSnapshotsNamespacedClient(ElasticsearchClient client) : base( /// /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// Get cache statistics. + /// Get statistics about the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +55,8 @@ public virtual CacheStatsResponse CacheStats(CacheStatsRequest request) /// /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// Get cache statistics. + /// Get statistics about the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +68,8 @@ public virtual Task CacheStatsAsync(CacheStatsRequest reques /// /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// Get cache statistics. + /// Get statistics about the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +82,8 @@ public virtual CacheStatsResponse CacheStats(CacheStatsRequestDescriptor descrip /// /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// Get cache statistics. + /// Get statistics about the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +97,8 @@ public virtual CacheStatsResponse CacheStats(Elastic.Clients.Elasticsearch.NodeI /// /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// Get cache statistics. + /// Get statistics about the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +113,8 @@ public virtual CacheStatsResponse CacheStats(Elastic.Clients.Elasticsearch.NodeI /// /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// Get cache statistics. + /// Get statistics about the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -122,7 +128,8 @@ public virtual CacheStatsResponse CacheStats() /// /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// Get cache statistics. + /// Get statistics about the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -137,7 +144,8 @@ public virtual CacheStatsResponse CacheStats(Action /// /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// Get cache statistics. + /// Get statistics about the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -149,7 +157,8 @@ public virtual Task CacheStatsAsync(CacheStatsRequestDescrip /// /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// Get cache statistics. + /// Get statistics about the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -162,7 +171,8 @@ public virtual Task CacheStatsAsync(Elastic.Clients.Elastics /// /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// Get cache statistics. + /// Get statistics about the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -176,7 +186,8 @@ public virtual Task CacheStatsAsync(Elastic.Clients.Elastics /// /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// Get cache statistics. + /// Get statistics about the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -189,7 +200,8 @@ public virtual Task CacheStatsAsync(CancellationToken cancel /// /// - /// Retrieve node-level cache statistics about searchable snapshots. + /// Get cache statistics. + /// Get statistics about the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -203,7 +215,8 @@ public virtual Task CacheStatsAsync(Action /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -216,7 +229,8 @@ public virtual ClearCacheResponse ClearCache(ClearCacheRequest request) /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -228,7 +242,8 @@ public virtual Task ClearCacheAsync(ClearCacheRequest reques /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -241,7 +256,8 @@ public virtual ClearCacheResponse ClearCache(ClearCacheRequestDescrip /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -255,7 +271,8 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elastics /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -270,7 +287,8 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elastics /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -284,7 +302,8 @@ public virtual ClearCacheResponse ClearCache() /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -299,7 +318,8 @@ public virtual ClearCacheResponse ClearCache(Action /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -312,7 +332,8 @@ public virtual ClearCacheResponse ClearCache(ClearCacheRequestDescriptor descrip /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -326,7 +347,8 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elasticsearch.Indic /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -341,7 +363,8 @@ public virtual ClearCacheResponse ClearCache(Elastic.Clients.Elasticsearch.Indic /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -355,7 +378,8 @@ public virtual ClearCacheResponse ClearCache() /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -370,7 +394,8 @@ public virtual ClearCacheResponse ClearCache(Action /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -382,7 +407,8 @@ public virtual Task ClearCacheAsync(ClearCacheReq /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -395,7 +421,8 @@ public virtual Task ClearCacheAsync(Elastic.Clien /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -409,7 +436,8 @@ public virtual Task ClearCacheAsync(Elastic.Clien /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -422,7 +450,8 @@ public virtual Task ClearCacheAsync(CancellationT /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -436,7 +465,8 @@ public virtual Task ClearCacheAsync(Action /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -448,7 +478,8 @@ public virtual Task ClearCacheAsync(ClearCacheRequestDescrip /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -461,7 +492,8 @@ public virtual Task ClearCacheAsync(Elastic.Clients.Elastics /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -475,7 +507,8 @@ public virtual Task ClearCacheAsync(Elastic.Clients.Elastics /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -488,7 +521,8 @@ public virtual Task ClearCacheAsync(CancellationToken cancel /// /// - /// Clear the cache of searchable snapshots. + /// Clear the cache. + /// Clear indices and data streams from the shared cache for partially mounted indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -502,7 +536,10 @@ public virtual Task ClearCacheAsync(Action /// - /// Mount a snapshot as a searchable index. + /// Mount a snapshot. + /// Mount a snapshot as a searchable snapshot index. + /// Do not use this API for snapshots managed by index lifecycle management (ILM). + /// Manually mounting ILM-managed snapshots can interfere with ILM processes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -515,7 +552,10 @@ public virtual MountResponse Mount(MountRequest request) /// /// - /// Mount a snapshot as a searchable index. + /// Mount a snapshot. + /// Mount a snapshot as a searchable snapshot index. + /// Do not use this API for snapshots managed by index lifecycle management (ILM). + /// Manually mounting ILM-managed snapshots can interfere with ILM processes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -527,7 +567,10 @@ public virtual Task MountAsync(MountRequest request, Cancellation /// /// - /// Mount a snapshot as a searchable index. + /// Mount a snapshot. + /// Mount a snapshot as a searchable snapshot index. + /// Do not use this API for snapshots managed by index lifecycle management (ILM). + /// Manually mounting ILM-managed snapshots can interfere with ILM processes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -540,7 +583,10 @@ public virtual MountResponse Mount(MountRequestDescriptor descriptor) /// /// - /// Mount a snapshot as a searchable index. + /// Mount a snapshot. + /// Mount a snapshot as a searchable snapshot index. + /// Do not use this API for snapshots managed by index lifecycle management (ILM). + /// Manually mounting ILM-managed snapshots can interfere with ILM processes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -554,7 +600,10 @@ public virtual MountResponse Mount(Elastic.Clients.Elasticsearch.Name repository /// /// - /// Mount a snapshot as a searchable index. + /// Mount a snapshot. + /// Mount a snapshot as a searchable snapshot index. + /// Do not use this API for snapshots managed by index lifecycle management (ILM). + /// Manually mounting ILM-managed snapshots can interfere with ILM processes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -569,7 +618,10 @@ public virtual MountResponse Mount(Elastic.Clients.Elasticsearch.Name repository /// /// - /// Mount a snapshot as a searchable index. + /// Mount a snapshot. + /// Mount a snapshot as a searchable snapshot index. + /// Do not use this API for snapshots managed by index lifecycle management (ILM). + /// Manually mounting ILM-managed snapshots can interfere with ILM processes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -581,7 +633,10 @@ public virtual Task MountAsync(MountRequestDescriptor descriptor, /// /// - /// Mount a snapshot as a searchable index. + /// Mount a snapshot. + /// Mount a snapshot as a searchable snapshot index. + /// Do not use this API for snapshots managed by index lifecycle management (ILM). + /// Manually mounting ILM-managed snapshots can interfere with ILM processes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -594,7 +649,10 @@ public virtual Task MountAsync(Elastic.Clients.Elasticsearch.Name /// /// - /// Mount a snapshot as a searchable index. + /// Mount a snapshot. + /// Mount a snapshot as a searchable snapshot index. + /// Do not use this API for snapshots managed by index lifecycle management (ILM). + /// Manually mounting ILM-managed snapshots can interfere with ILM processes. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -608,7 +666,7 @@ public virtual Task MountAsync(Elastic.Clients.Elasticsearch.Name /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -621,7 +679,7 @@ public virtual SearchableSnapshotsStatsResponse Stats(SearchableSnapshotsStatsRe /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -633,7 +691,7 @@ public virtual Task StatsAsync(SearchableSnaps /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -646,7 +704,7 @@ public virtual SearchableSnapshotsStatsResponse Stats(SearchableSnaps /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -660,7 +718,7 @@ public virtual SearchableSnapshotsStatsResponse Stats(Elastic.Clients /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -675,7 +733,7 @@ public virtual SearchableSnapshotsStatsResponse Stats(Elastic.Clients /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -689,7 +747,7 @@ public virtual SearchableSnapshotsStatsResponse Stats() /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -704,7 +762,7 @@ public virtual SearchableSnapshotsStatsResponse Stats(Action /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -717,7 +775,7 @@ public virtual SearchableSnapshotsStatsResponse Stats(SearchableSnapshotsStatsRe /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -731,7 +789,7 @@ public virtual SearchableSnapshotsStatsResponse Stats(Elastic.Clients.Elasticsea /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -746,7 +804,7 @@ public virtual SearchableSnapshotsStatsResponse Stats(Elastic.Clients.Elasticsea /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -760,7 +818,7 @@ public virtual SearchableSnapshotsStatsResponse Stats() /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -775,7 +833,7 @@ public virtual SearchableSnapshotsStatsResponse Stats(Action /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -787,7 +845,7 @@ public virtual Task StatsAsync(Sear /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -800,7 +858,7 @@ public virtual Task StatsAsync(Elas /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -814,7 +872,7 @@ public virtual Task StatsAsync(Elas /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -827,7 +885,7 @@ public virtual Task StatsAsync(Canc /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -841,7 +899,7 @@ public virtual Task StatsAsync(Acti /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -853,7 +911,7 @@ public virtual Task StatsAsync(SearchableSnaps /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -866,7 +924,7 @@ public virtual Task StatsAsync(Elastic.Clients /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -880,7 +938,7 @@ public virtual Task StatsAsync(Elastic.Clients /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -893,7 +951,7 @@ public virtual Task StatsAsync(CancellationTok /// /// - /// Retrieve shard-level statistics about searchable snapshots. + /// Get searchable snapshot statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 d35c282ebc8..65290355da1 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.Slm.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Slm.g.cs index 04763164837..10afe02d0cf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Slm.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Slm.g.cs @@ -41,7 +41,9 @@ internal SnapshotLifecycleManagementNamespacedClient(ElasticsearchClient client) /// /// - /// Deletes an existing snapshot lifecycle policy. + /// Delete a policy. + /// Delete a snapshot lifecycle policy definition. + /// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +56,9 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(DeleteLifecycleRequest re /// /// - /// Deletes an existing snapshot lifecycle policy. + /// Delete a policy. + /// Delete a snapshot lifecycle policy definition. + /// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +70,9 @@ public virtual Task DeleteLifecycleAsync(DeleteLifecycl /// /// - /// Deletes an existing snapshot lifecycle policy. + /// Delete a policy. + /// Delete a snapshot lifecycle policy definition. + /// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +85,9 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(DeleteLifecycleRequestDes /// /// - /// Deletes an existing snapshot lifecycle policy. + /// Delete a policy. + /// Delete a snapshot lifecycle policy definition. + /// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +101,9 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(Elastic.Clients.Elasticse /// /// - /// Deletes an existing snapshot lifecycle policy. + /// Delete a policy. + /// Delete a snapshot lifecycle policy definition. + /// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +118,9 @@ public virtual DeleteLifecycleResponse DeleteLifecycle(Elastic.Clients.Elasticse /// /// - /// Deletes an existing snapshot lifecycle policy. + /// Delete a policy. + /// Delete a snapshot lifecycle policy definition. + /// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -120,7 +132,9 @@ public virtual Task DeleteLifecycleAsync(DeleteLifecycl /// /// - /// Deletes an existing snapshot lifecycle policy. + /// Delete a policy. + /// Delete a snapshot lifecycle policy definition. + /// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -133,7 +147,9 @@ public virtual Task DeleteLifecycleAsync(Elastic.Client /// /// - /// Deletes an existing snapshot lifecycle policy. + /// Delete a policy. + /// Delete a snapshot lifecycle policy definition. + /// This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -147,7 +163,9 @@ public virtual Task DeleteLifecycleAsync(Elastic.Client /// /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// Run a policy. + /// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + /// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -160,7 +178,9 @@ public virtual ExecuteLifecycleResponse ExecuteLifecycle(ExecuteLifecycleRequest /// /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// Run a policy. + /// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + /// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -172,7 +192,9 @@ public virtual Task ExecuteLifecycleAsync(ExecuteLifec /// /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// Run a policy. + /// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + /// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -185,7 +207,9 @@ public virtual ExecuteLifecycleResponse ExecuteLifecycle(ExecuteLifecycleRequest /// /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// Run a policy. + /// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + /// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -199,7 +223,9 @@ public virtual ExecuteLifecycleResponse ExecuteLifecycle(Elastic.Clients.Elastic /// /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// Run a policy. + /// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + /// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -214,7 +240,9 @@ public virtual ExecuteLifecycleResponse ExecuteLifecycle(Elastic.Clients.Elastic /// /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// Run a policy. + /// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + /// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -226,7 +254,9 @@ public virtual Task ExecuteLifecycleAsync(ExecuteLifec /// /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// Run a policy. + /// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + /// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -239,7 +269,9 @@ public virtual Task ExecuteLifecycleAsync(Elastic.Clie /// /// - /// Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + /// Run a policy. + /// Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + /// The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -253,7 +285,9 @@ public virtual Task ExecuteLifecycleAsync(Elastic.Clie /// /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// Run a retention policy. + /// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + /// The retention policy is normally applied according to its schedule. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -266,7 +300,9 @@ public virtual ExecuteRetentionResponse ExecuteRetention(ExecuteRetentionRequest /// /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// Run a retention policy. + /// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + /// The retention policy is normally applied according to its schedule. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -278,7 +314,9 @@ public virtual Task ExecuteRetentionAsync(ExecuteReten /// /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// Run a retention policy. + /// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + /// The retention policy is normally applied according to its schedule. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -291,7 +329,9 @@ public virtual ExecuteRetentionResponse ExecuteRetention(ExecuteRetentionRequest /// /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// Run a retention policy. + /// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + /// The retention policy is normally applied according to its schedule. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -305,7 +345,9 @@ public virtual ExecuteRetentionResponse ExecuteRetention() /// /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// Run a retention policy. + /// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + /// The retention policy is normally applied according to its schedule. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -320,7 +362,9 @@ public virtual ExecuteRetentionResponse ExecuteRetention(Action /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// Run a retention policy. + /// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + /// The retention policy is normally applied according to its schedule. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -332,7 +376,9 @@ public virtual Task ExecuteRetentionAsync(ExecuteReten /// /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// Run a retention policy. + /// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + /// The retention policy is normally applied according to its schedule. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -345,7 +391,9 @@ public virtual Task ExecuteRetentionAsync(Cancellation /// /// - /// Deletes any snapshots that are expired according to the policy's retention rules. + /// Run a retention policy. + /// Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + /// The retention policy is normally applied according to its schedule. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -359,7 +407,8 @@ public virtual Task ExecuteRetentionAsync(Action /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -372,7 +421,8 @@ public virtual GetLifecycleResponse GetLifecycle(GetLifecycleRequest request) /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -384,7 +434,8 @@ public virtual Task GetLifecycleAsync(GetLifecycleRequest /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -397,7 +448,8 @@ public virtual GetLifecycleResponse GetLifecycle(GetLifecycleRequestDescriptor d /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -411,7 +463,8 @@ public virtual GetLifecycleResponse GetLifecycle(Elastic.Clients.Elasticsearch.N /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -426,7 +479,8 @@ public virtual GetLifecycleResponse GetLifecycle(Elastic.Clients.Elasticsearch.N /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -440,7 +494,8 @@ public virtual GetLifecycleResponse GetLifecycle() /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -455,7 +510,8 @@ public virtual GetLifecycleResponse GetLifecycle(Action /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -467,7 +523,8 @@ public virtual Task GetLifecycleAsync(GetLifecycleRequestD /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -480,7 +537,8 @@ public virtual Task GetLifecycleAsync(Elastic.Clients.Elas /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -494,7 +552,8 @@ public virtual Task GetLifecycleAsync(Elastic.Clients.Elas /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -507,7 +566,8 @@ public virtual Task GetLifecycleAsync(CancellationToken ca /// /// - /// Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + /// Get policy information. + /// Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -521,7 +581,8 @@ public virtual Task GetLifecycleAsync(Action /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// Get snapshot lifecycle management statistics. + /// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -534,7 +595,8 @@ public virtual GetStatsResponse GetStats(GetStatsRequest request) /// /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// Get snapshot lifecycle management statistics. + /// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -546,7 +608,8 @@ public virtual Task GetStatsAsync(GetStatsRequest request, Can /// /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// Get snapshot lifecycle management statistics. + /// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -559,7 +622,8 @@ public virtual GetStatsResponse GetStats(GetStatsRequestDescriptor descriptor) /// /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// Get snapshot lifecycle management statistics. + /// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -573,7 +637,8 @@ public virtual GetStatsResponse GetStats() /// /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// Get snapshot lifecycle management statistics. + /// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -588,7 +653,8 @@ public virtual GetStatsResponse GetStats(Action confi /// /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// Get snapshot lifecycle management statistics. + /// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -600,7 +666,8 @@ public virtual Task GetStatsAsync(GetStatsRequestDescriptor de /// /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// Get snapshot lifecycle management statistics. + /// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -613,7 +680,8 @@ public virtual Task GetStatsAsync(CancellationToken cancellati /// /// - /// Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + /// Get snapshot lifecycle management statistics. + /// Get global and policy-level statistics about actions taken by snapshot lifecycle management. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -627,7 +695,7 @@ public virtual Task GetStatsAsync(Action /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// Get the snapshot lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -640,7 +708,7 @@ public virtual GetSlmStatusResponse GetStatus(GetSlmStatusRequest request) /// /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// Get the snapshot lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -652,7 +720,7 @@ public virtual Task GetStatusAsync(GetSlmStatusRequest req /// /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// Get the snapshot lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -665,7 +733,7 @@ public virtual GetSlmStatusResponse GetStatus(GetSlmStatusRequestDescriptor desc /// /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// Get the snapshot lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -679,7 +747,7 @@ public virtual GetSlmStatusResponse GetStatus() /// /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// Get the snapshot lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -694,7 +762,7 @@ public virtual GetSlmStatusResponse GetStatus(Action /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// Get the snapshot lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -706,7 +774,7 @@ public virtual Task GetStatusAsync(GetSlmStatusRequestDesc /// /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// Get the snapshot lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -719,7 +787,7 @@ public virtual Task GetStatusAsync(CancellationToken cance /// /// - /// Retrieves the status of snapshot lifecycle management (SLM). + /// Get the snapshot lifecycle management status. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -733,7 +801,10 @@ public virtual Task GetStatusAsync(Action /// - /// Creates or updates a snapshot lifecycle policy. + /// Create or update a policy. + /// Create or update a snapshot lifecycle policy. + /// If the policy already exists, this request increments the policy version. + /// Only the latest version of a policy is stored. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -746,7 +817,10 @@ public virtual PutLifecycleResponse PutLifecycle(PutLifecycleRequest request) /// /// - /// Creates or updates a snapshot lifecycle policy. + /// Create or update a policy. + /// Create or update a snapshot lifecycle policy. + /// If the policy already exists, this request increments the policy version. + /// Only the latest version of a policy is stored. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -758,7 +832,10 @@ public virtual Task PutLifecycleAsync(PutLifecycleRequest /// /// - /// Creates or updates a snapshot lifecycle policy. + /// Create or update a policy. + /// Create or update a snapshot lifecycle policy. + /// If the policy already exists, this request increments the policy version. + /// Only the latest version of a policy is stored. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -771,7 +848,10 @@ public virtual PutLifecycleResponse PutLifecycle(PutLifecycleRequestDescriptor d /// /// - /// Creates or updates a snapshot lifecycle policy. + /// Create or update a policy. + /// Create or update a snapshot lifecycle policy. + /// If the policy already exists, this request increments the policy version. + /// Only the latest version of a policy is stored. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -785,7 +865,10 @@ public virtual PutLifecycleResponse PutLifecycle(Elastic.Clients.Elasticsearch.N /// /// - /// Creates or updates a snapshot lifecycle policy. + /// Create or update a policy. + /// Create or update a snapshot lifecycle policy. + /// If the policy already exists, this request increments the policy version. + /// Only the latest version of a policy is stored. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -800,7 +883,10 @@ public virtual PutLifecycleResponse PutLifecycle(Elastic.Clients.Elasticsearch.N /// /// - /// Creates or updates a snapshot lifecycle policy. + /// Create or update a policy. + /// Create or update a snapshot lifecycle policy. + /// If the policy already exists, this request increments the policy version. + /// Only the latest version of a policy is stored. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -812,7 +898,10 @@ public virtual Task PutLifecycleAsync(PutLifecycleRequestD /// /// - /// Creates or updates a snapshot lifecycle policy. + /// Create or update a policy. + /// Create or update a snapshot lifecycle policy. + /// If the policy already exists, this request increments the policy version. + /// Only the latest version of a policy is stored. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -825,7 +914,10 @@ public virtual Task PutLifecycleAsync(Elastic.Clients.Elas /// /// - /// Creates or updates a snapshot lifecycle policy. + /// Create or update a policy. + /// Create or update a snapshot lifecycle policy. + /// If the policy already exists, this request increments the policy version. + /// Only the latest version of a policy is stored. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -839,7 +931,9 @@ public virtual Task PutLifecycleAsync(Elastic.Clients.Elas /// /// - /// Turns on snapshot lifecycle management (SLM). + /// Start snapshot lifecycle management. + /// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + /// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -852,7 +946,9 @@ public virtual StartSlmResponse Start(StartSlmRequest request) /// /// - /// Turns on snapshot lifecycle management (SLM). + /// Start snapshot lifecycle management. + /// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + /// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -864,7 +960,9 @@ public virtual Task StartAsync(StartSlmRequest request, Cancel /// /// - /// Turns on snapshot lifecycle management (SLM). + /// Start snapshot lifecycle management. + /// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + /// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -877,7 +975,9 @@ public virtual StartSlmResponse Start(StartSlmRequestDescriptor descriptor) /// /// - /// Turns on snapshot lifecycle management (SLM). + /// Start snapshot lifecycle management. + /// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + /// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -891,7 +991,9 @@ public virtual StartSlmResponse Start() /// /// - /// Turns on snapshot lifecycle management (SLM). + /// Start snapshot lifecycle management. + /// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + /// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -906,7 +1008,9 @@ public virtual StartSlmResponse Start(Action configur /// /// - /// Turns on snapshot lifecycle management (SLM). + /// Start snapshot lifecycle management. + /// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + /// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -918,7 +1022,9 @@ public virtual Task StartAsync(StartSlmRequestDescriptor descr /// /// - /// Turns on snapshot lifecycle management (SLM). + /// Start snapshot lifecycle management. + /// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + /// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -931,7 +1037,9 @@ public virtual Task StartAsync(CancellationToken cancellationT /// /// - /// Turns on snapshot lifecycle management (SLM). + /// Start snapshot lifecycle management. + /// Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + /// Manually starting SLM is necessary only if it has been stopped using the stop SLM API. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -945,7 +1053,15 @@ public virtual Task StartAsync(Action /// - /// Turns off snapshot lifecycle management (SLM). + /// Stop snapshot lifecycle management. + /// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + /// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + /// Stopping SLM does not stop any snapshots that are in progress. + /// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + /// + /// + /// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + /// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -958,7 +1074,15 @@ public virtual StopSlmResponse Stop(StopSlmRequest request) /// /// - /// Turns off snapshot lifecycle management (SLM). + /// Stop snapshot lifecycle management. + /// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + /// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + /// Stopping SLM does not stop any snapshots that are in progress. + /// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + /// + /// + /// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + /// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -970,7 +1094,15 @@ public virtual Task StopAsync(StopSlmRequest request, Cancellat /// /// - /// Turns off snapshot lifecycle management (SLM). + /// Stop snapshot lifecycle management. + /// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + /// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + /// Stopping SLM does not stop any snapshots that are in progress. + /// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + /// + /// + /// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + /// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -983,7 +1115,15 @@ public virtual StopSlmResponse Stop(StopSlmRequestDescriptor descriptor) /// /// - /// Turns off snapshot lifecycle management (SLM). + /// Stop snapshot lifecycle management. + /// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + /// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + /// Stopping SLM does not stop any snapshots that are in progress. + /// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + /// + /// + /// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + /// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -997,7 +1137,15 @@ public virtual StopSlmResponse Stop() /// /// - /// Turns off snapshot lifecycle management (SLM). + /// Stop snapshot lifecycle management. + /// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + /// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + /// Stopping SLM does not stop any snapshots that are in progress. + /// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + /// + /// + /// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + /// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1012,7 +1160,15 @@ public virtual StopSlmResponse Stop(Action configureRe /// /// - /// Turns off snapshot lifecycle management (SLM). + /// Stop snapshot lifecycle management. + /// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + /// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + /// Stopping SLM does not stop any snapshots that are in progress. + /// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + /// + /// + /// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + /// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1024,7 +1180,15 @@ public virtual Task StopAsync(StopSlmRequestDescriptor descript /// /// - /// Turns off snapshot lifecycle management (SLM). + /// Stop snapshot lifecycle management. + /// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + /// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + /// Stopping SLM does not stop any snapshots that are in progress. + /// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + /// + /// + /// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + /// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1037,7 +1201,15 @@ public virtual Task StopAsync(CancellationToken cancellationTok /// /// - /// Turns off snapshot lifecycle management (SLM). + /// Stop snapshot lifecycle management. + /// Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + /// This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + /// Stopping SLM does not stop any snapshots that are in progress. + /// You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + /// + /// + /// The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + /// Use the get snapshot lifecycle management status API to see if SLM is running. /// /// 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 cc63541ea80..ad3a2767b86 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Snapshot.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Snapshot.g.cs @@ -41,7 +41,8 @@ internal SnapshotNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// Clean up the snapshot repository. + /// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +55,8 @@ public virtual CleanupRepositoryResponse CleanupRepository(CleanupRepositoryRequ /// /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// Clean up the snapshot repository. + /// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +68,8 @@ public virtual Task CleanupRepositoryAsync(CleanupRep /// /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// Clean up the snapshot repository. + /// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +82,8 @@ public virtual CleanupRepositoryResponse CleanupRepository(CleanupRepositoryRequ /// /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// Clean up the snapshot repository. + /// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +97,8 @@ public virtual CleanupRepositoryResponse CleanupRepository(Elastic.Clients.Elast /// /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// Clean up the snapshot repository. + /// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +113,8 @@ public virtual CleanupRepositoryResponse CleanupRepository(Elastic.Clients.Elast /// /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// Clean up the snapshot repository. + /// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -120,7 +126,8 @@ public virtual Task CleanupRepositoryAsync(CleanupRep /// /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// Clean up the snapshot repository. + /// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -133,7 +140,8 @@ public virtual Task CleanupRepositoryAsync(Elastic.Cl /// /// - /// Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots. + /// Clean up the snapshot repository. + /// Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -147,7 +155,8 @@ public virtual Task CleanupRepositoryAsync(Elastic.Cl /// /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// Clone a snapshot. + /// Clone part of all of a snapshot into another snapshot in the same repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -160,7 +169,8 @@ public virtual CloneSnapshotResponse Clone(CloneSnapshotRequest request) /// /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// Clone a snapshot. + /// Clone part of all of a snapshot into another snapshot in the same repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -172,7 +182,8 @@ public virtual Task CloneAsync(CloneSnapshotRequest reque /// /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// Clone a snapshot. + /// Clone part of all of a snapshot into another snapshot in the same repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -185,7 +196,8 @@ public virtual CloneSnapshotResponse Clone(CloneSnapshotRequestDescriptor descri /// /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// Clone a snapshot. + /// Clone part of all of a snapshot into another snapshot in the same repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -199,7 +211,8 @@ public virtual CloneSnapshotResponse Clone(Elastic.Clients.Elasticsearch.Name re /// /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// Clone a snapshot. + /// Clone part of all of a snapshot into another snapshot in the same repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -214,7 +227,8 @@ public virtual CloneSnapshotResponse Clone(Elastic.Clients.Elasticsearch.Name re /// /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// Clone a snapshot. + /// Clone part of all of a snapshot into another snapshot in the same repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -226,7 +240,8 @@ public virtual Task CloneAsync(CloneSnapshotRequestDescri /// /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// Clone a snapshot. + /// Clone part of all of a snapshot into another snapshot in the same repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -239,7 +254,8 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsea /// /// - /// Clones indices from one snapshot into another snapshot in the same repository. + /// Clone a snapshot. + /// Clone part of all of a snapshot into another snapshot in the same repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -253,7 +269,8 @@ public virtual Task CloneAsync(Elastic.Clients.Elasticsea /// /// - /// Creates a snapshot in a repository. + /// Create a snapshot. + /// Take a snapshot of a cluster or of data streams and indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -266,7 +283,8 @@ public virtual CreateSnapshotResponse Create(CreateSnapshotRequest request) /// /// - /// Creates a snapshot in a repository. + /// Create a snapshot. + /// Take a snapshot of a cluster or of data streams and indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -278,7 +296,8 @@ public virtual Task CreateAsync(CreateSnapshotRequest re /// /// - /// Creates a snapshot in a repository. + /// Create a snapshot. + /// Take a snapshot of a cluster or of data streams and indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -291,7 +310,8 @@ public virtual CreateSnapshotResponse Create(CreateSnapshotRequestDescriptor des /// /// - /// Creates a snapshot in a repository. + /// Create a snapshot. + /// Take a snapshot of a cluster or of data streams and indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -305,7 +325,8 @@ public virtual CreateSnapshotResponse Create(Elastic.Clients.Elasticsearch.Name /// /// - /// Creates a snapshot in a repository. + /// Create a snapshot. + /// Take a snapshot of a cluster or of data streams and indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -320,7 +341,8 @@ public virtual CreateSnapshotResponse Create(Elastic.Clients.Elasticsearch.Name /// /// - /// Creates a snapshot in a repository. + /// Create a snapshot. + /// Take a snapshot of a cluster or of data streams and indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -332,7 +354,8 @@ public virtual Task CreateAsync(CreateSnapshotRequestDes /// /// - /// Creates a snapshot in a repository. + /// Create a snapshot. + /// Take a snapshot of a cluster or of data streams and indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -345,7 +368,8 @@ public virtual Task CreateAsync(Elastic.Clients.Elastics /// /// - /// Creates a snapshot in a repository. + /// Create a snapshot. + /// Take a snapshot of a cluster or of data streams and indices. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -359,7 +383,10 @@ public virtual Task CreateAsync(Elastic.Clients.Elastics /// /// - /// Creates a repository. + /// Create or update a snapshot repository. + /// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + /// To register a snapshot repository, the cluster's global metadata must be writeable. + /// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -372,7 +399,10 @@ public virtual CreateRepositoryResponse CreateRepository(CreateRepositoryRequest /// /// - /// Creates a repository. + /// Create or update a snapshot repository. + /// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + /// To register a snapshot repository, the cluster's global metadata must be writeable. + /// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -384,7 +414,10 @@ public virtual Task CreateRepositoryAsync(CreateReposi /// /// - /// Creates a repository. + /// Create or update a snapshot repository. + /// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + /// To register a snapshot repository, the cluster's global metadata must be writeable. + /// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -397,7 +430,10 @@ public virtual CreateRepositoryResponse CreateRepository(CreateRepositoryRequest /// /// - /// Creates a repository. + /// Create or update a snapshot repository. + /// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + /// To register a snapshot repository, the cluster's global metadata must be writeable. + /// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -411,7 +447,10 @@ public virtual CreateRepositoryResponse CreateRepository(Elastic.Clients.Elastic /// /// - /// Creates a repository. + /// Create or update a snapshot repository. + /// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + /// To register a snapshot repository, the cluster's global metadata must be writeable. + /// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -426,7 +465,10 @@ public virtual CreateRepositoryResponse CreateRepository(Elastic.Clients.Elastic /// /// - /// Creates a repository. + /// Create or update a snapshot repository. + /// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + /// To register a snapshot repository, the cluster's global metadata must be writeable. + /// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -438,7 +480,10 @@ public virtual Task CreateRepositoryAsync(CreateReposi /// /// - /// Creates a repository. + /// Create or update a snapshot repository. + /// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + /// To register a snapshot repository, the cluster's global metadata must be writeable. + /// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -451,7 +496,10 @@ public virtual Task CreateRepositoryAsync(Elastic.Clie /// /// - /// Creates a repository. + /// Create or update a snapshot repository. + /// IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + /// To register a snapshot repository, the cluster's global metadata must be writeable. + /// Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -465,7 +513,7 @@ public virtual Task CreateRepositoryAsync(Elastic.Clie /// /// - /// Deletes one or more snapshots. + /// Delete snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -478,7 +526,7 @@ public virtual DeleteSnapshotResponse Delete(DeleteSnapshotRequest request) /// /// - /// Deletes one or more snapshots. + /// Delete snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -490,7 +538,7 @@ public virtual Task DeleteAsync(DeleteSnapshotRequest re /// /// - /// Deletes one or more snapshots. + /// Delete snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -503,7 +551,7 @@ public virtual DeleteSnapshotResponse Delete(DeleteSnapshotRequestDescriptor des /// /// - /// Deletes one or more snapshots. + /// Delete snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -517,7 +565,7 @@ public virtual DeleteSnapshotResponse Delete(Elastic.Clients.Elasticsearch.Name /// /// - /// Deletes one or more snapshots. + /// Delete snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -532,7 +580,7 @@ public virtual DeleteSnapshotResponse Delete(Elastic.Clients.Elasticsearch.Name /// /// - /// Deletes one or more snapshots. + /// Delete snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -544,7 +592,7 @@ public virtual Task DeleteAsync(DeleteSnapshotRequestDes /// /// - /// Deletes one or more snapshots. + /// Delete snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -557,7 +605,7 @@ public virtual Task DeleteAsync(Elastic.Clients.Elastics /// /// - /// Deletes one or more snapshots. + /// Delete snapshots. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -571,7 +619,9 @@ public virtual Task DeleteAsync(Elastic.Clients.Elastics /// /// - /// Deletes a repository. + /// Delete snapshot repositories. + /// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + /// The snapshots themselves are left untouched and in place. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -584,7 +634,9 @@ public virtual DeleteRepositoryResponse DeleteRepository(DeleteRepositoryRequest /// /// - /// Deletes a repository. + /// Delete snapshot repositories. + /// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + /// The snapshots themselves are left untouched and in place. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -596,7 +648,9 @@ public virtual Task DeleteRepositoryAsync(DeleteReposi /// /// - /// Deletes a repository. + /// Delete snapshot repositories. + /// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + /// The snapshots themselves are left untouched and in place. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -609,7 +663,9 @@ public virtual DeleteRepositoryResponse DeleteRepository(DeleteRepositoryRequest /// /// - /// Deletes a repository. + /// Delete snapshot repositories. + /// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + /// The snapshots themselves are left untouched and in place. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -623,7 +679,9 @@ public virtual DeleteRepositoryResponse DeleteRepository(Elastic.Clients.Elastic /// /// - /// Deletes a repository. + /// Delete snapshot repositories. + /// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + /// The snapshots themselves are left untouched and in place. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -638,7 +696,9 @@ public virtual DeleteRepositoryResponse DeleteRepository(Elastic.Clients.Elastic /// /// - /// Deletes a repository. + /// Delete snapshot repositories. + /// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + /// The snapshots themselves are left untouched and in place. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -650,7 +710,9 @@ public virtual Task DeleteRepositoryAsync(DeleteReposi /// /// - /// Deletes a repository. + /// Delete snapshot repositories. + /// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + /// The snapshots themselves are left untouched and in place. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -663,7 +725,9 @@ public virtual Task DeleteRepositoryAsync(Elastic.Clie /// /// - /// Deletes a repository. + /// Delete snapshot repositories. + /// When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + /// The snapshots themselves are left untouched and in place. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -677,7 +741,7 @@ public virtual Task DeleteRepositoryAsync(Elastic.Clie /// /// - /// Returns information about a snapshot. + /// Get snapshot information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -690,7 +754,7 @@ public virtual GetSnapshotResponse Get(GetSnapshotRequest request) /// /// - /// Returns information about a snapshot. + /// Get snapshot information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -702,7 +766,7 @@ public virtual Task GetAsync(GetSnapshotRequest request, Ca /// /// - /// Returns information about a snapshot. + /// Get snapshot information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -715,7 +779,7 @@ public virtual GetSnapshotResponse Get(GetSnapshotRequestDescriptor descriptor) /// /// - /// Returns information about a snapshot. + /// Get snapshot information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -729,7 +793,7 @@ public virtual GetSnapshotResponse Get(Elastic.Clients.Elasticsearch.Name reposi /// /// - /// Returns information about a snapshot. + /// Get snapshot information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -744,7 +808,7 @@ public virtual GetSnapshotResponse Get(Elastic.Clients.Elasticsearch.Name reposi /// /// - /// Returns information about a snapshot. + /// Get snapshot information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -756,7 +820,7 @@ public virtual Task GetAsync(GetSnapshotRequestDescriptor d /// /// - /// Returns information about a snapshot. + /// Get snapshot information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -769,7 +833,7 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch. /// /// - /// Returns information about a snapshot. + /// Get snapshot information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -783,7 +847,7 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch. /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -796,7 +860,7 @@ public virtual GetRepositoryResponse GetRepository(GetRepositoryRequest request) /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -808,7 +872,7 @@ public virtual Task GetRepositoryAsync(GetRepositoryReque /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -821,7 +885,7 @@ public virtual GetRepositoryResponse GetRepository(GetRepositoryRequestDescripto /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -835,7 +899,7 @@ public virtual GetRepositoryResponse GetRepository(Elastic.Clients.Elasticsearch /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -850,7 +914,7 @@ public virtual GetRepositoryResponse GetRepository(Elastic.Clients.Elasticsearch /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -864,7 +928,7 @@ public virtual GetRepositoryResponse GetRepository() /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -879,7 +943,7 @@ public virtual GetRepositoryResponse GetRepository(Action /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -891,7 +955,7 @@ public virtual Task GetRepositoryAsync(GetRepositoryReque /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -904,7 +968,7 @@ public virtual Task GetRepositoryAsync(Elastic.Clients.El /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -918,7 +982,7 @@ public virtual Task GetRepositoryAsync(Elastic.Clients.El /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -931,7 +995,7 @@ public virtual Task GetRepositoryAsync(CancellationToken /// /// - /// Returns information about a repository. + /// Get snapshot repository information. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -945,7 +1009,574 @@ public virtual Task GetRepositoryAsync(Action /// - /// Restores a snapshot. + /// Verify the repository integrity. + /// Verify the integrity of the contents of a snapshot repository. + /// + /// + /// This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. + /// + /// + /// If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its read_only option to true, and use this API to verify its integrity. + /// Until you do so: + /// + /// + /// + /// + /// It may not be possible to restore some snapshots from this repository. + /// + /// + /// + /// + /// Searchable snapshots may report errors when searched or may have unassigned shards. + /// + /// + /// + /// + /// Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. + /// + /// + /// + /// + /// Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. + /// + /// + /// + /// + /// Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. + /// + /// + /// + /// + /// If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. + /// The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. + /// You must also identify what caused the damage and take action to prevent it from happening again. + /// + /// + /// If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. + /// In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. + /// + /// + /// Avoid all operations which write to the repository while the verify repository integrity API is running. + /// If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. + /// It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. + /// + /// + /// NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. + /// + /// + /// NOTE: This API may not work correctly in a mixed-version cluster. + /// + /// 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); + } + + /// + /// + /// Verify the repository integrity. + /// Verify the integrity of the contents of a snapshot repository. + /// + /// + /// This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. + /// + /// + /// If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its read_only option to true, and use this API to verify its integrity. + /// Until you do so: + /// + /// + /// + /// + /// It may not be possible to restore some snapshots from this repository. + /// + /// + /// + /// + /// Searchable snapshots may report errors when searched or may have unassigned shards. + /// + /// + /// + /// + /// Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. + /// + /// + /// + /// + /// Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. + /// + /// + /// + /// + /// Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. + /// + /// + /// + /// + /// If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. + /// The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. + /// You must also identify what caused the damage and take action to prevent it from happening again. + /// + /// + /// If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. + /// In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. + /// + /// + /// Avoid all operations which write to the repository while the verify repository integrity API is running. + /// If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. + /// It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. + /// + /// + /// NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. + /// + /// + /// NOTE: This API may not work correctly in a mixed-version cluster. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task RepositoryVerifyIntegrityAsync(RepositoryVerifyIntegrityRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Verify the repository integrity. + /// Verify the integrity of the contents of a snapshot repository. + /// + /// + /// This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. + /// + /// + /// If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its read_only option to true, and use this API to verify its integrity. + /// Until you do so: + /// + /// + /// + /// + /// It may not be possible to restore some snapshots from this repository. + /// + /// + /// + /// + /// Searchable snapshots may report errors when searched or may have unassigned shards. + /// + /// + /// + /// + /// Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. + /// + /// + /// + /// + /// Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. + /// + /// + /// + /// + /// Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. + /// + /// + /// + /// + /// If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. + /// The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. + /// You must also identify what caused the damage and take action to prevent it from happening again. + /// + /// + /// If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. + /// In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. + /// + /// + /// Avoid all operations which write to the repository while the verify repository integrity API is running. + /// If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. + /// It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. + /// + /// + /// NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. + /// + /// + /// NOTE: This API may not work correctly in a mixed-version cluster. + /// + /// 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); + } + + /// + /// + /// Verify the repository integrity. + /// Verify the integrity of the contents of a snapshot repository. + /// + /// + /// This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. + /// + /// + /// If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its read_only option to true, and use this API to verify its integrity. + /// Until you do so: + /// + /// + /// + /// + /// It may not be possible to restore some snapshots from this repository. + /// + /// + /// + /// + /// Searchable snapshots may report errors when searched or may have unassigned shards. + /// + /// + /// + /// + /// Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. + /// + /// + /// + /// + /// Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. + /// + /// + /// + /// + /// Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. + /// + /// + /// + /// + /// If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. + /// The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. + /// You must also identify what caused the damage and take action to prevent it from happening again. + /// + /// + /// If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. + /// In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. + /// + /// + /// Avoid all operations which write to the repository while the verify repository integrity API is running. + /// If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. + /// It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. + /// + /// + /// NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. + /// + /// + /// NOTE: This API may not work correctly in a mixed-version cluster. + /// + /// 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); + } + + /// + /// + /// Verify the repository integrity. + /// Verify the integrity of the contents of a snapshot repository. + /// + /// + /// This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. + /// + /// + /// If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its read_only option to true, and use this API to verify its integrity. + /// Until you do so: + /// + /// + /// + /// + /// It may not be possible to restore some snapshots from this repository. + /// + /// + /// + /// + /// Searchable snapshots may report errors when searched or may have unassigned shards. + /// + /// + /// + /// + /// Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. + /// + /// + /// + /// + /// Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. + /// + /// + /// + /// + /// Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. + /// + /// + /// + /// + /// If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. + /// The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. + /// You must also identify what caused the damage and take action to prevent it from happening again. + /// + /// + /// If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. + /// In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. + /// + /// + /// Avoid all operations which write to the repository while the verify repository integrity API is running. + /// If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. + /// It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. + /// + /// + /// NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. + /// + /// + /// NOTE: This API may not work correctly in a mixed-version cluster. + /// + /// 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); + } + + /// + /// + /// Verify the repository integrity. + /// Verify the integrity of the contents of a snapshot repository. + /// + /// + /// This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. + /// + /// + /// If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its read_only option to true, and use this API to verify its integrity. + /// Until you do so: + /// + /// + /// + /// + /// It may not be possible to restore some snapshots from this repository. + /// + /// + /// + /// + /// Searchable snapshots may report errors when searched or may have unassigned shards. + /// + /// + /// + /// + /// Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. + /// + /// + /// + /// + /// Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. + /// + /// + /// + /// + /// Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. + /// + /// + /// + /// + /// If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. + /// The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. + /// You must also identify what caused the damage and take action to prevent it from happening again. + /// + /// + /// If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. + /// In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. + /// + /// + /// Avoid all operations which write to the repository while the verify repository integrity API is running. + /// If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. + /// It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. + /// + /// + /// NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. + /// + /// + /// NOTE: This API may not work correctly in a mixed-version cluster. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task RepositoryVerifyIntegrityAsync(RepositoryVerifyIntegrityRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Verify the repository integrity. + /// Verify the integrity of the contents of a snapshot repository. + /// + /// + /// This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. + /// + /// + /// If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its read_only option to true, and use this API to verify its integrity. + /// Until you do so: + /// + /// + /// + /// + /// It may not be possible to restore some snapshots from this repository. + /// + /// + /// + /// + /// Searchable snapshots may report errors when searched or may have unassigned shards. + /// + /// + /// + /// + /// Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. + /// + /// + /// + /// + /// Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. + /// + /// + /// + /// + /// Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. + /// + /// + /// + /// + /// If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. + /// The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. + /// You must also identify what caused the damage and take action to prevent it from happening again. + /// + /// + /// If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. + /// In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. + /// + /// + /// Avoid all operations which write to the repository while the verify repository integrity API is running. + /// If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. + /// It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. + /// + /// + /// NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. + /// + /// + /// NOTE: This API may not work correctly in a mixed-version cluster. + /// + /// 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); + } + + /// + /// + /// Verify the repository integrity. + /// Verify the integrity of the contents of a snapshot repository. + /// + /// + /// This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. + /// + /// + /// If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its read_only option to true, and use this API to verify its integrity. + /// Until you do so: + /// + /// + /// + /// + /// It may not be possible to restore some snapshots from this repository. + /// + /// + /// + /// + /// Searchable snapshots may report errors when searched or may have unassigned shards. + /// + /// + /// + /// + /// Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. + /// + /// + /// + /// + /// Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. + /// + /// + /// + /// + /// Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. + /// + /// + /// + /// + /// If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. + /// The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. + /// You must also identify what caused the damage and take action to prevent it from happening again. + /// + /// + /// If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. + /// In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. + /// + /// + /// Avoid all operations which write to the repository while the verify repository integrity API is running. + /// If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. + /// It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. + /// + /// + /// NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. + /// + /// + /// NOTE: This API may not work correctly in a mixed-version cluster. + /// + /// 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); + } + + /// + /// + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -958,7 +1589,28 @@ public virtual RestoreResponse Restore(RestoreRequest request) /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -970,7 +1622,28 @@ public virtual Task RestoreAsync(RestoreRequest request, Cancel /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -983,7 +1656,28 @@ public virtual RestoreResponse Restore(RestoreRequestDescriptor /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -997,7 +1691,28 @@ public virtual RestoreResponse Restore(Elastic.Clients.Elasticsearch. /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1012,7 +1727,28 @@ public virtual RestoreResponse Restore(Elastic.Clients.Elasticsearch. /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1025,7 +1761,28 @@ public virtual RestoreResponse Restore(RestoreRequestDescriptor descriptor) /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1039,7 +1796,28 @@ public virtual RestoreResponse Restore(Elastic.Clients.Elasticsearch.Name reposi /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1054,7 +1832,28 @@ public virtual RestoreResponse Restore(Elastic.Clients.Elasticsearch.Name reposi /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1066,7 +1865,28 @@ public virtual Task RestoreAsync(RestoreRequestDescr /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1079,7 +1899,28 @@ public virtual Task RestoreAsync(Elastic.Clients.Ela /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1093,7 +1934,28 @@ public virtual Task RestoreAsync(Elastic.Clients.Ela /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1105,7 +1967,28 @@ public virtual Task RestoreAsync(RestoreRequestDescriptor descr /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1118,7 +2001,28 @@ public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch. /// /// - /// Restores a snapshot. + /// Restore a snapshot. + /// Restore a snapshot of a cluster or data streams and indices. + /// + /// + /// You can restore a snapshot only to a running cluster with an elected master node. + /// The snapshot repository must be registered and available to the cluster. + /// The snapshot and cluster versions must be compatible. + /// + /// + /// To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + /// + /// + /// Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + /// + /// + /// GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + /// + /// + /// If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + /// + /// + /// If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1132,7 +2036,19 @@ public virtual Task RestoreAsync(Elastic.Clients.Elasticsearch. /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1145,7 +2061,19 @@ public virtual SnapshotStatusResponse Status(SnapshotStatusRequest request) /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1157,7 +2085,19 @@ public virtual Task StatusAsync(SnapshotStatusRequest re /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1170,7 +2110,19 @@ public virtual SnapshotStatusResponse Status(SnapshotStatusRequestDescriptor des /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1184,7 +2136,19 @@ public virtual SnapshotStatusResponse Status(Elastic.Clients.Elasticsearch.Name? /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1199,7 +2163,19 @@ public virtual SnapshotStatusResponse Status(Elastic.Clients.Elasticsearch.Name? /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1213,7 +2189,19 @@ public virtual SnapshotStatusResponse Status() /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1228,7 +2216,19 @@ public virtual SnapshotStatusResponse Status(Action /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1240,7 +2240,19 @@ public virtual Task StatusAsync(SnapshotStatusRequestDes /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1253,7 +2265,19 @@ public virtual Task StatusAsync(Elastic.Clients.Elastics /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1267,7 +2291,19 @@ public virtual Task StatusAsync(Elastic.Clients.Elastics /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1280,7 +2316,19 @@ public virtual Task StatusAsync(CancellationToken cancel /// /// - /// Returns information about the status of a snapshot. + /// Get the snapshot status. + /// Get a detailed description of the current state for each shard participating in the snapshot. + /// Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + /// If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + /// + /// + /// WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + /// The API requires a read from the repository for each shard in each snapshot. + /// For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + /// + /// + /// Depending on the latency of your storage, such requests can take an extremely long time to return results. + /// These requests can also tax machine resources and, when using cloud storage, incur high processing costs. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1294,7 +2342,8 @@ public virtual Task StatusAsync(Action /// - /// Verifies a repository. + /// Verify a snapshot repository. + /// Check for common misconfigurations in a snapshot repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1307,7 +2356,8 @@ public virtual VerifyRepositoryResponse VerifyRepository(VerifyRepositoryRequest /// /// - /// Verifies a repository. + /// Verify a snapshot repository. + /// Check for common misconfigurations in a snapshot repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1319,7 +2369,8 @@ public virtual Task VerifyRepositoryAsync(VerifyReposi /// /// - /// Verifies a repository. + /// Verify a snapshot repository. + /// Check for common misconfigurations in a snapshot repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1332,7 +2383,8 @@ public virtual VerifyRepositoryResponse VerifyRepository(VerifyRepositoryRequest /// /// - /// Verifies a repository. + /// Verify a snapshot repository. + /// Check for common misconfigurations in a snapshot repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1346,7 +2398,8 @@ public virtual VerifyRepositoryResponse VerifyRepository(Elastic.Clients.Elastic /// /// - /// Verifies a repository. + /// Verify a snapshot repository. + /// Check for common misconfigurations in a snapshot repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1361,7 +2414,8 @@ public virtual VerifyRepositoryResponse VerifyRepository(Elastic.Clients.Elastic /// /// - /// Verifies a repository. + /// Verify a snapshot repository. + /// Check for common misconfigurations in a snapshot repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1373,7 +2427,8 @@ public virtual Task VerifyRepositoryAsync(VerifyReposi /// /// - /// Verifies a repository. + /// Verify a snapshot repository. + /// Check for common misconfigurations in a snapshot repository. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1386,7 +2441,8 @@ public virtual Task VerifyRepositoryAsync(Elastic.Clie /// /// - /// Verifies a repository. + /// Verify a snapshot repository. + /// Check for common misconfigurations in a snapshot repository. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Sql.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Sql.g.cs index 8f663c7b8b0..11a328ffb04 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Sql.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Sql.g.cs @@ -41,7 +41,7 @@ internal SqlNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Clears the SQL cursor + /// Clear an SQL search cursor. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +54,7 @@ public virtual ClearCursorResponse ClearCursor(ClearCursorRequest request) /// /// - /// Clears the SQL cursor + /// Clear an SQL search cursor. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +66,7 @@ public virtual Task ClearCursorAsync(ClearCursorRequest req /// /// - /// Clears the SQL cursor + /// Clear an SQL search cursor. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +79,7 @@ public virtual ClearCursorResponse ClearCursor(ClearCursorRequestDescriptor desc /// /// - /// Clears the SQL cursor + /// Clear an SQL search cursor. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +93,7 @@ public virtual ClearCursorResponse ClearCursor() /// /// - /// Clears the SQL cursor + /// Clear an SQL search cursor. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +108,7 @@ public virtual ClearCursorResponse ClearCursor(Action /// - /// Clears the SQL cursor + /// Clear an SQL search cursor. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -120,7 +120,7 @@ public virtual Task ClearCursorAsync(ClearCursorRequestDesc /// /// - /// Clears the SQL cursor + /// Clear an SQL search cursor. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -133,7 +133,7 @@ public virtual Task ClearCursorAsync(CancellationToken canc /// /// - /// Clears the SQL cursor + /// Clear an SQL search cursor. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -147,7 +147,9 @@ public virtual Task ClearCursorAsync(Action /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -160,7 +162,9 @@ public virtual DeleteAsyncResponse DeleteAsync(DeleteAsyncRequest request) /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -172,7 +176,9 @@ public virtual Task DeleteAsyncAsync(DeleteAsyncRequest req /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -185,7 +191,9 @@ public virtual DeleteAsyncResponse DeleteAsync(DeleteAsyncRequestDesc /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -199,7 +207,9 @@ public virtual DeleteAsyncResponse DeleteAsync(Elastic.Clients.Elasti /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -214,7 +224,9 @@ public virtual DeleteAsyncResponse DeleteAsync(Elastic.Clients.Elasti /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -227,7 +239,9 @@ public virtual DeleteAsyncResponse DeleteAsync(DeleteAsyncRequestDescriptor desc /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -241,7 +255,9 @@ public virtual DeleteAsyncResponse DeleteAsync(Elastic.Clients.Elasticsearch.Id /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -256,7 +272,9 @@ public virtual DeleteAsyncResponse DeleteAsync(Elastic.Clients.Elasticsearch.Id /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -268,7 +286,9 @@ public virtual Task DeleteAsyncAsync(DeleteAsync /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -281,7 +301,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Cli /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -295,7 +317,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Cli /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -307,7 +331,9 @@ public virtual Task DeleteAsyncAsync(DeleteAsyncRequestDesc /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -320,7 +346,9 @@ public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasti /// /// - /// Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + /// Delete an async SQL search. + /// Delete an async SQL search or a stored synchronous SQL search. + /// If the search is still running, the API cancels it. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -334,7 +362,8 @@ public virtual Task DeleteAsyncAsync(Elastic.Clients.Elasti /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -347,7 +376,8 @@ public virtual GetAsyncResponse GetAsync(GetAsyncRequest request) /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -359,7 +389,8 @@ public virtual Task GetAsyncAsync(GetAsyncRequest request, Can /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -372,7 +403,8 @@ public virtual GetAsyncResponse GetAsync(GetAsyncRequestDescriptor /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -386,7 +418,8 @@ public virtual GetAsyncResponse GetAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -401,7 +434,8 @@ public virtual GetAsyncResponse GetAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -414,7 +448,8 @@ public virtual GetAsyncResponse GetAsync(GetAsyncRequestDescriptor descriptor) /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -428,7 +463,8 @@ public virtual GetAsyncResponse GetAsync(Elastic.Clients.Elasticsearch.Id id) /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -443,7 +479,8 @@ public virtual GetAsyncResponse GetAsync(Elastic.Clients.Elasticsearch.Id id, Ac /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -455,7 +492,8 @@ public virtual Task GetAsyncAsync(GetAsyncRequestDe /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -468,7 +506,8 @@ public virtual Task GetAsyncAsync(Elastic.Clients.E /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -482,7 +521,8 @@ public virtual Task GetAsyncAsync(Elastic.Clients.E /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -494,7 +534,8 @@ public virtual Task GetAsyncAsync(GetAsyncRequestDescriptor de /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -507,7 +548,8 @@ public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns the current status and available results for an async SQL search or stored synchronous SQL search + /// Get async SQL search results. + /// Get the current status and available results for an async SQL search or stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -521,7 +563,8 @@ public virtual Task GetAsyncAsync(Elastic.Clients.Elasticsearc /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -534,7 +577,8 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(GetAsyncStatusRequest reque /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -546,7 +590,8 @@ public virtual Task GetAsyncStatusAsync(GetAsyncStatusRe /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -559,7 +604,8 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(GetAsyncStatusRe /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -573,7 +619,8 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(Elastic.Clients. /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -588,7 +635,8 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(Elastic.Clients. /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -601,7 +649,8 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(GetAsyncStatusRequestDescri /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -615,7 +664,8 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(Elastic.Clients.Elasticsear /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -630,7 +680,8 @@ public virtual GetAsyncStatusResponse GetAsyncStatus(Elastic.Clients.Elasticsear /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -642,7 +693,8 @@ public virtual Task GetAsyncStatusAsync(GetAs /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -655,7 +707,8 @@ public virtual Task GetAsyncStatusAsync(Elast /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -669,7 +722,8 @@ public virtual Task GetAsyncStatusAsync(Elast /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -681,7 +735,8 @@ public virtual Task GetAsyncStatusAsync(GetAsyncStatusRe /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -694,7 +749,8 @@ public virtual Task GetAsyncStatusAsync(Elastic.Clients. /// /// - /// Returns the current status of an async SQL search or a stored synchronous SQL search + /// Get the async SQL search status. + /// Get the current status of an async SQL search or a stored synchronous SQL search. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -708,7 +764,8 @@ public virtual Task GetAsyncStatusAsync(Elastic.Clients. /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -721,7 +778,8 @@ public virtual QueryResponse Query(QueryRequest request) /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -733,7 +791,8 @@ public virtual Task QueryAsync(QueryRequest request, Cancellation /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -746,7 +805,8 @@ public virtual QueryResponse Query(QueryRequestDescriptor /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -760,7 +820,8 @@ public virtual QueryResponse Query() /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -775,7 +836,8 @@ public virtual QueryResponse Query(Action /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -788,7 +850,8 @@ public virtual QueryResponse Query(QueryRequestDescriptor descriptor) /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -802,7 +865,8 @@ public virtual QueryResponse Query() /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -817,7 +881,8 @@ public virtual QueryResponse Query(Action configureReque /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -829,7 +894,8 @@ public virtual Task QueryAsync(QueryRequestDescriptor< /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -842,7 +908,8 @@ public virtual Task QueryAsync(CancellationToken cance /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -856,7 +923,8 @@ public virtual Task QueryAsync(Action /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -868,7 +936,8 @@ public virtual Task QueryAsync(QueryRequestDescriptor descriptor, /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -881,7 +950,8 @@ public virtual Task QueryAsync(CancellationToken cancellationToke /// /// - /// Executes a SQL request + /// Get SQL search results. + /// Run an SQL request. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -895,7 +965,8 @@ public virtual Task QueryAsync(Action con /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -908,7 +979,8 @@ public virtual TranslateResponse Translate(TranslateRequest request) /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -920,7 +992,8 @@ public virtual Task TranslateAsync(TranslateRequest request, /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -933,7 +1006,8 @@ public virtual TranslateResponse Translate(TranslateRequestDescriptor /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -947,7 +1021,8 @@ public virtual TranslateResponse Translate() /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -962,7 +1037,8 @@ public virtual TranslateResponse Translate(Action /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -975,7 +1051,8 @@ public virtual TranslateResponse Translate(TranslateRequestDescriptor descriptor /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -989,7 +1066,8 @@ public virtual TranslateResponse Translate() /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1004,7 +1082,8 @@ public virtual TranslateResponse Translate(Action co /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1016,7 +1095,8 @@ public virtual Task TranslateAsync(TranslateReques /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1029,7 +1109,8 @@ public virtual Task TranslateAsync(CancellationTok /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1043,7 +1124,8 @@ public virtual Task TranslateAsync(Action /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1055,7 +1137,8 @@ public virtual Task TranslateAsync(TranslateRequestDescriptor /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1068,7 +1151,8 @@ public virtual Task TranslateAsync(CancellationToken cancella /// /// - /// Translates SQL into Elasticsearch queries + /// Translate SQL into Elasticsearch queries. + /// Translate an SQL search into a search API request containing Query DSL. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Synonyms.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Synonyms.g.cs index ffd5944ce64..8f7ca764fe7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Synonyms.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Synonyms.g.cs @@ -41,7 +41,7 @@ internal SynonymsNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +54,7 @@ public virtual DeleteSynonymResponse DeleteSynonym(DeleteSynonymRequest request) /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +66,7 @@ public virtual Task DeleteSynonymAsync(DeleteSynonymReque /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +79,7 @@ public virtual DeleteSynonymResponse DeleteSynonym(DeleteSynonymReque /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +93,7 @@ public virtual DeleteSynonymResponse DeleteSynonym(Elastic.Clients.El /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +108,7 @@ public virtual DeleteSynonymResponse DeleteSynonym(Elastic.Clients.El /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -121,7 +121,7 @@ public virtual DeleteSynonymResponse DeleteSynonym(DeleteSynonymRequestDescripto /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -135,7 +135,7 @@ public virtual DeleteSynonymResponse DeleteSynonym(Elastic.Clients.Elasticsearch /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -150,7 +150,7 @@ public virtual DeleteSynonymResponse DeleteSynonym(Elastic.Clients.Elasticsearch /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -162,7 +162,7 @@ public virtual Task DeleteSynonymAsync(DeleteS /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -175,7 +175,7 @@ public virtual Task DeleteSynonymAsync(Elastic /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -189,7 +189,7 @@ public virtual Task DeleteSynonymAsync(Elastic /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -201,7 +201,7 @@ public virtual Task DeleteSynonymAsync(DeleteSynonymReque /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -214,7 +214,7 @@ public virtual Task DeleteSynonymAsync(Elastic.Clients.El /// /// - /// Deletes a synonym set + /// Delete a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -228,7 +228,8 @@ public virtual Task DeleteSynonymAsync(Elastic.Clients.El /// /// - /// Deletes a synonym rule in a synonym set + /// Delete a synonym rule. + /// Delete a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -241,7 +242,8 @@ public virtual DeleteSynonymRuleResponse DeleteSynonymRule(DeleteSynonymRuleRequ /// /// - /// Deletes a synonym rule in a synonym set + /// Delete a synonym rule. + /// Delete a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -253,7 +255,8 @@ public virtual Task DeleteSynonymRuleAsync(DeleteSyno /// /// - /// Deletes a synonym rule in a synonym set + /// Delete a synonym rule. + /// Delete a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -266,7 +269,8 @@ public virtual DeleteSynonymRuleResponse DeleteSynonymRule(DeleteSynonymRuleRequ /// /// - /// Deletes a synonym rule in a synonym set + /// Delete a synonym rule. + /// Delete a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -280,7 +284,8 @@ public virtual DeleteSynonymRuleResponse DeleteSynonymRule(Elastic.Clients.Elast /// /// - /// Deletes a synonym rule in a synonym set + /// Delete a synonym rule. + /// Delete a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -295,7 +300,8 @@ public virtual DeleteSynonymRuleResponse DeleteSynonymRule(Elastic.Clients.Elast /// /// - /// Deletes a synonym rule in a synonym set + /// Delete a synonym rule. + /// Delete a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -307,7 +313,8 @@ public virtual Task DeleteSynonymRuleAsync(DeleteSyno /// /// - /// Deletes a synonym rule in a synonym set + /// Delete a synonym rule. + /// Delete a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -320,7 +327,8 @@ public virtual Task DeleteSynonymRuleAsync(Elastic.Cl /// /// - /// Deletes a synonym rule in a synonym set + /// Delete a synonym rule. + /// Delete a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -334,7 +342,7 @@ public virtual Task DeleteSynonymRuleAsync(Elastic.Cl /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -347,7 +355,7 @@ public virtual GetSynonymResponse GetSynonym(GetSynonymRequest request) /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -359,7 +367,7 @@ public virtual Task GetSynonymAsync(GetSynonymRequest reques /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -372,7 +380,7 @@ public virtual GetSynonymResponse GetSynonym(GetSynonymRequestDescrip /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -386,7 +394,7 @@ public virtual GetSynonymResponse GetSynonym(Elastic.Clients.Elastics /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -401,7 +409,7 @@ public virtual GetSynonymResponse GetSynonym(Elastic.Clients.Elastics /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -414,7 +422,7 @@ public virtual GetSynonymResponse GetSynonym(GetSynonymRequestDescriptor descrip /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -428,7 +436,7 @@ public virtual GetSynonymResponse GetSynonym(Elastic.Clients.Elasticsearch.Id id /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -443,7 +451,7 @@ public virtual GetSynonymResponse GetSynonym(Elastic.Clients.Elasticsearch.Id id /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -455,7 +463,7 @@ public virtual Task GetSynonymAsync(GetSynonymReq /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -468,7 +476,7 @@ public virtual Task GetSynonymAsync(Elastic.Clien /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -482,7 +490,7 @@ public virtual Task GetSynonymAsync(Elastic.Clien /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -494,7 +502,7 @@ public virtual Task GetSynonymAsync(GetSynonymRequestDescrip /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -507,7 +515,7 @@ public virtual Task GetSynonymAsync(Elastic.Clients.Elastics /// /// - /// Retrieves a synonym set + /// Get a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -521,7 +529,8 @@ public virtual Task GetSynonymAsync(Elastic.Clients.Elastics /// /// - /// Retrieves a synonym rule from a synonym set + /// Get a synonym rule. + /// Get a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -534,7 +543,8 @@ public virtual GetSynonymRuleResponse GetSynonymRule(GetSynonymRuleRequest reque /// /// - /// Retrieves a synonym rule from a synonym set + /// Get a synonym rule. + /// Get a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -546,7 +556,8 @@ public virtual Task GetSynonymRuleAsync(GetSynonymRuleRe /// /// - /// Retrieves a synonym rule from a synonym set + /// Get a synonym rule. + /// Get a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -559,7 +570,8 @@ public virtual GetSynonymRuleResponse GetSynonymRule(GetSynonymRuleRequestDescri /// /// - /// Retrieves a synonym rule from a synonym set + /// Get a synonym rule. + /// Get a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -573,7 +585,8 @@ public virtual GetSynonymRuleResponse GetSynonymRule(Elastic.Clients.Elasticsear /// /// - /// Retrieves a synonym rule from a synonym set + /// Get a synonym rule. + /// Get a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -588,7 +601,8 @@ public virtual GetSynonymRuleResponse GetSynonymRule(Elastic.Clients.Elasticsear /// /// - /// Retrieves a synonym rule from a synonym set + /// Get a synonym rule. + /// Get a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -600,7 +614,8 @@ public virtual Task GetSynonymRuleAsync(GetSynonymRuleRe /// /// - /// Retrieves a synonym rule from a synonym set + /// Get a synonym rule. + /// Get a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -613,7 +628,8 @@ public virtual Task GetSynonymRuleAsync(Elastic.Clients. /// /// - /// Retrieves a synonym rule from a synonym set + /// Get a synonym rule. + /// Get a synonym rule from a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -627,7 +643,8 @@ public virtual Task GetSynonymRuleAsync(Elastic.Clients. /// /// - /// Retrieves a summary of all defined synonym sets + /// Get all synonym sets. + /// Get a summary of all defined synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -640,7 +657,8 @@ public virtual GetSynonymsSetsResponse GetSynonymsSets(GetSynonymsSetsRequest re /// /// - /// Retrieves a summary of all defined synonym sets + /// Get all synonym sets. + /// Get a summary of all defined synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -652,7 +670,8 @@ public virtual Task GetSynonymsSetsAsync(GetSynonymsSet /// /// - /// Retrieves a summary of all defined synonym sets + /// Get all synonym sets. + /// Get a summary of all defined synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -665,7 +684,8 @@ public virtual GetSynonymsSetsResponse GetSynonymsSets(GetSynonymsSetsRequestDes /// /// - /// Retrieves a summary of all defined synonym sets + /// Get all synonym sets. + /// Get a summary of all defined synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -679,7 +699,8 @@ public virtual GetSynonymsSetsResponse GetSynonymsSets() /// /// - /// Retrieves a summary of all defined synonym sets + /// Get all synonym sets. + /// Get a summary of all defined synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -694,7 +715,8 @@ public virtual GetSynonymsSetsResponse GetSynonymsSets(Action /// - /// Retrieves a summary of all defined synonym sets + /// Get all synonym sets. + /// Get a summary of all defined synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -706,7 +728,8 @@ public virtual Task GetSynonymsSetsAsync(GetSynonymsSet /// /// - /// Retrieves a summary of all defined synonym sets + /// Get all synonym sets. + /// Get a summary of all defined synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -719,7 +742,8 @@ public virtual Task GetSynonymsSetsAsync(CancellationTo /// /// - /// Retrieves a summary of all defined synonym sets + /// Get all synonym sets. + /// Get a summary of all defined synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -733,7 +757,9 @@ public virtual Task GetSynonymsSetsAsync(Action /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -746,7 +772,9 @@ public virtual PutSynonymResponse PutSynonym(PutSynonymRequest request) /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -758,7 +786,9 @@ public virtual Task PutSynonymAsync(PutSynonymRequest reques /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -771,7 +801,9 @@ public virtual PutSynonymResponse PutSynonym(PutSynonymRequestDescrip /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -785,7 +817,9 @@ public virtual PutSynonymResponse PutSynonym(Elastic.Clients.Elastics /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -800,7 +834,9 @@ public virtual PutSynonymResponse PutSynonym(Elastic.Clients.Elastics /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -813,7 +849,9 @@ public virtual PutSynonymResponse PutSynonym(PutSynonymRequestDescriptor descrip /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -827,7 +865,9 @@ public virtual PutSynonymResponse PutSynonym(Elastic.Clients.Elasticsearch.Id id /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -842,7 +882,9 @@ public virtual PutSynonymResponse PutSynonym(Elastic.Clients.Elasticsearch.Id id /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -854,7 +896,9 @@ public virtual Task PutSynonymAsync(PutSynonymReq /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -867,7 +911,9 @@ public virtual Task PutSynonymAsync(Elastic.Clien /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -881,7 +927,9 @@ public virtual Task PutSynonymAsync(Elastic.Clien /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -893,7 +941,9 @@ public virtual Task PutSynonymAsync(PutSynonymRequestDescrip /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -906,7 +956,9 @@ public virtual Task PutSynonymAsync(Elastic.Clients.Elastics /// /// - /// Creates or updates a synonym set. + /// Create or update a synonym set. + /// Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + /// If you need to manage more synonym rules, you can create multiple synonym sets. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -920,7 +972,8 @@ public virtual Task PutSynonymAsync(Elastic.Clients.Elastics /// /// - /// Creates or updates a synonym rule in a synonym set + /// Create or update a synonym rule. + /// Create or update a synonym rule in a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -933,7 +986,8 @@ public virtual PutSynonymRuleResponse PutSynonymRule(PutSynonymRuleRequest reque /// /// - /// Creates or updates a synonym rule in a synonym set + /// Create or update a synonym rule. + /// Create or update a synonym rule in a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -945,7 +999,8 @@ public virtual Task PutSynonymRuleAsync(PutSynonymRuleRe /// /// - /// Creates or updates a synonym rule in a synonym set + /// Create or update a synonym rule. + /// Create or update a synonym rule in a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -958,7 +1013,8 @@ public virtual PutSynonymRuleResponse PutSynonymRule(PutSynonymRuleRequestDescri /// /// - /// Creates or updates a synonym rule in a synonym set + /// Create or update a synonym rule. + /// Create or update a synonym rule in a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -972,7 +1028,8 @@ public virtual PutSynonymRuleResponse PutSynonymRule(Elastic.Clients.Elasticsear /// /// - /// Creates or updates a synonym rule in a synonym set + /// Create or update a synonym rule. + /// Create or update a synonym rule in a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -987,7 +1044,8 @@ public virtual PutSynonymRuleResponse PutSynonymRule(Elastic.Clients.Elasticsear /// /// - /// Creates or updates a synonym rule in a synonym set + /// Create or update a synonym rule. + /// Create or update a synonym rule in a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -999,7 +1057,8 @@ public virtual Task PutSynonymRuleAsync(PutSynonymRuleRe /// /// - /// Creates or updates a synonym rule in a synonym set + /// Create or update a synonym rule. + /// Create or update a synonym rule in a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1012,7 +1071,8 @@ public virtual Task PutSynonymRuleAsync(Elastic.Clients. /// /// - /// Creates or updates a synonym rule in a synonym set + /// Create or update a synonym rule. + /// Create or update a synonym rule in a synonym set. /// /// Learn more about this API in the Elasticsearch documentation. /// 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 254c5209727..4ed8ca03514 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Tasks.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Tasks.g.cs @@ -41,9 +41,17 @@ internal TasksNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Cancels a task, if it can be cancelled through an API. + /// Cancel a task. + /// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + /// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + /// The get task information API will continue to list these cancelled tasks until they complete. + /// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. + /// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. + /// + /// 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) @@ -54,9 +62,17 @@ public virtual CancelResponse Cancel(CancelRequest request) /// /// - /// Cancels a task, if it can be cancelled through an API. + /// Cancel a task. + /// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + /// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + /// The get task information API will continue to list these cancelled tasks until they complete. + /// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. + /// + /// + /// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. + /// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. /// - /// 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) { @@ -66,9 +82,17 @@ public virtual Task CancelAsync(CancelRequest request, Cancellat /// /// - /// Cancels a task, if it can be cancelled through an API. + /// Cancel a task. + /// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + /// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + /// The get task information API will continue to list these cancelled tasks until they complete. + /// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. + /// + /// + /// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. + /// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. /// - /// Learn more about this API in the Elasticsearch 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) @@ -79,9 +103,17 @@ public virtual CancelResponse Cancel(CancelRequestDescriptor descriptor) /// /// - /// Cancels a task, if it can be cancelled through an API. + /// Cancel a task. + /// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + /// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + /// The get task information API will continue to list these cancelled tasks until they complete. + /// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. + /// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. + /// + /// 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) @@ -93,9 +125,17 @@ public virtual CancelResponse Cancel(Elastic.Clients.Elasticsearch.TaskId? taskI /// /// - /// Cancels a task, if it can be cancelled through an API. + /// Cancel a task. + /// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + /// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + /// The get task information API will continue to list these cancelled tasks until they complete. + /// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. + /// + /// + /// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. + /// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. /// - /// Learn more about this API in the Elasticsearch 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) @@ -108,9 +148,17 @@ public virtual CancelResponse Cancel(Elastic.Clients.Elasticsearch.TaskId? taskI /// /// - /// Cancels a task, if it can be cancelled through an API. + /// Cancel a task. + /// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + /// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + /// The get task information API will continue to list these cancelled tasks until they complete. + /// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. + /// + /// + /// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. + /// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. /// - /// Learn more about this API in the Elasticsearch 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() @@ -122,9 +170,17 @@ public virtual CancelResponse Cancel() /// /// - /// Cancels a task, if it can be cancelled through an API. + /// Cancel a task. + /// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + /// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + /// The get task information API will continue to list these cancelled tasks until they complete. + /// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. + /// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. + /// + /// 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) @@ -137,9 +193,17 @@ public virtual CancelResponse Cancel(Action configureRe /// /// - /// Cancels a task, if it can be cancelled through an API. + /// Cancel a task. + /// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + /// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + /// The get task information API will continue to list these cancelled tasks until they complete. + /// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. + /// + /// + /// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. + /// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. /// - /// 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) { @@ -149,9 +213,17 @@ public virtual Task CancelAsync(CancelRequestDescriptor descript /// /// - /// Cancels a task, if it can be cancelled through an API. + /// Cancel a task. + /// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + /// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + /// The get task information API will continue to list these cancelled tasks until they complete. + /// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. + /// + /// + /// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. + /// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. /// - /// 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) { @@ -162,9 +234,17 @@ public virtual Task CancelAsync(Elastic.Clients.Elasticsearch.Ta /// /// - /// Cancels a task, if it can be cancelled through an API. + /// Cancel a task. + /// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + /// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + /// The get task information API will continue to list these cancelled tasks until they complete. + /// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. /// - /// Learn more about this API in the Elasticsearch documentation. + /// + /// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. + /// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. + /// + /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task CancelAsync(Elastic.Clients.Elasticsearch.TaskId? taskId, Action configureRequest, CancellationToken cancellationToken = default) { @@ -176,9 +256,17 @@ public virtual Task CancelAsync(Elastic.Clients.Elasticsearch.Ta /// /// - /// Cancels a task, if it can be cancelled through an API. + /// Cancel a task. + /// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + /// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + /// The get task information API will continue to list these cancelled tasks until they complete. + /// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. + /// + /// + /// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. + /// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. /// - /// 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) { @@ -189,9 +277,17 @@ public virtual Task CancelAsync(CancellationToken cancellationTo /// /// - /// Cancels a task, if it can be cancelled through an API. + /// Cancel a task. + /// A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + /// It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + /// The get task information API will continue to list these cancelled tasks until they complete. + /// The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. + /// + /// + /// To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the ?detailed parameter to identify the other tasks the system is running. + /// You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. /// - /// 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) { @@ -204,9 +300,9 @@ public virtual Task CancelAsync(Action /// /// /// Get task information. - /// Returns information about the tasks currently executing in the cluster. + /// Get information about a task currently running 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) @@ -218,9 +314,9 @@ public virtual GetTasksResponse Get(GetTasksRequest request) /// /// /// Get task information. - /// Returns information about the tasks currently executing in the cluster. + /// Get information about a task currently running 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) { @@ -231,9 +327,9 @@ public virtual Task GetAsync(GetTasksRequest request, Cancella /// /// /// Get task information. - /// Returns information about the tasks currently executing in the cluster. + /// Get information about a task currently running 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) @@ -245,9 +341,9 @@ public virtual GetTasksResponse Get(GetTasksRequestDescriptor descriptor) /// /// /// Get task information. - /// Returns information about the tasks currently executing in the cluster. + /// Get information about a task currently running 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) @@ -260,9 +356,9 @@ public virtual GetTasksResponse Get(Elastic.Clients.Elasticsearch.Id taskId) /// /// /// Get task information. - /// Returns information about the tasks currently executing in the cluster. + /// Get information about a task currently running 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) @@ -276,9 +372,9 @@ public virtual GetTasksResponse Get(Elastic.Clients.Elasticsearch.Id taskId, Act /// /// /// Get task information. - /// Returns information about the tasks currently executing in the cluster. + /// Get information about a task currently running 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) { @@ -289,9 +385,9 @@ public virtual Task GetAsync(GetTasksRequestDescriptor descrip /// /// /// Get task information. - /// Returns information about the tasks currently executing in the cluster. + /// Get information about a task currently running 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) { @@ -303,9 +399,9 @@ public virtual Task GetAsync(Elastic.Clients.Elasticsearch.Id /// /// /// Get task information. - /// Returns information about the tasks currently executing in the cluster. + /// Get information about a task currently running 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) { @@ -317,9 +413,10 @@ 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. + /// Get all tasks. + /// Get information about the tasks currently running 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) @@ -330,9 +427,10 @@ public virtual ListResponse List(ListRequest request) /// /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// Get all tasks. + /// Get information about the tasks currently running 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) { @@ -342,9 +440,10 @@ 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. + /// Get all tasks. + /// Get information about the tasks currently running 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) @@ -355,9 +454,10 @@ public virtual ListResponse List(ListRequestDescriptor descriptor) /// /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// Get all tasks. + /// Get information about the tasks currently running 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() @@ -369,9 +469,10 @@ public virtual ListResponse List() /// /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// Get all tasks. + /// Get information about the tasks currently running 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) @@ -384,9 +485,10 @@ public virtual ListResponse List(Action configureRequest) /// /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// Get all tasks. + /// Get information about the tasks currently running 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) { @@ -396,9 +498,10 @@ 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. + /// Get all tasks. + /// Get information about the tasks currently running 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) { @@ -409,9 +512,10 @@ public virtual Task ListAsync(CancellationToken cancellationToken /// /// - /// The task management API returns information about tasks currently executing on one or more nodes in the cluster. + /// Get all tasks. + /// Get information about the tasks currently running 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.TextStructure.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.TextStructure.g.cs index 191291118f4..ed77c6ee9a8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.TextStructure.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.TextStructure.g.cs @@ -41,7 +41,803 @@ internal TextStructureNamespacedClient(ElasticsearchClient client) : base(client /// /// - /// Tests a Grok pattern on some text. + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindFieldStructureResponse FindFieldStructure(FindFieldStructureRequest request) + { + request.BeforeRequest(); + return DoRequest(request); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindFieldStructureAsync(FindFieldStructureRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindFieldStructureResponse FindFieldStructure(FindFieldStructureRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest, FindFieldStructureResponse, FindFieldStructureRequestParameters>(descriptor); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindFieldStructureResponse FindFieldStructure() + { + var descriptor = new FindFieldStructureRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequest, FindFieldStructureResponse, FindFieldStructureRequestParameters>(descriptor); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindFieldStructureResponse FindFieldStructure(Action> configureRequest) + { + var descriptor = new FindFieldStructureRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest, FindFieldStructureResponse, FindFieldStructureRequestParameters>(descriptor); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindFieldStructureResponse FindFieldStructure(FindFieldStructureRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindFieldStructureResponse FindFieldStructure() + { + var descriptor = new FindFieldStructureRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindFieldStructureResponse FindFieldStructure(Action configureRequest) + { + var descriptor = new FindFieldStructureRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindFieldStructureAsync(FindFieldStructureRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync, FindFieldStructureResponse, FindFieldStructureRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindFieldStructureAsync(CancellationToken cancellationToken = default) + { + var descriptor = new FindFieldStructureRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequestAsync, FindFieldStructureResponse, FindFieldStructureRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindFieldStructureAsync(Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new FindFieldStructureRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, FindFieldStructureResponse, FindFieldStructureRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindFieldStructureAsync(FindFieldStructureRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindFieldStructureAsync(CancellationToken cancellationToken = default) + { + var descriptor = new FindFieldStructureRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Find the structure of a text field. + /// Find the structure of a text field in an Elasticsearch index. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindFieldStructureAsync(Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new FindFieldStructureRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindMessageStructureResponse FindMessageStructure(FindMessageStructureRequest request) + { + request.BeforeRequest(); + return DoRequest(request); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindMessageStructureAsync(FindMessageStructureRequest request, CancellationToken cancellationToken = default) + { + request.BeforeRequest(); + return DoRequestAsync(request, cancellationToken); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindMessageStructureResponse FindMessageStructure(FindMessageStructureRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest, FindMessageStructureResponse, FindMessageStructureRequestParameters>(descriptor); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindMessageStructureResponse FindMessageStructure() + { + var descriptor = new FindMessageStructureRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequest, FindMessageStructureResponse, FindMessageStructureRequestParameters>(descriptor); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindMessageStructureResponse FindMessageStructure(Action> configureRequest) + { + var descriptor = new FindMessageStructureRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest, FindMessageStructureResponse, FindMessageStructureRequestParameters>(descriptor); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindMessageStructureResponse FindMessageStructure(FindMessageStructureRequestDescriptor descriptor) + { + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindMessageStructureResponse FindMessageStructure() + { + var descriptor = new FindMessageStructureRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] + public virtual FindMessageStructureResponse FindMessageStructure(Action configureRequest) + { + var descriptor = new FindMessageStructureRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequest(descriptor); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindMessageStructureAsync(FindMessageStructureRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync, FindMessageStructureResponse, FindMessageStructureRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindMessageStructureAsync(CancellationToken cancellationToken = default) + { + var descriptor = new FindMessageStructureRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequestAsync, FindMessageStructureResponse, FindMessageStructureRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindMessageStructureAsync(Action> configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new FindMessageStructureRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync, FindMessageStructureResponse, FindMessageStructureRequestParameters>(descriptor, cancellationToken); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindMessageStructureAsync(FindMessageStructureRequestDescriptor descriptor, CancellationToken cancellationToken = default) + { + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindMessageStructureAsync(CancellationToken cancellationToken = default) + { + var descriptor = new FindMessageStructureRequestDescriptor(); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Find the structure of text messages. + /// Find the structure of a list of text messages. + /// The messages must contain data that is suitable to be ingested into Elasticsearch. + /// + /// + /// This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + /// Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + /// The response from the API contains: + /// + /// + /// + /// + /// Sample messages. + /// + /// + /// + /// + /// Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + /// + /// + /// + /// + /// Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + /// Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + /// + /// + /// + /// + /// All this information can be calculated by the structure finder with no guidance. + /// However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task FindMessageStructureAsync(Action configureRequest, CancellationToken cancellationToken = default) + { + var descriptor = new FindMessageStructureRequestDescriptor(); + configureRequest?.Invoke(descriptor); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } + + /// + /// + /// Test a Grok pattern. + /// Test a Grok pattern on one or more lines of text. + /// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -54,7 +850,9 @@ public virtual TestGrokPatternResponse TestGrokPattern(TestGrokPatternRequest re /// /// - /// Tests a Grok pattern on some text. + /// Test a Grok pattern. + /// Test a Grok pattern on one or more lines of text. + /// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -66,7 +864,9 @@ public virtual Task TestGrokPatternAsync(TestGrokPatter /// /// - /// Tests a Grok pattern on some text. + /// Test a Grok pattern. + /// Test a Grok pattern on one or more lines of text. + /// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -79,7 +879,9 @@ public virtual TestGrokPatternResponse TestGrokPattern(TestGrokPatternRequestDes /// /// - /// Tests a Grok pattern on some text. + /// Test a Grok pattern. + /// Test a Grok pattern on one or more lines of text. + /// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -93,7 +895,9 @@ public virtual TestGrokPatternResponse TestGrokPattern() /// /// - /// Tests a Grok pattern on some text. + /// Test a Grok pattern. + /// Test a Grok pattern on one or more lines of text. + /// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -108,7 +912,9 @@ public virtual TestGrokPatternResponse TestGrokPattern(Action /// - /// Tests a Grok pattern on some text. + /// Test a Grok pattern. + /// Test a Grok pattern on one or more lines of text. + /// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -120,7 +926,9 @@ public virtual Task TestGrokPatternAsync(TestGrokPatter /// /// - /// Tests a Grok pattern on some text. + /// Test a Grok pattern. + /// Test a Grok pattern on one or more lines of text. + /// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -133,7 +941,9 @@ public virtual Task TestGrokPatternAsync(CancellationTo /// /// - /// Tests a Grok pattern on some text. + /// Test a Grok pattern. + /// Test a Grok pattern on one or more lines of text. + /// The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Transform.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Transform.g.cs index e4d6ae90c2f..383aa2450e9 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Transform.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Transform.g.cs @@ -2169,12 +2169,22 @@ public virtual Task UpdateTransformAsync(Elastic.Client /// /// - /// Upgrades all transforms. - /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index - /// remains unchanged. + /// Upgrade all transforms. + /// Transforms are compatible across minor versions and between supported major versions. + /// However, over time, the format of transform configuration information may change. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + /// It also cleans up the internal data structures that store the transform state and checkpoints. + /// The upgrade does not affect the source and destination indices. + /// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + /// + /// + /// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + /// Resolve the issue then re-run the process again. + /// A summary is returned when the upgrade is finished. + /// + /// + /// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + /// You may want to perform a recent cluster backup prior to the upgrade. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2187,12 +2197,22 @@ public virtual UpgradeTransformsResponse UpgradeTransforms(UpgradeTransformsRequ /// /// - /// Upgrades all transforms. - /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index - /// remains unchanged. + /// Upgrade all transforms. + /// Transforms are compatible across minor versions and between supported major versions. + /// However, over time, the format of transform configuration information may change. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + /// It also cleans up the internal data structures that store the transform state and checkpoints. + /// The upgrade does not affect the source and destination indices. + /// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + /// + /// + /// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + /// Resolve the issue then re-run the process again. + /// A summary is returned when the upgrade is finished. + /// + /// + /// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + /// You may want to perform a recent cluster backup prior to the upgrade. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2204,12 +2224,22 @@ public virtual Task UpgradeTransformsAsync(UpgradeTra /// /// - /// Upgrades all transforms. - /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index - /// remains unchanged. + /// Upgrade all transforms. + /// Transforms are compatible across minor versions and between supported major versions. + /// However, over time, the format of transform configuration information may change. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + /// It also cleans up the internal data structures that store the transform state and checkpoints. + /// The upgrade does not affect the source and destination indices. + /// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + /// + /// + /// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + /// Resolve the issue then re-run the process again. + /// A summary is returned when the upgrade is finished. + /// + /// + /// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + /// You may want to perform a recent cluster backup prior to the upgrade. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2222,12 +2252,22 @@ public virtual UpgradeTransformsResponse UpgradeTransforms(UpgradeTransformsRequ /// /// - /// Upgrades all transforms. - /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index - /// remains unchanged. + /// Upgrade all transforms. + /// Transforms are compatible across minor versions and between supported major versions. + /// However, over time, the format of transform configuration information may change. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + /// It also cleans up the internal data structures that store the transform state and checkpoints. + /// The upgrade does not affect the source and destination indices. + /// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + /// + /// + /// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + /// Resolve the issue then re-run the process again. + /// A summary is returned when the upgrade is finished. + /// + /// + /// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + /// You may want to perform a recent cluster backup prior to the upgrade. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2241,12 +2281,22 @@ public virtual UpgradeTransformsResponse UpgradeTransforms() /// /// - /// Upgrades all transforms. - /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index - /// remains unchanged. + /// Upgrade all transforms. + /// Transforms are compatible across minor versions and between supported major versions. + /// However, over time, the format of transform configuration information may change. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + /// It also cleans up the internal data structures that store the transform state and checkpoints. + /// The upgrade does not affect the source and destination indices. + /// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + /// + /// + /// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + /// Resolve the issue then re-run the process again. + /// A summary is returned when the upgrade is finished. + /// + /// + /// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + /// You may want to perform a recent cluster backup prior to the upgrade. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2261,12 +2311,22 @@ public virtual UpgradeTransformsResponse UpgradeTransforms(Action /// - /// Upgrades all transforms. - /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index - /// remains unchanged. + /// Upgrade all transforms. + /// Transforms are compatible across minor versions and between supported major versions. + /// However, over time, the format of transform configuration information may change. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + /// It also cleans up the internal data structures that store the transform state and checkpoints. + /// The upgrade does not affect the source and destination indices. + /// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + /// + /// + /// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + /// Resolve the issue then re-run the process again. + /// A summary is returned when the upgrade is finished. + /// + /// + /// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + /// You may want to perform a recent cluster backup prior to the upgrade. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2278,12 +2338,22 @@ public virtual Task UpgradeTransformsAsync(UpgradeTra /// /// - /// Upgrades all transforms. - /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index - /// remains unchanged. + /// Upgrade all transforms. + /// Transforms are compatible across minor versions and between supported major versions. + /// However, over time, the format of transform configuration information may change. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + /// It also cleans up the internal data structures that store the transform state and checkpoints. + /// The upgrade does not affect the source and destination indices. + /// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + /// + /// + /// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + /// Resolve the issue then re-run the process again. + /// A summary is returned when the upgrade is finished. + /// + /// + /// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + /// You may want to perform a recent cluster backup prior to the upgrade. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -2296,12 +2366,22 @@ public virtual Task UpgradeTransformsAsync(Cancellati /// /// - /// Upgrades all transforms. - /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It - /// also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not - /// affect the source and destination indices. The upgrade also does not affect the roles that transforms use when - /// Elasticsearch security features are enabled; the role used to read source data and write to the destination index - /// remains unchanged. + /// Upgrade all transforms. + /// Transforms are compatible across minor versions and between supported major versions. + /// However, over time, the format of transform configuration information may change. + /// This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + /// It also cleans up the internal data structures that store the transform state and checkpoints. + /// The upgrade does not affect the source and destination indices. + /// The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + /// + /// + /// If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + /// Resolve the issue then re-run the process again. + /// A summary is returned when the upgrade is finished. + /// + /// + /// To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + /// You may want to perform a recent cluster backup prior to the upgrade. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Xpack.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Xpack.g.cs index 6b26591803c..c456147620c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Xpack.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.Xpack.g.cs @@ -41,8 +41,26 @@ internal XpackNamespacedClient(ElasticsearchClient client) : base(client) /// /// - /// Provides general information about the installed X-Pack features. + /// Get information. + /// The information provided by the API includes: /// + /// + /// + /// + /// Build information including the build number and timestamp. + /// + /// + /// + /// + /// License information about the currently installed license. + /// + /// + /// + /// + /// Feature information for the features that are currently enabled and available under the current license. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -54,8 +72,26 @@ public virtual XpackInfoResponse Info(XpackInfoRequest request) /// /// - /// Provides general information about the installed X-Pack features. + /// Get information. + /// The information provided by the API includes: + /// + /// + /// + /// + /// Build information including the build number and timestamp. + /// + /// + /// + /// + /// License information about the currently installed license. + /// + /// + /// + /// + /// Feature information for the features that are currently enabled and available under the current license. /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(XpackInfoRequest request, CancellationToken cancellationToken = default) @@ -66,8 +102,26 @@ public virtual Task InfoAsync(XpackInfoRequest request, Cance /// /// - /// Provides general information about the installed X-Pack features. + /// Get information. + /// The information provided by the API includes: /// + /// + /// + /// + /// Build information including the build number and timestamp. + /// + /// + /// + /// + /// License information about the currently installed license. + /// + /// + /// + /// + /// Feature information for the features that are currently enabled and available under the current license. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -79,8 +133,26 @@ public virtual XpackInfoResponse Info(XpackInfoRequestDescriptor descriptor) /// /// - /// Provides general information about the installed X-Pack features. + /// Get information. + /// The information provided by the API includes: + /// + /// + /// + /// + /// Build information including the build number and timestamp. + /// + /// + /// + /// + /// License information about the currently installed license. + /// + /// + /// + /// + /// Feature information for the features that are currently enabled and available under the current license. /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -93,8 +165,26 @@ public virtual XpackInfoResponse Info() /// /// - /// Provides general information about the installed X-Pack features. + /// Get information. + /// The information provided by the API includes: /// + /// + /// + /// + /// Build information including the build number and timestamp. + /// + /// + /// + /// + /// License information about the currently installed license. + /// + /// + /// + /// + /// Feature information for the features that are currently enabled and available under the current license. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// [Obsolete("Synchronous methods are deprecated and could be removed in the future.")] @@ -108,8 +198,26 @@ public virtual XpackInfoResponse Info(Action configu /// /// - /// Provides general information about the installed X-Pack features. + /// Get information. + /// The information provided by the API includes: + /// + /// + /// + /// + /// Build information including the build number and timestamp. + /// + /// + /// + /// + /// License information about the currently installed license. + /// + /// + /// + /// + /// Feature information for the features that are currently enabled and available under the current license. /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(XpackInfoRequestDescriptor descriptor, CancellationToken cancellationToken = default) @@ -120,8 +228,26 @@ public virtual Task InfoAsync(XpackInfoRequestDescriptor desc /// /// - /// Provides general information about the installed X-Pack features. + /// Get information. + /// The information provided by the API includes: /// + /// + /// + /// + /// Build information including the build number and timestamp. + /// + /// + /// + /// + /// License information about the currently installed license. + /// + /// + /// + /// + /// Feature information for the features that are currently enabled and available under the current license. + /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(CancellationToken cancellationToken = default) @@ -133,8 +259,26 @@ public virtual Task InfoAsync(CancellationToken cancellationT /// /// - /// Provides general information about the installed X-Pack features. + /// Get information. + /// The information provided by the API includes: + /// + /// + /// + /// + /// Build information including the build number and timestamp. + /// + /// + /// + /// + /// License information about the currently installed license. + /// + /// + /// + /// + /// Feature information for the features that are currently enabled and available under the current license. /// + /// + /// /// Learn more about this API in the Elasticsearch documentation. /// public virtual Task InfoAsync(Action configureRequest, CancellationToken cancellationToken = default) @@ -147,7 +291,9 @@ public virtual Task InfoAsync(Action /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// Get usage information. + /// Get information about the features that are currently enabled and available under the current license. + /// The API also provides some usage statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -160,7 +306,9 @@ public virtual XpackUsageResponse Usage(XpackUsageRequest request) /// /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// Get usage information. + /// Get information about the features that are currently enabled and available under the current license. + /// The API also provides some usage statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -172,7 +320,9 @@ public virtual Task UsageAsync(XpackUsageRequest request, Ca /// /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// Get usage information. + /// Get information about the features that are currently enabled and available under the current license. + /// The API also provides some usage statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -185,7 +335,9 @@ public virtual XpackUsageResponse Usage(XpackUsageRequestDescriptor descriptor) /// /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// Get usage information. + /// Get information about the features that are currently enabled and available under the current license. + /// The API also provides some usage statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -199,7 +351,9 @@ public virtual XpackUsageResponse Usage() /// /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// Get usage information. + /// Get information about the features that are currently enabled and available under the current license. + /// The API also provides some usage statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -214,7 +368,9 @@ public virtual XpackUsageResponse Usage(Action conf /// /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// Get usage information. + /// Get information about the features that are currently enabled and available under the current license. + /// The API also provides some usage statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -226,7 +382,9 @@ public virtual Task UsageAsync(XpackUsageRequestDescriptor d /// /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// Get usage information. + /// Get information about the features that are currently enabled and available under the current license. + /// The API also provides some usage statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -239,7 +397,9 @@ public virtual Task UsageAsync(CancellationToken cancellatio /// /// - /// This API provides information about which features are currently enabled and available under the current license and some usage statistics. + /// Get usage information. + /// Get information about the features that are currently enabled and available under the current license. + /// The API also provides some usage statistics. /// /// Learn more about this API in the Elasticsearch documentation. /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Client/ElasticsearchClient.g.cs index c28ef2403d0..d3ce0ad78fe 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) { @@ -675,7 +747,8 @@ public virtual Task ClosePointInTimeAsync(Action /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -688,7 +761,8 @@ public virtual CountResponse Count(CountRequest request) /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -700,7 +774,8 @@ public virtual Task CountAsync(CountRequest request, Cancellation /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -713,7 +788,8 @@ public virtual CountResponse Count(CountRequestDescriptor /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -727,7 +803,8 @@ public virtual CountResponse Count(Elastic.Clients.Elasticsearch.Indi /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -742,7 +819,8 @@ public virtual CountResponse Count(Elastic.Clients.Elasticsearch.Indi /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -756,7 +834,8 @@ public virtual CountResponse Count() /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -771,7 +850,8 @@ public virtual CountResponse Count(Action /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -784,7 +864,8 @@ public virtual CountResponse Count(CountRequestDescriptor descriptor) /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -798,7 +879,8 @@ public virtual CountResponse Count(Elastic.Clients.Elasticsearch.Indices? indice /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -813,7 +895,8 @@ public virtual CountResponse Count(Elastic.Clients.Elasticsearch.Indices? indice /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -827,7 +910,8 @@ public virtual CountResponse Count() /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -842,7 +926,8 @@ public virtual CountResponse Count(Action configureReque /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -854,7 +939,8 @@ public virtual Task CountAsync(CountRequestDescriptor< /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -867,7 +953,8 @@ public virtual Task CountAsync(Elastic.Clients.Elastic /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -881,7 +968,8 @@ public virtual Task CountAsync(Elastic.Clients.Elastic /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -894,7 +982,8 @@ public virtual Task CountAsync(CancellationToken cance /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -908,7 +997,8 @@ public virtual Task CountAsync(Action /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -920,7 +1010,8 @@ public virtual Task CountAsync(CountRequestDescriptor descriptor, /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -933,7 +1024,8 @@ public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Indi /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -947,7 +1039,8 @@ public virtual Task CountAsync(Elastic.Clients.Elasticsearch.Indi /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -960,7 +1053,8 @@ public virtual Task CountAsync(CancellationToken cancellationToke /// /// - /// Returns number of documents matching a query. + /// Count search results. + /// Get the number of documents matching a query. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -1990,7 +2084,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 +2101,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 +2117,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 +2134,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 +2152,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 +2171,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 +2187,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 +2204,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 +3659,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 +3680,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 +3700,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 +3721,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 +3743,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 +3766,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 +3788,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 +3811,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 +3832,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 +3854,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 +3877,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 +3899,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 +3922,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 +3942,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 +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. /// @@ -3769,9 +3985,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 +4006,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 +4028,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 +4048,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 +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. /// @@ -3845,9 +4091,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 +4112,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 +4689,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 +4705,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 +4720,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 +4736,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 +4753,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 +4771,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 +4786,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 +4802,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 +4819,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 +4835,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 +4850,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 +4866,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 +4883,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 +4901,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 +4916,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 +4932,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. /// @@ -4997,7 +5303,29 @@ public virtual Task> GetSourceAsync(Elas /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5010,7 +5338,29 @@ public virtual HealthReportResponse HealthReport(HealthReportRequest request) /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5022,7 +5372,29 @@ public virtual Task HealthReportAsync(HealthReportRequest /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5035,7 +5407,29 @@ public virtual HealthReportResponse HealthReport(HealthReportRequestDescriptor d /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5049,7 +5443,29 @@ public virtual HealthReportResponse HealthReport(IReadOnlyCollection? fe /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5064,7 +5480,29 @@ public virtual HealthReportResponse HealthReport(IReadOnlyCollection? fe /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5078,7 +5516,29 @@ public virtual HealthReportResponse HealthReport() /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5093,7 +5553,29 @@ public virtual HealthReportResponse HealthReport(Action /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5105,20 +5587,64 @@ public virtual Task HealthReportAsync(HealthReportRequestD /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. /// - /// Learn more about this API in the Elasticsearch documentation. - /// - public virtual Task HealthReportAsync(IReadOnlyCollection? feature, CancellationToken cancellationToken = default) - { - var descriptor = new HealthReportRequestDescriptor(feature); - descriptor.BeforeRequest(); - return DoRequestAsync(descriptor, cancellationToken); - } + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. + /// + /// Learn more about this API in the Elasticsearch documentation. + /// + public virtual Task HealthReportAsync(IReadOnlyCollection? feature, CancellationToken cancellationToken = default) + { + var descriptor = new HealthReportRequestDescriptor(feature); + descriptor.BeforeRequest(); + return DoRequestAsync(descriptor, cancellationToken); + } /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5132,7 +5658,29 @@ public virtual Task HealthReportAsync(IReadOnlyCollection< /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5145,7 +5693,29 @@ public virtual Task HealthReportAsync(CancellationToken ca /// /// - /// Returns the health of the cluster. + /// Get the cluster health. + /// Get a report with the health status of an Elasticsearch cluster. + /// The report contains a list of indicators that compose Elasticsearch functionality. + /// + /// + /// Each indicator has a health status of: green, unknown, yellow or red. + /// The indicator will provide an explanation and metadata describing the reason for its current health status. + /// + /// + /// The cluster’s status is controlled by the worst indicator status. + /// + /// + /// In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + /// Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + /// + /// + /// Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + /// The root cause and remediation steps are encapsulated in a diagnosis. + /// A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + /// + /// + /// NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + /// When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -5587,7 +6157,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 +6176,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 +6194,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 +6213,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 +6233,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 +6254,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 +6274,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 +6295,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 +6314,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 +6334,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 +6355,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 +6375,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 +6396,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 +6414,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 +6433,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 +6453,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 +6472,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 +6492,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 +6510,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 +6529,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 +6549,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 +6568,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 +6588,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 +6606,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 +6623,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 +6641,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 +6660,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 +6680,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 +6699,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 +6719,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 +6736,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 +6754,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 +6773,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 +6791,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 +6810,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 +6841,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 +6871,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,7 +6902,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. /// @@ -6100,7 +6934,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 +6967,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 +6999,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 +7032,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 +7062,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 +7093,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 +7125,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 +7156,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 +7188,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 +7201,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 +7213,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 +7226,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 +7240,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 +7255,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 +7269,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 +7284,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 +7296,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 +7309,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 +7323,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 +7336,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 +7350,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 +7375,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 +7399,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 +7424,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 +7450,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 +7477,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 +7503,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 +7530,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 +7555,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 +7581,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 +7608,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 +7632,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 +7657,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 +7683,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 +7708,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 +7734,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 +7758,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 +7783,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) { @@ -6706,7 +7810,7 @@ public virtual Task OpenPointInTimeAsync(Elastic.Client /// /// /// Ping the cluster. - /// Returns whether the cluster is running. + /// Get information about whether the cluster is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6720,7 +7824,7 @@ public virtual PingResponse Ping(PingRequest request) /// /// /// Ping the cluster. - /// Returns whether the cluster is running. + /// Get information about whether the cluster is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6733,7 +7837,7 @@ public virtual Task PingAsync(PingRequest request, CancellationTok /// /// /// Ping the cluster. - /// Returns whether the cluster is running. + /// Get information about whether the cluster is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6747,7 +7851,7 @@ public virtual PingResponse Ping(PingRequestDescriptor descriptor) /// /// /// Ping the cluster. - /// Returns whether the cluster is running. + /// Get information about whether the cluster is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6762,7 +7866,7 @@ public virtual PingResponse Ping() /// /// /// Ping the cluster. - /// Returns whether the cluster is running. + /// Get information about whether the cluster is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6778,7 +7882,7 @@ public virtual PingResponse Ping(Action configureRequest) /// /// /// Ping the cluster. - /// Returns whether the cluster is running. + /// Get information about whether the cluster is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6791,7 +7895,7 @@ public virtual Task PingAsync(PingRequestDescriptor descriptor, Ca /// /// /// Ping the cluster. - /// Returns whether the cluster is running. + /// Get information about whether the cluster is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -6805,7 +7909,7 @@ public virtual Task PingAsync(CancellationToken cancellationToken /// /// /// Ping the cluster. - /// Returns whether the cluster is running. + /// Get information about whether the cluster is running. /// /// Learn more about this API in the Elasticsearch documentation. /// @@ -7140,7 +8244,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 +8260,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 +8275,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 +8291,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 +8308,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 +8326,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 +8343,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 +8361,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 +8377,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 +8394,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 +8412,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 +8429,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 +8447,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 +8462,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 +8478,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 +8495,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 +8511,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 +8528,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 +8543,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 +8559,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 +8576,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 +8592,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 +8810,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 +8826,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 +8841,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 +8857,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 +8874,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 +8892,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 +8907,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 +8923,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 +8940,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 +8956,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 +8971,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 +8987,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 +9004,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 +9022,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 +9039,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 +9057,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 +9073,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 +9090,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 +9108,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 +9125,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 +9143,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 +9158,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 +9174,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 +9191,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 +9207,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 +9224,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 +9239,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 +9255,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 +9272,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 +9288,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 +9419,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 +9449,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 +9478,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 +9496,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 +9513,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 +9531,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 +9550,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 +9570,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 +9589,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 +9609,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 +9626,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 +9644,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 +9663,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 +9681,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 +9701,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 +9717,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 +9732,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 +9748,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 +9765,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 +9783,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 +9800,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 +9818,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 +9834,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 +9851,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 +9869,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 +9884,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 +9900,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 +9917,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 +9933,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 +9950,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 +9965,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 +9981,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 +9997,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 +10015,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 +10032,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 +10050,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 +10069,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 +10089,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 +10108,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 +10128,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 +10146,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 +10165,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 +10185,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 +10204,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 +10224,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 +10241,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 +10259,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 +10278,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 +10296,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 +10315,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 +10332,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 +10350,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 +10369,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 +10387,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 +10406,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 +10419,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 +10431,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 +10444,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 +10458,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 +10473,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 +10487,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 +10502,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 +10514,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 +10527,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 +10541,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 +10554,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 +10568,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 +10592,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 +10615,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 +10639,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 +10664,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 +10690,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 +10715,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 +10741,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 +10765,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 +10790,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 +10816,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 +10839,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 +10863,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 +10888,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 +10912,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 +10937,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 +10960,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 +10984,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 +11010,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 +11026,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 +11041,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 +11057,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 +11074,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 +11092,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 +11109,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 +11127,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 +11144,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 +11162,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 +11179,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 +11197,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 +11214,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 +11232,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 +11249,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 +11267,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 +11282,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 +11298,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 +11315,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 +11331,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 +11348,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 +11364,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 +11381,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 +11397,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 +11414,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 +11430,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 +11447,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 +11463,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 +12112,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 +12129,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 +12145,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 +12162,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 +12180,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 +12199,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 +12215,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 +12232,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 efa42e9196d..e32a1cbe1ac 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 5414414a252..ff080b07f17 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 400b13112a4..3b0b5da0aaf 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/HealthReport/FileSettingsIndicator.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/FileSettingsIndicator.g.cs new file mode 100644 index 00000000000..ffbababfc4a --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/FileSettingsIndicator.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.Core.HealthReport; + +/// +/// +/// FILE_SETTINGS +/// +/// +public sealed partial class FileSettingsIndicator +{ + [JsonInclude, JsonPropertyName("details")] + public Elastic.Clients.Elasticsearch.Core.HealthReport.FileSettingsIndicatorDetails? Details { get; init; } + [JsonInclude, JsonPropertyName("diagnosis")] + public IReadOnlyCollection? Diagnosis { get; init; } + [JsonInclude, JsonPropertyName("impacts")] + public IReadOnlyCollection? Impacts { get; init; } + [JsonInclude, JsonPropertyName("status")] + public Elastic.Clients.Elasticsearch.Core.HealthReport.IndicatorHealthStatus Status { get; init; } + [JsonInclude, JsonPropertyName("symptom")] + public string Symptom { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/FileSettingsIndicatorDetails.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/FileSettingsIndicatorDetails.g.cs new file mode 100644 index 00000000000..e104bbb7ddb --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/FileSettingsIndicatorDetails.g.cs @@ -0,0 +1,36 @@ +// 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.Core.HealthReport; + +public sealed partial class FileSettingsIndicatorDetails +{ + [JsonInclude, JsonPropertyName("failure_streak")] + public long FailureStreak { get; init; } + [JsonInclude, JsonPropertyName("most_recent_failure")] + public string MostRecentFailure { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/Indicators.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/Indicators.g.cs index 6cc347b2606..05f5aa6f061 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/Indicators.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Core/HealthReport/Indicators.g.cs @@ -33,6 +33,8 @@ public sealed partial class Indicators public Elastic.Clients.Elasticsearch.Core.HealthReport.DataStreamLifecycleIndicator? DataStreamLifecycle { get; init; } [JsonInclude, JsonPropertyName("disk")] public Elastic.Clients.Elasticsearch.Core.HealthReport.DiskIndicator? Disk { get; init; } + [JsonInclude, JsonPropertyName("file_settings")] + public Elastic.Clients.Elasticsearch.Core.HealthReport.FileSettingsIndicator? FileSettings { get; init; } [JsonInclude, JsonPropertyName("ilm")] public Elastic.Clients.Elasticsearch.Core.HealthReport.IlmIndicator? Ilm { get; init; } [JsonInclude, JsonPropertyName("master_is_stable")] 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 a8cc3f95f58..8de32585af1 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 8228aa19f04..18c31ca04f5 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 f8eb8da98ff..a5db8520c2f 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 f20081bf15e..ddf8cc6549e 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 a6c3382a51f..36a07ea83d2 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 06ff51f8ada..95d202cef15 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.Mapping.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Mapping.g.cs index b9936319efd..af9e0d808bf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Mapping.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Mapping.g.cs @@ -403,6 +403,8 @@ public enum FieldType RankFeature, [EnumMember(Value = "percolator")] Percolator, + [EnumMember(Value = "passthrough")] + Passthrough, [EnumMember(Value = "object")] Object, [EnumMember(Value = "none")] @@ -504,6 +506,8 @@ public override FieldType Read(ref Utf8JsonReader reader, Type typeToConvert, Js return FieldType.RankFeature; case "percolator": return FieldType.Percolator; + case "passthrough": + return FieldType.Passthrough; case "object": return FieldType.Object; case "none": @@ -618,6 +622,9 @@ public override void Write(Utf8JsonWriter writer, FieldType value, JsonSerialize case FieldType.Percolator: writer.WriteStringValue("percolator"); return; + case FieldType.Passthrough: + writer.WriteStringValue("passthrough"); + return; case FieldType.Object: writer.WriteStringValue("object"); return; 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 5d86de5b198..a73a00e061d 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 @@ -126,6 +126,48 @@ public override void Write(Utf8JsonWriter writer, ApiKeyGrantType value, JsonSer } } +[JsonConverter(typeof(ApiKeyTypeConverter))] +public enum ApiKeyType +{ + [EnumMember(Value = "rest")] + Rest, + [EnumMember(Value = "cross_cluster")] + CrossCluster +} + +internal sealed class ApiKeyTypeConverter : JsonConverter +{ + public override ApiKeyType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + var enumString = reader.GetString(); + switch (enumString) + { + case "rest": + return ApiKeyType.Rest; + case "cross_cluster": + return ApiKeyType.CrossCluster; + } + + ThrowHelper.ThrowJsonException(); + return default; + } + + public override void Write(Utf8JsonWriter writer, ApiKeyType value, JsonSerializerOptions options) + { + switch (value) + { + case ApiKeyType.Rest: + writer.WriteStringValue("rest"); + return; + case ApiKeyType.CrossCluster: + writer.WriteStringValue("cross_cluster"); + return; + } + + writer.WriteNullValue(); + } +} + [JsonConverter(typeof(EnumStructConverter))] public readonly partial struct ClusterPrivilege : IEnumStruct { @@ -148,6 +190,7 @@ public override void Write(Utf8JsonWriter writer, ApiKeyGrantType value, JsonSer public static ClusterPrivilege MonitorWatcher { get; } = new ClusterPrivilege("monitor_watcher"); public static ClusterPrivilege MonitorTransform { get; } = new ClusterPrivilege("monitor_transform"); public static ClusterPrivilege MonitorTextStructure { get; } = new ClusterPrivilege("monitor_text_structure"); + public static ClusterPrivilege MonitorStats { get; } = new ClusterPrivilege("monitor_stats"); public static ClusterPrivilege MonitorSnapshot { get; } = new ClusterPrivilege("monitor_snapshot"); public static ClusterPrivilege MonitorRollup { get; } = new ClusterPrivilege("monitor_rollup"); public static ClusterPrivilege MonitorMl { get; } = new ClusterPrivilege("monitor_ml"); @@ -302,6 +345,71 @@ 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_stats")] + MonitorStats, + [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_stats": + return RemoteClusterPrivilege.MonitorStats; + case "monitor_enrich": + return RemoteClusterPrivilege.MonitorEnrich; + } + + ThrowHelper.ThrowJsonException(); + return default; + } + + public override void Write(Utf8JsonWriter writer, RemoteClusterPrivilege value, JsonSerializerOptions options) + { + switch (value) + { + case RemoteClusterPrivilege.MonitorStats: + writer.WriteStringValue("monitor_stats"); + return; + 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/Enums/Enums.TextStructure.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.TextStructure.g.cs new file mode 100644 index 00000000000..3fc28166b89 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.TextStructure.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.Core; +using Elastic.Clients.Elasticsearch.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.TextStructure; + +[JsonConverter(typeof(EcsCompatibilityTypeConverter))] +public enum EcsCompatibilityType +{ + [EnumMember(Value = "v1")] + V1, + [EnumMember(Value = "disabled")] + Disabled +} + +internal sealed class EcsCompatibilityTypeConverter : JsonConverter +{ + public override EcsCompatibilityType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + var enumString = reader.GetString(); + switch (enumString) + { + case "v1": + return EcsCompatibilityType.V1; + case "disabled": + return EcsCompatibilityType.Disabled; + } + + ThrowHelper.ThrowJsonException(); + return default; + } + + public override void Write(Utf8JsonWriter writer, EcsCompatibilityType value, JsonSerializerOptions options) + { + switch (value) + { + case EcsCompatibilityType.V1: + writer.WriteStringValue("v1"); + return; + case EcsCompatibilityType.Disabled: + writer.WriteStringValue("disabled"); + return; + } + + writer.WriteNullValue(); + } +} + +[JsonConverter(typeof(FormatTypeConverter))] +public enum FormatType +{ + [EnumMember(Value = "xml")] + Xml, + [EnumMember(Value = "semi_structured_text")] + SemiStructuredText, + [EnumMember(Value = "ndjson")] + Ndjson, + [EnumMember(Value = "delimited")] + Delimited +} + +internal sealed class FormatTypeConverter : JsonConverter +{ + public override FormatType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + var enumString = reader.GetString(); + switch (enumString) + { + case "xml": + return FormatType.Xml; + case "semi_structured_text": + return FormatType.SemiStructuredText; + case "ndjson": + return FormatType.Ndjson; + case "delimited": + return FormatType.Delimited; + } + + ThrowHelper.ThrowJsonException(); + return default; + } + + public override void Write(Utf8JsonWriter writer, FormatType value, JsonSerializerOptions options) + { + switch (value) + { + case FormatType.Xml: + writer.WriteStringValue("xml"); + return; + case FormatType.SemiStructuredText: + writer.WriteStringValue("semi_structured_text"); + return; + case FormatType.Ndjson: + writer.WriteStringValue("ndjson"); + return; + case FormatType.Delimited: + writer.WriteStringValue("delimited"); + return; + } + + writer.WriteNullValue(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Fuzziness.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Fuzziness.g.cs index 8e7161ffe81..467552231b7 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 bde86c5aa76..af6ef53abc5 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 67be908fbd6..974bb01a049 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 f1f55abf69b..68c2b4ced4b 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 8a53108a912..85cb6c2f4ac 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 7b5cf8d780c..f66dc302ac4 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 2dc02e63f1f..a0fb8572f81 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/IndexManagement/MappingLimitSettingsTotalFields.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs index 388e699a94a..40b883ca2cb 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/IndexManagement/MappingLimitSettingsTotalFields.g.cs @@ -39,7 +39,7 @@ public sealed partial class MappingLimitSettingsTotalFields /// /// [JsonInclude, JsonPropertyName("ignore_dynamic_beyond_limit")] - public bool? IgnoreDynamicBeyondLimit { get; set; } + public object? IgnoreDynamicBeyondLimit { get; set; } /// /// @@ -49,7 +49,7 @@ public sealed partial class MappingLimitSettingsTotalFields /// /// [JsonInclude, JsonPropertyName("limit")] - public long? Limit { get; set; } + public object? Limit { get; set; } } public sealed partial class MappingLimitSettingsTotalFieldsDescriptor : SerializableDescriptor @@ -60,8 +60,8 @@ public MappingLimitSettingsTotalFieldsDescriptor() : base() { } - private bool? IgnoreDynamicBeyondLimitValue { get; set; } - private long? LimitValue { get; set; } + private object? IgnoreDynamicBeyondLimitValue { get; set; } + private object? LimitValue { get; set; } /// /// @@ -72,7 +72,7 @@ public MappingLimitSettingsTotalFieldsDescriptor() : base() /// The fields that were not added to the mapping will be added to the _ignored field. /// /// - public MappingLimitSettingsTotalFieldsDescriptor IgnoreDynamicBeyondLimit(bool? ignoreDynamicBeyondLimit = true) + public MappingLimitSettingsTotalFieldsDescriptor IgnoreDynamicBeyondLimit(object? ignoreDynamicBeyondLimit) { IgnoreDynamicBeyondLimitValue = ignoreDynamicBeyondLimit; return Self; @@ -85,7 +85,7 @@ public MappingLimitSettingsTotalFieldsDescriptor IgnoreDynamicBeyondLimit(bool? /// degradations and memory issues, especially in clusters with a high load or few resources. /// /// - public MappingLimitSettingsTotalFieldsDescriptor Limit(long? limit) + public MappingLimitSettingsTotalFieldsDescriptor Limit(object? limit) { LimitValue = limit; return Self; @@ -94,16 +94,16 @@ public MappingLimitSettingsTotalFieldsDescriptor Limit(long? limit) protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); - if (IgnoreDynamicBeyondLimitValue.HasValue) + if (IgnoreDynamicBeyondLimitValue is not null) { writer.WritePropertyName("ignore_dynamic_beyond_limit"); - writer.WriteBooleanValue(IgnoreDynamicBeyondLimitValue.Value); + JsonSerializer.Serialize(writer, IgnoreDynamicBeyondLimitValue, options); } - if (LimitValue.HasValue) + if (LimitValue is not null) { writer.WritePropertyName("limit"); - writer.WriteNumberValue(LimitValue.Value); + JsonSerializer.Serialize(writer, LimitValue, options); } writer.WriteEndObject(); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DatabaseConfiguration.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DatabaseConfiguration.g.cs index 705489f941b..0ee2cf7640a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DatabaseConfiguration.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DatabaseConfiguration.g.cs @@ -21,28 +21,289 @@ using Elastic.Clients.Elasticsearch.Serialization; using System; using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; using System.Linq.Expressions; using System.Text.Json; using System.Text.Json.Serialization; namespace Elastic.Clients.Elasticsearch.Ingest; +/// +/// +/// The configuration necessary to identify which IP geolocation provider to use to download a database, as well as any provider-specific configuration necessary for such downloading. +/// At present, the only supported providers are maxmind and ipinfo, and the maxmind provider requires that an account_id (string) is configured. +/// A provider (either maxmind or ipinfo) must be specified. The web and local providers can be returned as read only configurations. +/// +/// +[JsonConverter(typeof(DatabaseConfigurationConverter))] public sealed partial class DatabaseConfiguration { + internal DatabaseConfiguration(string variantName, object variant) + { + if (variantName is null) + throw new ArgumentNullException(nameof(variantName)); + if (variant is null) + throw new ArgumentNullException(nameof(variant)); + if (string.IsNullOrWhiteSpace(variantName)) + throw new ArgumentException("Variant name must not be empty or whitespace."); + VariantName = variantName; + Variant = variant; + } + + internal object Variant { get; } + internal string VariantName { get; } + + public static DatabaseConfiguration Ipinfo(Elastic.Clients.Elasticsearch.Ingest.Ipinfo ipinfo) => new DatabaseConfiguration("ipinfo", ipinfo); + public static DatabaseConfiguration Maxmind(Elastic.Clients.Elasticsearch.Ingest.Maxmind maxmind) => new DatabaseConfiguration("maxmind", maxmind); + + /// + /// + /// The provider-assigned name of the IP geolocation database to download. + /// + /// + [JsonInclude, JsonPropertyName("name")] + public Elastic.Clients.Elasticsearch.Name Name { get; set; } + + public bool TryGet([NotNullWhen(true)] out T? result) where T : class + { + result = default; + if (Variant is T variant) + { + result = variant; + return true; + } + + return false; + } +} + +internal sealed partial class DatabaseConfigurationConverter : JsonConverter +{ + public override DatabaseConfiguration Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType != JsonTokenType.StartObject) + { + throw new JsonException("Expected start token."); + } + + object? variantValue = default; + string? variantNameValue = default; + Elastic.Clients.Elasticsearch.Name nameValue = default; + while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) + { + if (reader.TokenType != JsonTokenType.PropertyName) + { + throw new JsonException("Expected a property name token."); + } + + if (reader.TokenType != JsonTokenType.PropertyName) + { + throw new JsonException("Expected a property name token representing the name of an Elasticsearch field."); + } + + var propertyName = reader.GetString(); + reader.Read(); + if (propertyName == "name") + { + nameValue = JsonSerializer.Deserialize(ref reader, options); + continue; + } + + if (propertyName == "ipinfo") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + + if (propertyName == "maxmind") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + + throw new JsonException($"Unknown property name '{propertyName}' received while deserializing the 'DatabaseConfiguration' from the response."); + } + + var result = new DatabaseConfiguration(variantNameValue, variantValue); + result.Name = nameValue; + return result; + } + + public override void Write(Utf8JsonWriter writer, DatabaseConfiguration value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + if (value.Name is not null) + { + writer.WritePropertyName("name"); + JsonSerializer.Serialize(writer, value.Name, options); + } + + if (value.VariantName is not null && value.Variant is not null) + { + writer.WritePropertyName(value.VariantName); + switch (value.VariantName) + { + case "ipinfo": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Ingest.Ipinfo)value.Variant, options); + break; + case "maxmind": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Ingest.Maxmind)value.Variant, options); + break; + } + } + + writer.WriteEndObject(); + } +} + +public sealed partial class DatabaseConfigurationDescriptor : SerializableDescriptor> +{ + internal DatabaseConfigurationDescriptor(Action> configure) => configure.Invoke(this); + + public DatabaseConfigurationDescriptor() : base() + { + } + + private bool ContainsVariant { get; set; } + private string ContainedVariantName { get; set; } + private object Variant { get; set; } + private Descriptor Descriptor { get; set; } + + private DatabaseConfigurationDescriptor Set(Action descriptorAction, string variantName) where T : Descriptor + { + ContainedVariantName = variantName; + ContainsVariant = true; + var descriptor = (T)Activator.CreateInstance(typeof(T), true); + descriptorAction?.Invoke(descriptor); + Descriptor = descriptor; + return Self; + } + + private DatabaseConfigurationDescriptor Set(object variant, string variantName) + { + Variant = variant; + ContainedVariantName = variantName; + ContainsVariant = true; + return Self; + } + + private Elastic.Clients.Elasticsearch.Name NameValue { get; set; } + /// /// - /// The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading. - /// At present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured. + /// The provider-assigned name of the IP geolocation database to download. /// /// - [JsonInclude, JsonPropertyName("maxmind")] - public Elastic.Clients.Elasticsearch.Ingest.Maxmind Maxmind { get; init; } + public DatabaseConfigurationDescriptor Name(Elastic.Clients.Elasticsearch.Name name) + { + NameValue = name; + return Self; + } + + public DatabaseConfigurationDescriptor Ipinfo(Elastic.Clients.Elasticsearch.Ingest.Ipinfo ipinfo) => Set(ipinfo, "ipinfo"); + public DatabaseConfigurationDescriptor Ipinfo(Action configure) => Set(configure, "ipinfo"); + public DatabaseConfigurationDescriptor Maxmind(Elastic.Clients.Elasticsearch.Ingest.Maxmind maxmind) => Set(maxmind, "maxmind"); + public DatabaseConfigurationDescriptor Maxmind(Action configure) => Set(configure, "maxmind"); + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (NameValue is not null) + { + writer.WritePropertyName("name"); + JsonSerializer.Serialize(writer, NameValue, options); + } + + if (!string.IsNullOrEmpty(ContainedVariantName)) + { + writer.WritePropertyName(ContainedVariantName); + if (Variant is not null) + { + JsonSerializer.Serialize(writer, Variant, Variant.GetType(), options); + writer.WriteEndObject(); + return; + } + + JsonSerializer.Serialize(writer, Descriptor, Descriptor.GetType(), options); + } + + writer.WriteEndObject(); + } +} + +public sealed partial class DatabaseConfigurationDescriptor : SerializableDescriptor +{ + internal DatabaseConfigurationDescriptor(Action configure) => configure.Invoke(this); + + public DatabaseConfigurationDescriptor() : base() + { + } + + private bool ContainsVariant { get; set; } + private string ContainedVariantName { get; set; } + private object Variant { get; set; } + private Descriptor Descriptor { get; set; } + + private DatabaseConfigurationDescriptor Set(Action descriptorAction, string variantName) where T : Descriptor + { + ContainedVariantName = variantName; + ContainsVariant = true; + var descriptor = (T)Activator.CreateInstance(typeof(T), true); + descriptorAction?.Invoke(descriptor); + Descriptor = descriptor; + return Self; + } + + private DatabaseConfigurationDescriptor Set(object variant, string variantName) + { + Variant = variant; + ContainedVariantName = variantName; + ContainsVariant = true; + return Self; + } + + private Elastic.Clients.Elasticsearch.Name NameValue { get; set; } /// /// /// The provider-assigned name of the IP geolocation database to download. /// /// - [JsonInclude, JsonPropertyName("name")] - public string Name { get; init; } + public DatabaseConfigurationDescriptor Name(Elastic.Clients.Elasticsearch.Name name) + { + NameValue = name; + return Self; + } + + public DatabaseConfigurationDescriptor Ipinfo(Elastic.Clients.Elasticsearch.Ingest.Ipinfo ipinfo) => Set(ipinfo, "ipinfo"); + public DatabaseConfigurationDescriptor Ipinfo(Action configure) => Set(configure, "ipinfo"); + public DatabaseConfigurationDescriptor Maxmind(Elastic.Clients.Elasticsearch.Ingest.Maxmind maxmind) => Set(maxmind, "maxmind"); + public DatabaseConfigurationDescriptor Maxmind(Action configure) => Set(configure, "maxmind"); + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (NameValue is not null) + { + writer.WritePropertyName("name"); + JsonSerializer.Serialize(writer, NameValue, options); + } + + if (!string.IsNullOrEmpty(ContainedVariantName)) + { + writer.WritePropertyName(ContainedVariantName); + if (Variant is not null) + { + JsonSerializer.Serialize(writer, Variant, Variant.GetType(), options); + writer.WriteEndObject(); + return; + } + + JsonSerializer.Serialize(writer, Descriptor, Descriptor.GetType(), options); + } + + writer.WriteEndObject(); + } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DatabaseConfigurationFull.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DatabaseConfigurationFull.g.cs new file mode 100644 index 00000000000..153f4bd724b --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/DatabaseConfigurationFull.g.cs @@ -0,0 +1,332 @@ +// 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.Diagnostics.CodeAnalysis; +using System.Linq.Expressions; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Elastic.Clients.Elasticsearch.Ingest; + +[JsonConverter(typeof(DatabaseConfigurationFullConverter))] +public sealed partial class DatabaseConfigurationFull +{ + internal DatabaseConfigurationFull(string variantName, object variant) + { + if (variantName is null) + throw new ArgumentNullException(nameof(variantName)); + if (variant is null) + throw new ArgumentNullException(nameof(variant)); + if (string.IsNullOrWhiteSpace(variantName)) + throw new ArgumentException("Variant name must not be empty or whitespace."); + VariantName = variantName; + Variant = variant; + } + + internal object Variant { get; } + internal string VariantName { get; } + + public static DatabaseConfigurationFull Ipinfo(Elastic.Clients.Elasticsearch.Ingest.Ipinfo ipinfo) => new DatabaseConfigurationFull("ipinfo", ipinfo); + public static DatabaseConfigurationFull Local(Elastic.Clients.Elasticsearch.Ingest.Local local) => new DatabaseConfigurationFull("local", local); + public static DatabaseConfigurationFull Maxmind(Elastic.Clients.Elasticsearch.Ingest.Maxmind maxmind) => new DatabaseConfigurationFull("maxmind", maxmind); + public static DatabaseConfigurationFull Web(Elastic.Clients.Elasticsearch.Ingest.Web web) => new DatabaseConfigurationFull("web", web); + + /// + /// + /// The provider-assigned name of the IP geolocation database to download. + /// + /// + [JsonInclude, JsonPropertyName("name")] + public string Name { get; set; } + + public bool TryGet([NotNullWhen(true)] out T? result) where T : class + { + result = default; + if (Variant is T variant) + { + result = variant; + return true; + } + + return false; + } +} + +internal sealed partial class DatabaseConfigurationFullConverter : JsonConverter +{ + public override DatabaseConfigurationFull Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + if (reader.TokenType != JsonTokenType.StartObject) + { + throw new JsonException("Expected start token."); + } + + object? variantValue = default; + string? variantNameValue = default; + string nameValue = default; + while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) + { + if (reader.TokenType != JsonTokenType.PropertyName) + { + throw new JsonException("Expected a property name token."); + } + + if (reader.TokenType != JsonTokenType.PropertyName) + { + throw new JsonException("Expected a property name token representing the name of an Elasticsearch field."); + } + + var propertyName = reader.GetString(); + reader.Read(); + if (propertyName == "name") + { + nameValue = JsonSerializer.Deserialize(ref reader, options); + continue; + } + + if (propertyName == "ipinfo") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + + if (propertyName == "local") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + + if (propertyName == "maxmind") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + + if (propertyName == "web") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + + throw new JsonException($"Unknown property name '{propertyName}' received while deserializing the 'DatabaseConfigurationFull' from the response."); + } + + var result = new DatabaseConfigurationFull(variantNameValue, variantValue); + result.Name = nameValue; + return result; + } + + public override void Write(Utf8JsonWriter writer, DatabaseConfigurationFull value, JsonSerializerOptions options) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(value.Name)) + { + writer.WritePropertyName("name"); + writer.WriteStringValue(value.Name); + } + + if (value.VariantName is not null && value.Variant is not null) + { + writer.WritePropertyName(value.VariantName); + switch (value.VariantName) + { + case "ipinfo": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Ingest.Ipinfo)value.Variant, options); + break; + case "local": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Ingest.Local)value.Variant, options); + break; + case "maxmind": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Ingest.Maxmind)value.Variant, options); + break; + case "web": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.Ingest.Web)value.Variant, options); + break; + } + } + + writer.WriteEndObject(); + } +} + +public sealed partial class DatabaseConfigurationFullDescriptor : SerializableDescriptor> +{ + internal DatabaseConfigurationFullDescriptor(Action> configure) => configure.Invoke(this); + + public DatabaseConfigurationFullDescriptor() : base() + { + } + + private bool ContainsVariant { get; set; } + private string ContainedVariantName { get; set; } + private object Variant { get; set; } + private Descriptor Descriptor { get; set; } + + private DatabaseConfigurationFullDescriptor Set(Action descriptorAction, string variantName) where T : Descriptor + { + ContainedVariantName = variantName; + ContainsVariant = true; + var descriptor = (T)Activator.CreateInstance(typeof(T), true); + descriptorAction?.Invoke(descriptor); + Descriptor = descriptor; + return Self; + } + + private DatabaseConfigurationFullDescriptor Set(object variant, string variantName) + { + Variant = variant; + ContainedVariantName = variantName; + ContainsVariant = true; + return Self; + } + + private string NameValue { get; set; } + + /// + /// + /// The provider-assigned name of the IP geolocation database to download. + /// + /// + public DatabaseConfigurationFullDescriptor Name(string name) + { + NameValue = name; + return Self; + } + + public DatabaseConfigurationFullDescriptor Ipinfo(Elastic.Clients.Elasticsearch.Ingest.Ipinfo ipinfo) => Set(ipinfo, "ipinfo"); + public DatabaseConfigurationFullDescriptor Ipinfo(Action configure) => Set(configure, "ipinfo"); + public DatabaseConfigurationFullDescriptor Local(Elastic.Clients.Elasticsearch.Ingest.Local local) => Set(local, "local"); + public DatabaseConfigurationFullDescriptor Local(Action configure) => Set(configure, "local"); + public DatabaseConfigurationFullDescriptor Maxmind(Elastic.Clients.Elasticsearch.Ingest.Maxmind maxmind) => Set(maxmind, "maxmind"); + public DatabaseConfigurationFullDescriptor Maxmind(Action configure) => Set(configure, "maxmind"); + public DatabaseConfigurationFullDescriptor Web(Elastic.Clients.Elasticsearch.Ingest.Web web) => Set(web, "web"); + public DatabaseConfigurationFullDescriptor Web(Action configure) => Set(configure, "web"); + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(NameValue)) + { + writer.WritePropertyName("name"); + writer.WriteStringValue(NameValue); + } + + if (!string.IsNullOrEmpty(ContainedVariantName)) + { + writer.WritePropertyName(ContainedVariantName); + if (Variant is not null) + { + JsonSerializer.Serialize(writer, Variant, Variant.GetType(), options); + writer.WriteEndObject(); + return; + } + + JsonSerializer.Serialize(writer, Descriptor, Descriptor.GetType(), options); + } + + writer.WriteEndObject(); + } +} + +public sealed partial class DatabaseConfigurationFullDescriptor : SerializableDescriptor +{ + internal DatabaseConfigurationFullDescriptor(Action configure) => configure.Invoke(this); + + public DatabaseConfigurationFullDescriptor() : base() + { + } + + private bool ContainsVariant { get; set; } + private string ContainedVariantName { get; set; } + private object Variant { get; set; } + private Descriptor Descriptor { get; set; } + + private DatabaseConfigurationFullDescriptor Set(Action descriptorAction, string variantName) where T : Descriptor + { + ContainedVariantName = variantName; + ContainsVariant = true; + var descriptor = (T)Activator.CreateInstance(typeof(T), true); + descriptorAction?.Invoke(descriptor); + Descriptor = descriptor; + return Self; + } + + private DatabaseConfigurationFullDescriptor Set(object variant, string variantName) + { + Variant = variant; + ContainedVariantName = variantName; + ContainsVariant = true; + return Self; + } + + private string NameValue { get; set; } + + /// + /// + /// The provider-assigned name of the IP geolocation database to download. + /// + /// + public DatabaseConfigurationFullDescriptor Name(string name) + { + NameValue = name; + return Self; + } + + public DatabaseConfigurationFullDescriptor Ipinfo(Elastic.Clients.Elasticsearch.Ingest.Ipinfo ipinfo) => Set(ipinfo, "ipinfo"); + public DatabaseConfigurationFullDescriptor Ipinfo(Action configure) => Set(configure, "ipinfo"); + public DatabaseConfigurationFullDescriptor Local(Elastic.Clients.Elasticsearch.Ingest.Local local) => Set(local, "local"); + public DatabaseConfigurationFullDescriptor Local(Action configure) => Set(configure, "local"); + public DatabaseConfigurationFullDescriptor Maxmind(Elastic.Clients.Elasticsearch.Ingest.Maxmind maxmind) => Set(maxmind, "maxmind"); + public DatabaseConfigurationFullDescriptor Maxmind(Action configure) => Set(configure, "maxmind"); + public DatabaseConfigurationFullDescriptor Web(Elastic.Clients.Elasticsearch.Ingest.Web web) => Set(web, "web"); + public DatabaseConfigurationFullDescriptor Web(Action configure) => Set(configure, "web"); + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (!string.IsNullOrEmpty(NameValue)) + { + writer.WritePropertyName("name"); + writer.WriteStringValue(NameValue); + } + + if (!string.IsNullOrEmpty(ContainedVariantName)) + { + writer.WritePropertyName(ContainedVariantName); + if (Variant is not null) + { + JsonSerializer.Serialize(writer, Variant, Variant.GetType(), options); + writer.WriteEndObject(); + return; + } + + JsonSerializer.Serialize(writer, Descriptor, Descriptor.GetType(), options); + } + + writer.WriteEndObject(); + } +} \ No newline at end of file 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 fed73dac315..45e9a06e279 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/IpDatabaseConfigurationMetadata.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/IpDatabaseConfigurationMetadata.g.cs new file mode 100644 index 00000000000..5242779f807 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/IpDatabaseConfigurationMetadata.g.cs @@ -0,0 +1,42 @@ +// 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 IpDatabaseConfigurationMetadata +{ + [JsonInclude, JsonPropertyName("database")] + public Elastic.Clients.Elasticsearch.Ingest.DatabaseConfigurationFull Database { get; init; } + [JsonInclude, JsonPropertyName("id")] + public string Id { get; init; } + [JsonInclude, JsonPropertyName("modified_date")] + public long? ModifiedDate { get; init; } + [JsonInclude, JsonPropertyName("modified_date_millis")] + public long? ModifiedDateMillis { get; init; } + [JsonInclude, JsonPropertyName("version")] + public long Version { 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 00000000000..c6691f1eb02 --- /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/Ipinfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Ipinfo.g.cs new file mode 100644 index 00000000000..22d40793b7c --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Ipinfo.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.Ingest; + +public sealed partial class Ipinfo +{ +} + +public sealed partial class IpinfoDescriptor : SerializableDescriptor +{ + internal IpinfoDescriptor(Action configure) => configure.Invoke(this); + + public IpinfoDescriptor() : base() + { + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Local.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Local.g.cs new file mode 100644 index 00000000000..72e158e02c5 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Local.g.cs @@ -0,0 +1,61 @@ +// 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 Local +{ + [JsonInclude, JsonPropertyName("type")] + public string Type { get; set; } + + public static implicit operator Elastic.Clients.Elasticsearch.Ingest.DatabaseConfigurationFull(Local local) => Elastic.Clients.Elasticsearch.Ingest.DatabaseConfigurationFull.Local(local); +} + +public sealed partial class LocalDescriptor : SerializableDescriptor +{ + internal LocalDescriptor(Action configure) => configure.Invoke(this); + + public LocalDescriptor() : base() + { + } + + private string TypeValue { get; set; } + + public LocalDescriptor Type(string type) + { + TypeValue = type; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + writer.WritePropertyName("type"); + writer.WriteStringValue(TypeValue); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Maxmind.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Maxmind.g.cs index 95aad9d84a1..16164834ba4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Maxmind.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Maxmind.g.cs @@ -31,6 +31,9 @@ public sealed partial class Maxmind { [JsonInclude, JsonPropertyName("account_id")] public Elastic.Clients.Elasticsearch.Id AccountId { get; set; } + + public static implicit operator Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration(Maxmind maxmind) => Elastic.Clients.Elasticsearch.Ingest.DatabaseConfiguration.Maxmind(maxmind); + public static implicit operator Elastic.Clients.Elasticsearch.Ingest.DatabaseConfigurationFull(Maxmind maxmind) => Elastic.Clients.Elasticsearch.Ingest.DatabaseConfigurationFull.Maxmind(maxmind); } public sealed partial class MaxmindDescriptor : SerializableDescriptor diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationListItem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/PipelineConfig.g.cs similarity index 67% rename from src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationListItem.g.cs rename to src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/PipelineConfig.g.cs index f660ec1cfd7..698d1261e8e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/SearchApplication/SearchApplicationListItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/PipelineConfig.g.cs @@ -25,39 +25,32 @@ using System.Text.Json; using System.Text.Json.Serialization; -namespace Elastic.Clients.Elasticsearch.SearchApplication; +namespace Elastic.Clients.Elasticsearch.Ingest; -public sealed partial class SearchApplicationListItem +public sealed partial class PipelineConfig { /// /// - /// Analytics collection associated to the Search Application + /// Description of the ingest pipeline. /// /// - [JsonInclude, JsonPropertyName("analytics_collection_name")] - public string? AnalyticsCollectionName { get; init; } + [JsonInclude, JsonPropertyName("description")] + public string? Description { get; init; } /// /// - /// Indices that are part of the Search Application + /// Processors used to perform transformations on documents before indexing. + /// Processors run sequentially in the order specified. /// /// - [JsonInclude, JsonPropertyName("indices")] - public IReadOnlyCollection Indices { get; init; } + [JsonInclude, JsonPropertyName("processors")] + public IReadOnlyCollection Processors { get; init; } /// /// - /// Search Application name + /// Version number used by external systems to track ingest pipelines. /// /// - [JsonInclude, JsonPropertyName("name")] - public string Name { get; init; } - - /// - /// - /// Last time the Search Application was updated - /// - /// - [JsonInclude, JsonPropertyName("updated_at_millis")] - public long UpdatedAtMillis { get; init; } + [JsonInclude, JsonPropertyName("version")] + public long? Version { get; init; } } \ 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 d8402c22813..b7020c13d1a 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 00000000000..28bfd168d3a --- /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 d5254f4b816..bc07497c735 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/Ingest/Web.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Web.g.cs new file mode 100644 index 00000000000..b98bbde2f8d --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Ingest/Web.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.Ingest; + +public sealed partial class Web +{ +} + +public sealed partial class WebDescriptor : SerializableDescriptor +{ + internal WebDescriptor(Action configure) => configure.Invoke(this); + + public WebDescriptor() : base() + { + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + 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 bd289b0d994..effdb6f24c5 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/MachineLearning/AdaptiveAllocationsSettings.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AdaptiveAllocationsSettings.g.cs new file mode 100644 index 00000000000..20423691083 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AdaptiveAllocationsSettings.g.cs @@ -0,0 +1,38 @@ +// 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.MachineLearning; + +public sealed partial class AdaptiveAllocationsSettings +{ + [JsonInclude, JsonPropertyName("enabled")] + public bool Enabled { get; init; } + [JsonInclude, JsonPropertyName("max_number_of_allocations")] + public int? MaxNumberOfAllocations { get; init; } + [JsonInclude, JsonPropertyName("min_number_of_allocations")] + public int? MinNumberOfAllocations { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisLimits.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisLimits.g.cs index dc6af2774f9..714533433d4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisLimits.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/AnalysisLimits.g.cs @@ -43,7 +43,7 @@ public sealed partial class AnalysisLimits /// /// [JsonInclude, JsonPropertyName("model_memory_limit")] - public string? ModelMemoryLimit { get; set; } + public Elastic.Clients.Elasticsearch.ByteSize? ModelMemoryLimit { get; set; } } public sealed partial class AnalysisLimitsDescriptor : SerializableDescriptor @@ -55,7 +55,7 @@ public AnalysisLimitsDescriptor() : base() } private long? CategorizationExamplesLimitValue { get; set; } - private string? ModelMemoryLimitValue { get; set; } + private Elastic.Clients.Elasticsearch.ByteSize? ModelMemoryLimitValue { get; set; } /// /// @@ -73,7 +73,7 @@ public AnalysisLimitsDescriptor CategorizationExamplesLimit(long? categorization /// The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the xpack.ml.max_model_memory_limit setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of b or kb and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the xpack.ml.max_model_memory_limit setting, an error occurs when you try to create jobs that have model_memory_limit values greater than that setting value. /// /// - public AnalysisLimitsDescriptor ModelMemoryLimit(string? modelMemoryLimit) + public AnalysisLimitsDescriptor ModelMemoryLimit(Elastic.Clients.Elasticsearch.ByteSize? modelMemoryLimit) { ModelMemoryLimitValue = modelMemoryLimit; return Self; @@ -88,10 +88,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(CategorizationExamplesLimitValue.Value); } - if (!string.IsNullOrEmpty(ModelMemoryLimitValue)) + if (ModelMemoryLimitValue is not null) { writer.WritePropertyName("model_memory_limit"); - writer.WriteStringValue(ModelMemoryLimitValue); + JsonSerializer.Serialize(writer, ModelMemoryLimitValue, options); } writer.WriteEndObject(); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedStats.g.cs index 201c27455b9..3cd3e8629d8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedStats.g.cs @@ -53,7 +53,7 @@ public sealed partial class DatafeedStats /// /// [JsonInclude, JsonPropertyName("node")] - public Elastic.Clients.Elasticsearch.MachineLearning.DiscoveryNode? Node { get; init; } + public Elastic.Clients.Elasticsearch.MachineLearning.DiscoveryNodeCompact? Node { get; init; } /// /// @@ -78,5 +78,5 @@ public sealed partial class DatafeedStats /// /// [JsonInclude, JsonPropertyName("timing_stats")] - public Elastic.Clients.Elasticsearch.MachineLearning.DatafeedTimingStats TimingStats { get; init; } + public Elastic.Clients.Elasticsearch.MachineLearning.DatafeedTimingStats? TimingStats { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs index cb452a08436..fa9c55834e7 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DatafeedTimingStats.g.cs @@ -44,6 +44,8 @@ public sealed partial class DatafeedTimingStats /// [JsonInclude, JsonPropertyName("bucket_count")] public long BucketCount { get; init; } + [JsonInclude, JsonPropertyName("exponential_average_calculation_context")] + public Elastic.Clients.Elasticsearch.MachineLearning.ExponentialAverageCalculationContext? ExponentialAverageCalculationContext { get; init; } /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs index 22e36e83cb9..5b03b680d55 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DataframeAnalyticsSummary.g.cs @@ -53,6 +53,8 @@ public sealed partial class DataframeAnalyticsSummary public string Id { get; init; } [JsonInclude, JsonPropertyName("max_num_threads")] public int? MaxNumThreads { get; init; } + [JsonInclude, JsonPropertyName("_meta")] + public IReadOnlyDictionary? Meta { get; init; } [JsonInclude, JsonPropertyName("model_memory_limit")] public string? ModelMemoryLimit { get; init; } [JsonInclude, JsonPropertyName("source")] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DetectorUpdate.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DetectorUpdate.g.cs new file mode 100644 index 00000000000..a08ff5d8000 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DetectorUpdate.g.cs @@ -0,0 +1,312 @@ +// 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.MachineLearning; + +public sealed partial class DetectorUpdate +{ + /// + /// + /// An array of custom rule objects, which enable you to customize the way detectors operate. + /// For example, a rule may dictate to the detector conditions under which results should be skipped. + /// Kibana refers to custom rules as job rules. + /// + /// + [JsonInclude, JsonPropertyName("custom_rules")] + public ICollection? CustomRules { get; set; } + + /// + /// + /// A description of the detector. + /// + /// + [JsonInclude, JsonPropertyName("description")] + public string? Description { get; set; } + + /// + /// + /// A unique identifier for the detector. + /// This identifier is based on the order of the detectors in the analysis_config, starting at zero. + /// + /// + [JsonInclude, JsonPropertyName("detector_index")] + public int DetectorIndex { get; set; } +} + +public sealed partial class DetectorUpdateDescriptor : SerializableDescriptor> +{ + internal DetectorUpdateDescriptor(Action> configure) => configure.Invoke(this); + + public DetectorUpdateDescriptor() : base() + { + } + + private ICollection? CustomRulesValue { get; set; } + private Elastic.Clients.Elasticsearch.MachineLearning.DetectionRuleDescriptor CustomRulesDescriptor { get; set; } + private Action> CustomRulesDescriptorAction { get; set; } + private Action>[] CustomRulesDescriptorActions { get; set; } + private string? DescriptionValue { get; set; } + private int DetectorIndexValue { get; set; } + + /// + /// + /// An array of custom rule objects, which enable you to customize the way detectors operate. + /// For example, a rule may dictate to the detector conditions under which results should be skipped. + /// Kibana refers to custom rules as job rules. + /// + /// + public DetectorUpdateDescriptor CustomRules(ICollection? customRules) + { + CustomRulesDescriptor = null; + CustomRulesDescriptorAction = null; + CustomRulesDescriptorActions = null; + CustomRulesValue = customRules; + return Self; + } + + public DetectorUpdateDescriptor CustomRules(Elastic.Clients.Elasticsearch.MachineLearning.DetectionRuleDescriptor descriptor) + { + CustomRulesValue = null; + CustomRulesDescriptorAction = null; + CustomRulesDescriptorActions = null; + CustomRulesDescriptor = descriptor; + return Self; + } + + public DetectorUpdateDescriptor CustomRules(Action> configure) + { + CustomRulesValue = null; + CustomRulesDescriptor = null; + CustomRulesDescriptorActions = null; + CustomRulesDescriptorAction = configure; + return Self; + } + + public DetectorUpdateDescriptor CustomRules(params Action>[] configure) + { + CustomRulesValue = null; + CustomRulesDescriptor = null; + CustomRulesDescriptorAction = null; + CustomRulesDescriptorActions = configure; + return Self; + } + + /// + /// + /// A description of the detector. + /// + /// + public DetectorUpdateDescriptor Description(string? description) + { + DescriptionValue = description; + return Self; + } + + /// + /// + /// A unique identifier for the detector. + /// This identifier is based on the order of the detectors in the analysis_config, starting at zero. + /// + /// + public DetectorUpdateDescriptor DetectorIndex(int detectorIndex) + { + DetectorIndexValue = detectorIndex; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (CustomRulesDescriptor is not null) + { + writer.WritePropertyName("custom_rules"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, CustomRulesDescriptor, options); + writer.WriteEndArray(); + } + else if (CustomRulesDescriptorAction is not null) + { + writer.WritePropertyName("custom_rules"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.DetectionRuleDescriptor(CustomRulesDescriptorAction), options); + writer.WriteEndArray(); + } + else if (CustomRulesDescriptorActions is not null) + { + writer.WritePropertyName("custom_rules"); + writer.WriteStartArray(); + foreach (var action in CustomRulesDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.DetectionRuleDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (CustomRulesValue is not null) + { + writer.WritePropertyName("custom_rules"); + JsonSerializer.Serialize(writer, CustomRulesValue, options); + } + + if (!string.IsNullOrEmpty(DescriptionValue)) + { + writer.WritePropertyName("description"); + writer.WriteStringValue(DescriptionValue); + } + + writer.WritePropertyName("detector_index"); + writer.WriteNumberValue(DetectorIndexValue); + writer.WriteEndObject(); + } +} + +public sealed partial class DetectorUpdateDescriptor : SerializableDescriptor +{ + internal DetectorUpdateDescriptor(Action configure) => configure.Invoke(this); + + public DetectorUpdateDescriptor() : base() + { + } + + private ICollection? CustomRulesValue { get; set; } + private Elastic.Clients.Elasticsearch.MachineLearning.DetectionRuleDescriptor CustomRulesDescriptor { get; set; } + private Action CustomRulesDescriptorAction { get; set; } + private Action[] CustomRulesDescriptorActions { get; set; } + private string? DescriptionValue { get; set; } + private int DetectorIndexValue { get; set; } + + /// + /// + /// An array of custom rule objects, which enable you to customize the way detectors operate. + /// For example, a rule may dictate to the detector conditions under which results should be skipped. + /// Kibana refers to custom rules as job rules. + /// + /// + public DetectorUpdateDescriptor CustomRules(ICollection? customRules) + { + CustomRulesDescriptor = null; + CustomRulesDescriptorAction = null; + CustomRulesDescriptorActions = null; + CustomRulesValue = customRules; + return Self; + } + + public DetectorUpdateDescriptor CustomRules(Elastic.Clients.Elasticsearch.MachineLearning.DetectionRuleDescriptor descriptor) + { + CustomRulesValue = null; + CustomRulesDescriptorAction = null; + CustomRulesDescriptorActions = null; + CustomRulesDescriptor = descriptor; + return Self; + } + + public DetectorUpdateDescriptor CustomRules(Action configure) + { + CustomRulesValue = null; + CustomRulesDescriptor = null; + CustomRulesDescriptorActions = null; + CustomRulesDescriptorAction = configure; + return Self; + } + + public DetectorUpdateDescriptor CustomRules(params Action[] configure) + { + CustomRulesValue = null; + CustomRulesDescriptor = null; + CustomRulesDescriptorAction = null; + CustomRulesDescriptorActions = configure; + return Self; + } + + /// + /// + /// A description of the detector. + /// + /// + public DetectorUpdateDescriptor Description(string? description) + { + DescriptionValue = description; + return Self; + } + + /// + /// + /// A unique identifier for the detector. + /// This identifier is based on the order of the detectors in the analysis_config, starting at zero. + /// + /// + public DetectorUpdateDescriptor DetectorIndex(int detectorIndex) + { + DetectorIndexValue = detectorIndex; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (CustomRulesDescriptor is not null) + { + writer.WritePropertyName("custom_rules"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, CustomRulesDescriptor, options); + writer.WriteEndArray(); + } + else if (CustomRulesDescriptorAction is not null) + { + writer.WritePropertyName("custom_rules"); + writer.WriteStartArray(); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.DetectionRuleDescriptor(CustomRulesDescriptorAction), options); + writer.WriteEndArray(); + } + else if (CustomRulesDescriptorActions is not null) + { + writer.WritePropertyName("custom_rules"); + writer.WriteStartArray(); + foreach (var action in CustomRulesDescriptorActions) + { + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.DetectionRuleDescriptor(action), options); + } + + writer.WriteEndArray(); + } + else if (CustomRulesValue is not null) + { + writer.WritePropertyName("custom_rules"); + JsonSerializer.Serialize(writer, CustomRulesValue, options); + } + + if (!string.IsNullOrEmpty(DescriptionValue)) + { + writer.WritePropertyName("description"); + writer.WriteStringValue(DescriptionValue); + } + + writer.WritePropertyName("detector_index"); + writer.WriteNumberValue(DetectorIndexValue); + writer.WriteEndObject(); + } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DiscoveryNode.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DiscoveryNodeCompact.g.cs similarity index 90% rename from src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DiscoveryNode.g.cs rename to src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DiscoveryNodeCompact.g.cs index b45aec98b79..22ee787581f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DiscoveryNode.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DiscoveryNodeCompact.g.cs @@ -27,7 +27,12 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; -public sealed partial class DiscoveryNode +/// +/// +/// Alternative representation of DiscoveryNode used in ml.get_job_stats and ml.get_datafeed_stats +/// +/// +public sealed partial class DiscoveryNodeCompact { [JsonInclude, JsonPropertyName("attributes")] public IReadOnlyDictionary Attributes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DiscoveryNodeContent.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DiscoveryNodeContent.g.cs new file mode 100644 index 00000000000..e24cf838d53 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/DiscoveryNodeContent.g.cs @@ -0,0 +1,50 @@ +// 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.MachineLearning; + +public sealed partial class DiscoveryNodeContent +{ + [JsonInclude, JsonPropertyName("attributes")] + public IReadOnlyDictionary Attributes { get; init; } + [JsonInclude, JsonPropertyName("ephemeral_id")] + public string EphemeralId { get; init; } + [JsonInclude, JsonPropertyName("external_id")] + public string ExternalId { get; init; } + [JsonInclude, JsonPropertyName("max_index_version")] + public int MaxIndexVersion { get; init; } + [JsonInclude, JsonPropertyName("min_index_version")] + public int MinIndexVersion { get; init; } + [JsonInclude, JsonPropertyName("name")] + public string? Name { get; init; } + [JsonInclude, JsonPropertyName("roles")] + public IReadOnlyCollection Roles { get; init; } + [JsonInclude, JsonPropertyName("transport_address")] + public string TransportAddress { get; init; } + [JsonInclude, JsonPropertyName("version")] + public string Version { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ExponentialAverageCalculationContext.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ExponentialAverageCalculationContext.g.cs new file mode 100644 index 00000000000..d9d92226dab --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ExponentialAverageCalculationContext.g.cs @@ -0,0 +1,38 @@ +// 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.MachineLearning; + +public sealed partial class ExponentialAverageCalculationContext +{ + [JsonInclude, JsonPropertyName("incremental_metric_value_ms")] + public double IncrementalMetricValueMs { get; init; } + [JsonInclude, JsonPropertyName("latest_timestamp")] + public long? LatestTimestamp { get; init; } + [JsonInclude, JsonPropertyName("previous_exponential_average_ms")] + public double? PreviousExponentialAverageMs { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs index c0ee3c334ae..690cc69cb4c 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/FillMaskInferenceOptions.g.cs @@ -69,6 +69,8 @@ public sealed partial class FillMaskInferenceOptions /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? Tokenization { get; set; } + [JsonInclude, JsonPropertyName("vocabulary")] + public Elastic.Clients.Elasticsearch.MachineLearning.Vocabulary Vocabulary { get; set; } public static implicit operator Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigCreate(FillMaskInferenceOptions fillMaskInferenceOptions) => Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigCreate.FillMask(fillMaskInferenceOptions); } @@ -92,6 +94,9 @@ public FillMaskInferenceOptionsDescriptor() : base() private Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? TokenizationValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfigDescriptor TokenizationDescriptor { get; set; } private Action TokenizationDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.MachineLearning.Vocabulary VocabularyValue { get; set; } + private Elastic.Clients.Elasticsearch.MachineLearning.VocabularyDescriptor VocabularyDescriptor { get; set; } + private Action VocabularyDescriptorAction { get; set; } /// /// @@ -159,6 +164,30 @@ public FillMaskInferenceOptionsDescriptor Tokenization(Action configure) + { + VocabularyValue = null; + VocabularyDescriptor = null; + VocabularyDescriptorAction = configure; + return Self; + } + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); @@ -196,6 +225,22 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, TokenizationValue, options); } + if (VocabularyDescriptor is not null) + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, VocabularyDescriptor, options); + } + else if (VocabularyDescriptorAction is not null) + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.VocabularyDescriptor(VocabularyDescriptorAction), options); + } + else + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, VocabularyValue, options); + } + writer.WriteEndObject(); } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/JobStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/JobStats.g.cs index c8dae4de397..5f5315c52db 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/JobStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/JobStats.g.cs @@ -87,7 +87,7 @@ public sealed partial class JobStats /// /// [JsonInclude, JsonPropertyName("node")] - public Elastic.Clients.Elasticsearch.MachineLearning.DiscoveryNode? Node { get; init; } + public Elastic.Clients.Elasticsearch.MachineLearning.DiscoveryNodeCompact? Node { get; init; } /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Limits.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Limits.g.cs index b1845bd0aba..3672829ff72 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Limits.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/Limits.g.cs @@ -30,9 +30,13 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class Limits { [JsonInclude, JsonPropertyName("effective_max_model_memory_limit")] - public string EffectiveMaxModelMemoryLimit { get; init; } + public Elastic.Clients.Elasticsearch.ByteSize? EffectiveMaxModelMemoryLimit { get; init; } [JsonInclude, JsonPropertyName("max_model_memory_limit")] - public string? MaxModelMemoryLimit { get; init; } + public Elastic.Clients.Elasticsearch.ByteSize? MaxModelMemoryLimit { get; init; } + [JsonInclude, JsonPropertyName("max_single_ml_node_processors")] + public int? MaxSingleMlNodeProcessors { get; init; } [JsonInclude, JsonPropertyName("total_ml_memory")] - public string TotalMlMemory { get; init; } + public Elastic.Clients.Elasticsearch.ByteSize TotalMlMemory { get; init; } + [JsonInclude, JsonPropertyName("total_ml_processors")] + public int? TotalMlProcessors { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelPackageConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelPackageConfig.g.cs new file mode 100644 index 00000000000..43aca84a8a6 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelPackageConfig.g.cs @@ -0,0 +1,60 @@ +// 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.MachineLearning; + +public sealed partial class ModelPackageConfig +{ + [JsonInclude, JsonPropertyName("create_time")] + public long? CreateTime { get; init; } + [JsonInclude, JsonPropertyName("description")] + public string? Description { get; init; } + [JsonInclude, JsonPropertyName("inference_config")] + public IReadOnlyDictionary? InferenceConfig { get; init; } + [JsonInclude, JsonPropertyName("metadata")] + public IReadOnlyDictionary? Metadata { get; init; } + [JsonInclude, JsonPropertyName("minimum_version")] + public string? MinimumVersion { get; init; } + [JsonInclude, JsonPropertyName("model_repository")] + public string? ModelRepository { get; init; } + [JsonInclude, JsonPropertyName("model_type")] + public string? ModelType { get; init; } + [JsonInclude, JsonPropertyName("packaged_model_id")] + public string PackagedModelId { get; init; } + [JsonInclude, JsonPropertyName("platform_architecture")] + public string? PlatformArchitecture { get; init; } + [JsonInclude, JsonPropertyName("prefix_strings")] + public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelPrefixStrings? PrefixStrings { get; init; } + [JsonInclude, JsonPropertyName("sha256")] + public string? Sha256 { get; init; } + [JsonInclude, JsonPropertyName("size")] + public Elastic.Clients.Elasticsearch.ByteSize? Size { get; init; } + [JsonInclude, JsonPropertyName("tags")] + public IReadOnlyCollection? Tags { get; init; } + [JsonInclude, JsonPropertyName("vocabulary_file")] + public string? VocabularyFile { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelSizeStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelSizeStats.g.cs index a390216ea6a..dd2dbaa443e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelSizeStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelSizeStats.g.cs @@ -55,6 +55,8 @@ public sealed partial class ModelSizeStats public Elastic.Clients.Elasticsearch.ByteSize? ModelBytesExceeded { get; init; } [JsonInclude, JsonPropertyName("model_bytes_memory_limit")] public Elastic.Clients.Elasticsearch.ByteSize? ModelBytesMemoryLimit { get; init; } + [JsonInclude, JsonPropertyName("output_memory_allocator_bytes")] + public Elastic.Clients.Elasticsearch.ByteSize? OutputMemoryAllocatorBytes { get; init; } [JsonInclude, JsonPropertyName("peak_model_bytes")] public Elastic.Clients.Elasticsearch.ByteSize? PeakModelBytes { get; init; } [JsonInclude, JsonPropertyName("rare_category_count")] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelSnapshotUpgrade.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelSnapshotUpgrade.g.cs index 93702047375..289fbe89638 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelSnapshotUpgrade.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/ModelSnapshotUpgrade.g.cs @@ -34,7 +34,7 @@ public sealed partial class ModelSnapshotUpgrade [JsonInclude, JsonPropertyName("job_id")] public string JobId { get; init; } [JsonInclude, JsonPropertyName("node")] - public Elastic.Clients.Elasticsearch.MachineLearning.DiscoveryNode Node { get; init; } + public KeyValuePair Node { get; init; } [JsonInclude, JsonPropertyName("snapshot_id")] public string SnapshotId { get; init; } [JsonInclude, JsonPropertyName("state")] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs index bc199d9985d..5fbef7b055f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/NlpRobertaTokenizationConfig.g.cs @@ -42,6 +42,14 @@ public sealed partial class NlpRobertaTokenizationConfig [JsonInclude, JsonPropertyName("add_prefix_space")] public bool? AddPrefixSpace { get; set; } + /// + /// + /// Should the tokenizer lower case the text + /// + /// + [JsonInclude, JsonPropertyName("do_lower_case")] + public bool? DoLowerCase { get; set; } + /// /// /// Maximum input sequence length for the model @@ -91,6 +99,7 @@ public NlpRobertaTokenizationConfigDescriptor() : base() } private bool? AddPrefixSpaceValue { get; set; } + private bool? DoLowerCaseValue { get; set; } private int? MaxSequenceLengthValue { get; set; } private int? SpanValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.TokenizationTruncate? TruncateValue { get; set; } @@ -107,6 +116,17 @@ public NlpRobertaTokenizationConfigDescriptor AddPrefixSpace(bool? addPrefixSpac return Self; } + /// + /// + /// Should the tokenizer lower case the text + /// + /// + public NlpRobertaTokenizationConfigDescriptor DoLowerCase(bool? doLowerCase = true) + { + DoLowerCaseValue = doLowerCase; + return Self; + } + /// /// /// Maximum input sequence length for the model @@ -160,6 +180,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteBooleanValue(AddPrefixSpaceValue.Value); } + if (DoLowerCaseValue.HasValue) + { + writer.WritePropertyName("do_lower_case"); + writer.WriteBooleanValue(DoLowerCaseValue.Value); + } + if (MaxSequenceLengthValue.HasValue) { writer.WritePropertyName("max_sequence_length"); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/OverallBucket.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/OverallBucket.g.cs index 0807784d1c1..d68ea60d31a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/OverallBucket.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/OverallBucket.g.cs @@ -83,5 +83,5 @@ public sealed partial class OverallBucket /// /// [JsonInclude, JsonPropertyName("timestamp_string")] - public DateTimeOffset TimestampString { get; init; } + public DateTimeOffset? TimestampString { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs index bb082b6b6c9..104024cca83 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextEmbeddingInferenceOptions.g.cs @@ -57,6 +57,8 @@ public sealed partial class TextEmbeddingInferenceOptions /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? Tokenization { get; set; } + [JsonInclude, JsonPropertyName("vocabulary")] + public Elastic.Clients.Elasticsearch.MachineLearning.Vocabulary Vocabulary { get; set; } public static implicit operator Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigCreate(TextEmbeddingInferenceOptions textEmbeddingInferenceOptions) => Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigCreate.TextEmbedding(textEmbeddingInferenceOptions); } @@ -79,6 +81,9 @@ public TextEmbeddingInferenceOptionsDescriptor() : base() private Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? TokenizationValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfigDescriptor TokenizationDescriptor { get; set; } private Action TokenizationDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.MachineLearning.Vocabulary VocabularyValue { get; set; } + private Elastic.Clients.Elasticsearch.MachineLearning.VocabularyDescriptor VocabularyDescriptor { get; set; } + private Action VocabularyDescriptorAction { get; set; } /// /// @@ -131,6 +136,30 @@ public TextEmbeddingInferenceOptionsDescriptor Tokenization(Action configure) + { + VocabularyValue = null; + VocabularyDescriptor = null; + VocabularyDescriptorAction = configure; + return Self; + } + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); @@ -162,6 +191,22 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, TokenizationValue, options); } + if (VocabularyDescriptor is not null) + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, VocabularyDescriptor, options); + } + else if (VocabularyDescriptorAction is not null) + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.VocabularyDescriptor(VocabularyDescriptorAction), options); + } + else + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, VocabularyValue, options); + } + writer.WriteEndObject(); } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs index c0184e60758..9f4c5398307 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TextExpansionInferenceOptions.g.cs @@ -49,6 +49,8 @@ public sealed partial class TextExpansionInferenceOptions /// [JsonInclude, JsonPropertyName("tokenization")] public Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? Tokenization { get; set; } + [JsonInclude, JsonPropertyName("vocabulary")] + public Elastic.Clients.Elasticsearch.MachineLearning.Vocabulary Vocabulary { get; set; } public static implicit operator Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigCreate(TextExpansionInferenceOptions textExpansionInferenceOptions) => Elastic.Clients.Elasticsearch.MachineLearning.InferenceConfigCreate.TextExpansion(textExpansionInferenceOptions); } @@ -70,6 +72,9 @@ public TextExpansionInferenceOptionsDescriptor() : base() private Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfig? TokenizationValue { get; set; } private Elastic.Clients.Elasticsearch.MachineLearning.TokenizationConfigDescriptor TokenizationDescriptor { get; set; } private Action TokenizationDescriptorAction { get; set; } + private Elastic.Clients.Elasticsearch.MachineLearning.Vocabulary VocabularyValue { get; set; } + private Elastic.Clients.Elasticsearch.MachineLearning.VocabularyDescriptor VocabularyDescriptor { get; set; } + private Action VocabularyDescriptorAction { get; set; } /// /// @@ -111,6 +116,30 @@ public TextExpansionInferenceOptionsDescriptor Tokenization(Action configure) + { + VocabularyValue = null; + VocabularyDescriptor = null; + VocabularyDescriptorAction = configure; + return Self; + } + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { writer.WriteStartObject(); @@ -136,6 +165,22 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, TokenizationValue, options); } + if (VocabularyDescriptor is not null) + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, VocabularyDescriptor, options); + } + else if (VocabularyDescriptorAction is not null) + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, new Elastic.Clients.Elasticsearch.MachineLearning.VocabularyDescriptor(VocabularyDescriptorAction), options); + } + else + { + writer.WritePropertyName("vocabulary"); + JsonSerializer.Serialize(writer, VocabularyValue, options); + } + writer.WriteEndObject(); } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TokenizationConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TokenizationConfig.g.cs index 9b0056364e7..e3dc630aebf 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TokenizationConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TokenizationConfig.g.cs @@ -52,6 +52,7 @@ internal TokenizationConfig(string variantName, object variant) internal string VariantName { get; } public static TokenizationConfig Bert(Elastic.Clients.Elasticsearch.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => new TokenizationConfig("bert", nlpBertTokenizationConfig); + public static TokenizationConfig BertJa(Elastic.Clients.Elasticsearch.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => new TokenizationConfig("bert_ja", nlpBertTokenizationConfig); public static TokenizationConfig Mpnet(Elastic.Clients.Elasticsearch.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => new TokenizationConfig("mpnet", nlpBertTokenizationConfig); public static TokenizationConfig Roberta(Elastic.Clients.Elasticsearch.MachineLearning.NlpRobertaTokenizationConfig nlpRobertaTokenizationConfig) => new TokenizationConfig("roberta", nlpRobertaTokenizationConfig); @@ -100,6 +101,13 @@ public override TokenizationConfig Read(ref Utf8JsonReader reader, Type typeToCo continue; } + if (propertyName == "bert_ja") + { + variantValue = JsonSerializer.Deserialize(ref reader, options); + variantNameValue = propertyName; + continue; + } + if (propertyName == "mpnet") { variantValue = JsonSerializer.Deserialize(ref reader, options); @@ -132,6 +140,9 @@ public override void Write(Utf8JsonWriter writer, TokenizationConfig value, Json case "bert": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.MachineLearning.NlpBertTokenizationConfig)value.Variant, options); break; + case "bert_ja": + JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.MachineLearning.NlpBertTokenizationConfig)value.Variant, options); + break; case "mpnet": JsonSerializer.Serialize(writer, (Elastic.Clients.Elasticsearch.MachineLearning.NlpBertTokenizationConfig)value.Variant, options); break; @@ -178,6 +189,8 @@ private TokenizationConfigDescriptor Set(object variant, string varia public TokenizationConfigDescriptor Bert(Elastic.Clients.Elasticsearch.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => Set(nlpBertTokenizationConfig, "bert"); public TokenizationConfigDescriptor Bert(Action configure) => Set(configure, "bert"); + public TokenizationConfigDescriptor BertJa(Elastic.Clients.Elasticsearch.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => Set(nlpBertTokenizationConfig, "bert_ja"); + public TokenizationConfigDescriptor BertJa(Action configure) => Set(configure, "bert_ja"); public TokenizationConfigDescriptor Mpnet(Elastic.Clients.Elasticsearch.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => Set(nlpBertTokenizationConfig, "mpnet"); public TokenizationConfigDescriptor Mpnet(Action configure) => Set(configure, "mpnet"); public TokenizationConfigDescriptor Roberta(Elastic.Clients.Elasticsearch.MachineLearning.NlpRobertaTokenizationConfig nlpRobertaTokenizationConfig) => Set(nlpRobertaTokenizationConfig, "roberta"); @@ -236,6 +249,8 @@ private TokenizationConfigDescriptor Set(object variant, string variantName) public TokenizationConfigDescriptor Bert(Elastic.Clients.Elasticsearch.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => Set(nlpBertTokenizationConfig, "bert"); public TokenizationConfigDescriptor Bert(Action configure) => Set(configure, "bert"); + public TokenizationConfigDescriptor BertJa(Elastic.Clients.Elasticsearch.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => Set(nlpBertTokenizationConfig, "bert_ja"); + public TokenizationConfigDescriptor BertJa(Action configure) => Set(configure, "bert_ja"); public TokenizationConfigDescriptor Mpnet(Elastic.Clients.Elasticsearch.MachineLearning.NlpBertTokenizationConfig nlpBertTokenizationConfig) => Set(nlpBertTokenizationConfig, "mpnet"); public TokenizationConfigDescriptor Mpnet(Action configure) => Set(configure, "mpnet"); public TokenizationConfigDescriptor Roberta(Elastic.Clients.Elasticsearch.MachineLearning.NlpRobertaTokenizationConfig nlpRobertaTokenizationConfig) => Set(nlpRobertaTokenizationConfig, "roberta"); diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs index 9f78ed9ab12..d32ae7d74e4 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignment.g.cs @@ -29,6 +29,9 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelAssignment { + [JsonInclude, JsonPropertyName("adaptive_allocations")] + public Elastic.Clients.Elasticsearch.MachineLearning.AdaptiveAllocationsSettings? AdaptiveAllocations { get; init; } + /// /// /// The overall assignment state. @@ -38,6 +41,8 @@ public sealed partial class TrainedModelAssignment public Elastic.Clients.Elasticsearch.MachineLearning.DeploymentAssignmentState AssignmentState { get; init; } [JsonInclude, JsonPropertyName("max_assigned_allocations")] public int? MaxAssignedAllocations { get; init; } + [JsonInclude, JsonPropertyName("reason")] + public string? Reason { get; init; } /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs index c058b16e852..c9dea667748 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentRoutingTable.g.cs @@ -44,7 +44,7 @@ public sealed partial class TrainedModelAssignmentRoutingTable /// /// [JsonInclude, JsonPropertyName("reason")] - public string Reason { get; init; } + public string? Reason { get; init; } /// /// diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs index 064ca46487f..7bcdb74834d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelAssignmentTaskParameters.g.cs @@ -35,7 +35,7 @@ public sealed partial class TrainedModelAssignmentTaskParameters /// /// [JsonInclude, JsonPropertyName("cache_size")] - public Elastic.Clients.Elasticsearch.ByteSize CacheSize { get; init; } + public Elastic.Clients.Elasticsearch.ByteSize? CacheSize { get; init; } /// /// @@ -51,7 +51,7 @@ public sealed partial class TrainedModelAssignmentTaskParameters /// /// [JsonInclude, JsonPropertyName("model_bytes")] - public int ModelBytes { get; init; } + public Elastic.Clients.Elasticsearch.ByteSize ModelBytes { get; init; } /// /// @@ -68,6 +68,10 @@ public sealed partial class TrainedModelAssignmentTaskParameters /// [JsonInclude, JsonPropertyName("number_of_allocations")] public int NumberOfAllocations { get; init; } + [JsonInclude, JsonPropertyName("per_allocation_memory_bytes")] + public Elastic.Clients.Elasticsearch.ByteSize PerAllocationMemoryBytes { get; init; } + [JsonInclude, JsonPropertyName("per_deployment_memory_bytes")] + public Elastic.Clients.Elasticsearch.ByteSize PerDeploymentMemoryBytes { get; init; } [JsonInclude, JsonPropertyName("priority")] public Elastic.Clients.Elasticsearch.MachineLearning.TrainingPriority Priority { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs index 138c6aeec82..c1a941f530a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelConfig.g.cs @@ -129,6 +129,8 @@ public sealed partial class TrainedModelConfig /// [JsonInclude, JsonPropertyName("model_id")] public string ModelId { get; init; } + [JsonInclude, JsonPropertyName("model_package")] + public Elastic.Clients.Elasticsearch.MachineLearning.ModelPackageConfig? ModelPackage { get; init; } [JsonInclude, JsonPropertyName("model_size_bytes")] public Elastic.Clients.Elasticsearch.ByteSize? ModelSizeBytes { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs index 71824251d6b..e8ee05e782a 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentNodesStats.g.cs @@ -35,7 +35,17 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("average_inference_time_ms")] - public double AverageInferenceTimeMs { get; init; } + public double? AverageInferenceTimeMs { get; init; } + + /// + /// + /// The average time for each inference call to complete on this node, excluding cache + /// + /// + [JsonInclude, JsonPropertyName("average_inference_time_ms_excluding_cache_hits")] + public double? AverageInferenceTimeMsExcludingCacheHits { get; init; } + [JsonInclude, JsonPropertyName("average_inference_time_ms_last_minute")] + public double? AverageInferenceTimeMsLastMinute { get; init; } /// /// @@ -43,7 +53,11 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("error_count")] - public int ErrorCount { get; init; } + public int? ErrorCount { get; init; } + [JsonInclude, JsonPropertyName("inference_cache_hit_count")] + public long? InferenceCacheHitCount { get; init; } + [JsonInclude, JsonPropertyName("inference_cache_hit_count_last_minute")] + public long? InferenceCacheHitCountLastMinute { get; init; } /// /// @@ -51,7 +65,7 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("inference_count")] - public int InferenceCount { get; init; } + public long? InferenceCount { get; init; } /// /// @@ -59,7 +73,7 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("last_access")] - public long LastAccess { get; init; } + public long? LastAccess { get; init; } /// /// @@ -67,7 +81,7 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("node")] - public Elastic.Clients.Elasticsearch.MachineLearning.DiscoveryNode Node { get; init; } + public KeyValuePair? Node { get; init; } /// /// @@ -75,7 +89,7 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("number_of_allocations")] - public int NumberOfAllocations { get; init; } + public int? NumberOfAllocations { get; init; } /// /// @@ -83,7 +97,9 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("number_of_pending_requests")] - public int NumberOfPendingRequests { get; init; } + public int? NumberOfPendingRequests { get; init; } + [JsonInclude, JsonPropertyName("peak_throughput_per_minute")] + public long PeakThroughputPerMinute { get; init; } /// /// @@ -91,7 +107,7 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("rejection_execution_count")] - public int RejectionExecutionCount { get; init; } + public int? RejectionExecutionCount { get; init; } /// /// @@ -107,7 +123,7 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("start_time")] - public long StartTime { get; init; } + public long? StartTime { get; init; } /// /// @@ -115,7 +131,9 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("threads_per_allocation")] - public int ThreadsPerAllocation { get; init; } + public int? ThreadsPerAllocation { get; init; } + [JsonInclude, JsonPropertyName("throughput_last_minute")] + public int ThroughputLastMinute { get; init; } /// /// @@ -123,5 +141,5 @@ public sealed partial class TrainedModelDeploymentNodesStats /// /// [JsonInclude, JsonPropertyName("timeout_count")] - public int TimeoutCount { get; init; } + public int? TimeoutCount { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs index 145030816b7..80ed519735f 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/MachineLearning/TrainedModelDeploymentStats.g.cs @@ -29,13 +29,16 @@ namespace Elastic.Clients.Elasticsearch.MachineLearning; public sealed partial class TrainedModelDeploymentStats { + [JsonInclude, JsonPropertyName("adaptive_allocations")] + public Elastic.Clients.Elasticsearch.MachineLearning.AdaptiveAllocationsSettings? AdaptiveAllocations { get; init; } + /// /// /// The detailed allocation status for the deployment. /// /// [JsonInclude, JsonPropertyName("allocation_status")] - public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelDeploymentAllocationStatus AllocationStatus { get; init; } + public Elastic.Clients.Elasticsearch.MachineLearning.TrainedModelDeploymentAllocationStatus? AllocationStatus { get; init; } [JsonInclude, JsonPropertyName("cache_size")] public Elastic.Clients.Elasticsearch.ByteSize? CacheSize { get; init; } @@ -53,7 +56,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("error_count")] - public int ErrorCount { get; init; } + public int? ErrorCount { get; init; } /// /// @@ -61,7 +64,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("inference_count")] - public int InferenceCount { get; init; } + public int? InferenceCount { get; init; } /// /// @@ -86,7 +89,11 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("number_of_allocations")] - public int NumberOfAllocations { get; init; } + public int? NumberOfAllocations { get; init; } + [JsonInclude, JsonPropertyName("peak_throughput_per_minute")] + public long PeakThroughputPerMinute { get; init; } + [JsonInclude, JsonPropertyName("priority")] + public Elastic.Clients.Elasticsearch.MachineLearning.TrainingPriority Priority { get; init; } /// /// @@ -94,7 +101,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("queue_capacity")] - public int QueueCapacity { get; init; } + public int? QueueCapacity { get; init; } /// /// @@ -103,7 +110,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("reason")] - public string Reason { get; init; } + public string? Reason { get; init; } /// /// @@ -114,7 +121,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("rejected_execution_count")] - public int RejectedExecutionCount { get; init; } + public int? RejectedExecutionCount { get; init; } /// /// @@ -130,7 +137,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("state")] - public Elastic.Clients.Elasticsearch.MachineLearning.DeploymentAssignmentState State { get; init; } + public Elastic.Clients.Elasticsearch.MachineLearning.DeploymentAssignmentState? State { get; init; } /// /// @@ -138,7 +145,7 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("threads_per_allocation")] - public int ThreadsPerAllocation { get; init; } + public int? ThreadsPerAllocation { get; init; } /// /// @@ -146,5 +153,5 @@ public sealed partial class TrainedModelDeploymentStats /// /// [JsonInclude, JsonPropertyName("timeout_count")] - public int TimeoutCount { get; init; } + public int? TimeoutCount { get; init; } } \ No newline at end of file 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 9cf39e57adf..0563e2b83b6 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/PassthroughObjectProperty.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/PassthroughObjectProperty.g.cs new file mode 100644 index 00000000000..db4a8355410 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/PassthroughObjectProperty.g.cs @@ -0,0 +1,452 @@ +// 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.Mapping; + +public sealed partial class PassthroughObjectProperty : IProperty +{ + [JsonInclude, JsonPropertyName("copy_to")] + [JsonConverter(typeof(SingleOrManyFieldsConverter))] + public Elastic.Clients.Elasticsearch.Fields? CopyTo { get; set; } + [JsonInclude, JsonPropertyName("dynamic")] + public Elastic.Clients.Elasticsearch.Mapping.DynamicMapping? Dynamic { get; set; } + [JsonInclude, JsonPropertyName("enabled")] + public bool? Enabled { get; set; } + [JsonInclude, JsonPropertyName("fields")] + public Elastic.Clients.Elasticsearch.Mapping.Properties? Fields { get; set; } + [JsonInclude, JsonPropertyName("ignore_above")] + public int? IgnoreAbove { get; set; } + + /// + /// + /// Metadata about the field. + /// + /// + [JsonInclude, JsonPropertyName("meta")] + public IDictionary? Meta { get; set; } + [JsonInclude, JsonPropertyName("priority")] + public int? Priority { get; set; } + [JsonInclude, JsonPropertyName("properties")] + public Elastic.Clients.Elasticsearch.Mapping.Properties? Properties { get; set; } + [JsonInclude, JsonPropertyName("store")] + public bool? Store { get; set; } + [JsonInclude, JsonPropertyName("time_series_dimension")] + public bool? TimeSeriesDimension { get; set; } + + [JsonInclude, JsonPropertyName("type")] + public string Type => "passthrough"; +} + +public sealed partial class PassthroughObjectPropertyDescriptor : SerializableDescriptor>, IBuildableDescriptor +{ + internal PassthroughObjectPropertyDescriptor(Action> configure) => configure.Invoke(this); + + public PassthroughObjectPropertyDescriptor() : base() + { + } + + private Elastic.Clients.Elasticsearch.Fields? CopyToValue { get; set; } + private Elastic.Clients.Elasticsearch.Mapping.DynamicMapping? DynamicValue { get; set; } + private bool? EnabledValue { get; set; } + private Elastic.Clients.Elasticsearch.Mapping.Properties? FieldsValue { get; set; } + private int? IgnoreAboveValue { get; set; } + private IDictionary? MetaValue { get; set; } + private int? PriorityValue { get; set; } + private Elastic.Clients.Elasticsearch.Mapping.Properties? PropertiesValue { get; set; } + private bool? StoreValue { get; set; } + private bool? TimeSeriesDimensionValue { get; set; } + + public PassthroughObjectPropertyDescriptor CopyTo(Elastic.Clients.Elasticsearch.Fields? copyTo) + { + CopyToValue = copyTo; + return Self; + } + + public PassthroughObjectPropertyDescriptor Dynamic(Elastic.Clients.Elasticsearch.Mapping.DynamicMapping? dynamic) + { + DynamicValue = dynamic; + return Self; + } + + public PassthroughObjectPropertyDescriptor Enabled(bool? enabled = true) + { + EnabledValue = enabled; + return Self; + } + + public PassthroughObjectPropertyDescriptor Fields(Elastic.Clients.Elasticsearch.Mapping.Properties? fields) + { + FieldsValue = fields; + return Self; + } + + public PassthroughObjectPropertyDescriptor Fields(Elastic.Clients.Elasticsearch.Mapping.PropertiesDescriptor descriptor) + { + FieldsValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor Fields(Action> configure) + { + var descriptor = new Elastic.Clients.Elasticsearch.Mapping.PropertiesDescriptor(); + configure?.Invoke(descriptor); + FieldsValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor IgnoreAbove(int? ignoreAbove) + { + IgnoreAboveValue = ignoreAbove; + return Self; + } + + /// + /// + /// Metadata about the field. + /// + /// + public PassthroughObjectPropertyDescriptor Meta(Func, FluentDictionary> selector) + { + MetaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + public PassthroughObjectPropertyDescriptor Priority(int? priority) + { + PriorityValue = priority; + return Self; + } + + public PassthroughObjectPropertyDescriptor Properties(Elastic.Clients.Elasticsearch.Mapping.Properties? properties) + { + PropertiesValue = properties; + return Self; + } + + public PassthroughObjectPropertyDescriptor Properties(Elastic.Clients.Elasticsearch.Mapping.PropertiesDescriptor descriptor) + { + PropertiesValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor Properties(Action> configure) + { + var descriptor = new Elastic.Clients.Elasticsearch.Mapping.PropertiesDescriptor(); + configure?.Invoke(descriptor); + PropertiesValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor Store(bool? store = true) + { + StoreValue = store; + return Self; + } + + public PassthroughObjectPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) + { + TimeSeriesDimensionValue = timeSeriesDimension; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (CopyToValue is not null) + { + writer.WritePropertyName("copy_to"); + JsonSerializer.Serialize(writer, CopyToValue, options); + } + + if (DynamicValue is not null) + { + writer.WritePropertyName("dynamic"); + JsonSerializer.Serialize(writer, DynamicValue, options); + } + + if (EnabledValue.HasValue) + { + writer.WritePropertyName("enabled"); + writer.WriteBooleanValue(EnabledValue.Value); + } + + if (FieldsValue is not null) + { + writer.WritePropertyName("fields"); + JsonSerializer.Serialize(writer, FieldsValue, options); + } + + if (IgnoreAboveValue.HasValue) + { + writer.WritePropertyName("ignore_above"); + writer.WriteNumberValue(IgnoreAboveValue.Value); + } + + if (MetaValue is not null) + { + writer.WritePropertyName("meta"); + JsonSerializer.Serialize(writer, MetaValue, options); + } + + if (PriorityValue.HasValue) + { + writer.WritePropertyName("priority"); + writer.WriteNumberValue(PriorityValue.Value); + } + + if (PropertiesValue is not null) + { + writer.WritePropertyName("properties"); + JsonSerializer.Serialize(writer, PropertiesValue, options); + } + + if (StoreValue.HasValue) + { + writer.WritePropertyName("store"); + writer.WriteBooleanValue(StoreValue.Value); + } + + if (TimeSeriesDimensionValue.HasValue) + { + writer.WritePropertyName("time_series_dimension"); + writer.WriteBooleanValue(TimeSeriesDimensionValue.Value); + } + + writer.WritePropertyName("type"); + writer.WriteStringValue("passthrough"); + writer.WriteEndObject(); + } + + PassthroughObjectProperty IBuildableDescriptor.Build() => new() + { + CopyTo = CopyToValue, + Dynamic = DynamicValue, + Enabled = EnabledValue, + Fields = FieldsValue, + IgnoreAbove = IgnoreAboveValue, + Meta = MetaValue, + Priority = PriorityValue, + Properties = PropertiesValue, + Store = StoreValue, + TimeSeriesDimension = TimeSeriesDimensionValue + }; +} + +public sealed partial class PassthroughObjectPropertyDescriptor : SerializableDescriptor, IBuildableDescriptor +{ + internal PassthroughObjectPropertyDescriptor(Action configure) => configure.Invoke(this); + + public PassthroughObjectPropertyDescriptor() : base() + { + } + + private Elastic.Clients.Elasticsearch.Fields? CopyToValue { get; set; } + private Elastic.Clients.Elasticsearch.Mapping.DynamicMapping? DynamicValue { get; set; } + private bool? EnabledValue { get; set; } + private Elastic.Clients.Elasticsearch.Mapping.Properties? FieldsValue { get; set; } + private int? IgnoreAboveValue { get; set; } + private IDictionary? MetaValue { get; set; } + private int? PriorityValue { get; set; } + private Elastic.Clients.Elasticsearch.Mapping.Properties? PropertiesValue { get; set; } + private bool? StoreValue { get; set; } + private bool? TimeSeriesDimensionValue { get; set; } + + public PassthroughObjectPropertyDescriptor CopyTo(Elastic.Clients.Elasticsearch.Fields? copyTo) + { + CopyToValue = copyTo; + return Self; + } + + public PassthroughObjectPropertyDescriptor Dynamic(Elastic.Clients.Elasticsearch.Mapping.DynamicMapping? dynamic) + { + DynamicValue = dynamic; + return Self; + } + + public PassthroughObjectPropertyDescriptor Enabled(bool? enabled = true) + { + EnabledValue = enabled; + return Self; + } + + public PassthroughObjectPropertyDescriptor Fields(Elastic.Clients.Elasticsearch.Mapping.Properties? fields) + { + FieldsValue = fields; + return Self; + } + + public PassthroughObjectPropertyDescriptor Fields(Elastic.Clients.Elasticsearch.Mapping.PropertiesDescriptor descriptor) + { + FieldsValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor Fields(Action> configure) + { + var descriptor = new Elastic.Clients.Elasticsearch.Mapping.PropertiesDescriptor(); + configure?.Invoke(descriptor); + FieldsValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor IgnoreAbove(int? ignoreAbove) + { + IgnoreAboveValue = ignoreAbove; + return Self; + } + + /// + /// + /// Metadata about the field. + /// + /// + public PassthroughObjectPropertyDescriptor Meta(Func, FluentDictionary> selector) + { + MetaValue = selector?.Invoke(new FluentDictionary()); + return Self; + } + + public PassthroughObjectPropertyDescriptor Priority(int? priority) + { + PriorityValue = priority; + return Self; + } + + public PassthroughObjectPropertyDescriptor Properties(Elastic.Clients.Elasticsearch.Mapping.Properties? properties) + { + PropertiesValue = properties; + return Self; + } + + public PassthroughObjectPropertyDescriptor Properties(Elastic.Clients.Elasticsearch.Mapping.PropertiesDescriptor descriptor) + { + PropertiesValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor Properties(Action> configure) + { + var descriptor = new Elastic.Clients.Elasticsearch.Mapping.PropertiesDescriptor(); + configure?.Invoke(descriptor); + PropertiesValue = descriptor.PromisedValue; + return Self; + } + + public PassthroughObjectPropertyDescriptor Store(bool? store = true) + { + StoreValue = store; + return Self; + } + + public PassthroughObjectPropertyDescriptor TimeSeriesDimension(bool? timeSeriesDimension = true) + { + TimeSeriesDimensionValue = timeSeriesDimension; + return Self; + } + + protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) + { + writer.WriteStartObject(); + if (CopyToValue is not null) + { + writer.WritePropertyName("copy_to"); + JsonSerializer.Serialize(writer, CopyToValue, options); + } + + if (DynamicValue is not null) + { + writer.WritePropertyName("dynamic"); + JsonSerializer.Serialize(writer, DynamicValue, options); + } + + if (EnabledValue.HasValue) + { + writer.WritePropertyName("enabled"); + writer.WriteBooleanValue(EnabledValue.Value); + } + + if (FieldsValue is not null) + { + writer.WritePropertyName("fields"); + JsonSerializer.Serialize(writer, FieldsValue, options); + } + + if (IgnoreAboveValue.HasValue) + { + writer.WritePropertyName("ignore_above"); + writer.WriteNumberValue(IgnoreAboveValue.Value); + } + + if (MetaValue is not null) + { + writer.WritePropertyName("meta"); + JsonSerializer.Serialize(writer, MetaValue, options); + } + + if (PriorityValue.HasValue) + { + writer.WritePropertyName("priority"); + writer.WriteNumberValue(PriorityValue.Value); + } + + if (PropertiesValue is not null) + { + writer.WritePropertyName("properties"); + JsonSerializer.Serialize(writer, PropertiesValue, options); + } + + if (StoreValue.HasValue) + { + writer.WritePropertyName("store"); + writer.WriteBooleanValue(StoreValue.Value); + } + + if (TimeSeriesDimensionValue.HasValue) + { + writer.WritePropertyName("time_series_dimension"); + writer.WriteBooleanValue(TimeSeriesDimensionValue.Value); + } + + writer.WritePropertyName("type"); + writer.WriteStringValue("passthrough"); + writer.WriteEndObject(); + } + + PassthroughObjectProperty IBuildableDescriptor.Build() => new() + { + CopyTo = CopyToValue, + Dynamic = DynamicValue, + Enabled = EnabledValue, + Fields = FieldsValue, + IgnoreAbove = IgnoreAboveValue, + Meta = MetaValue, + Priority = PriorityValue, + Properties = PropertiesValue, + Store = StoreValue, + TimeSeriesDimension = TimeSeriesDimensionValue + }; +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/Properties.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/Properties.g.cs index 9cf52241069..b3b3c49457d 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/Properties.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Mapping/Properties.g.cs @@ -236,6 +236,11 @@ public PropertiesDescriptor() : base(new Properties()) public PropertiesDescriptor Object(Elastic.Clients.Elasticsearch.PropertyName propertyName, ObjectProperty objectProperty) => AssignVariant(propertyName, objectProperty); public PropertiesDescriptor Object(Expression> propertyName) => AssignVariant, ObjectProperty>(propertyName, null); public PropertiesDescriptor Object(Expression> propertyName, Action> configure) => AssignVariant, ObjectProperty>(propertyName, configure); + public PropertiesDescriptor PassthroughObject(Elastic.Clients.Elasticsearch.PropertyName propertyName) => AssignVariant, PassthroughObjectProperty>(propertyName, null); + public PropertiesDescriptor PassthroughObject(Elastic.Clients.Elasticsearch.PropertyName propertyName, Action> configure) => AssignVariant, PassthroughObjectProperty>(propertyName, configure); + public PropertiesDescriptor PassthroughObject(Elastic.Clients.Elasticsearch.PropertyName propertyName, PassthroughObjectProperty passthroughObjectProperty) => AssignVariant(propertyName, passthroughObjectProperty); + public PropertiesDescriptor PassthroughObject(Expression> propertyName) => AssignVariant, PassthroughObjectProperty>(propertyName, null); + public PropertiesDescriptor PassthroughObject(Expression> propertyName, Action> configure) => AssignVariant, PassthroughObjectProperty>(propertyName, configure); public PropertiesDescriptor Percolator(Elastic.Clients.Elasticsearch.PropertyName propertyName) => AssignVariant, PercolatorProperty>(propertyName, null); public PropertiesDescriptor Percolator(Elastic.Clients.Elasticsearch.PropertyName propertyName, Action> configure) => AssignVariant, PercolatorProperty>(propertyName, configure); public PropertiesDescriptor Percolator(Elastic.Clients.Elasticsearch.PropertyName propertyName, PercolatorProperty percolatorProperty) => AssignVariant(propertyName, percolatorProperty); @@ -395,6 +400,8 @@ public override IProperty Read(ref Utf8JsonReader reader, Type typeToConvert, Js return JsonSerializer.Deserialize(ref reader, options); case "object": return JsonSerializer.Deserialize(ref reader, options); + case "passthrough": + return JsonSerializer.Deserialize(ref reader, options); case "percolator": return JsonSerializer.Deserialize(ref reader, options); case "point": @@ -542,6 +549,9 @@ public override void Write(Utf8JsonWriter writer, IProperty value, JsonSerialize case "object": JsonSerializer.Serialize(writer, value, typeof(Elastic.Clients.Elasticsearch.Mapping.ObjectProperty), options); return; + case "passthrough": + JsonSerializer.Serialize(writer, value, typeof(Elastic.Clients.Elasticsearch.Mapping.PassthroughObjectProperty), options); + return; case "percolator": JsonSerializer.Serialize(writer, value, typeof(Elastic.Clients.Elasticsearch.Mapping.PercolatorProperty), options); return; 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 85c4315328f..746ae77f100 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/Nodes/NodeInfoPath.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeInfoPath.g.cs index 036a1efba08..d80db597c5b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeInfoPath.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Nodes/NodeInfoPath.g.cs @@ -30,6 +30,7 @@ namespace Elastic.Clients.Elasticsearch.Nodes; public sealed partial class NodeInfoPath { [JsonInclude, JsonPropertyName("data")] + [SingleOrManyCollectionConverter(typeof(string))] public IReadOnlyCollection? Data { get; init; } [JsonInclude, JsonPropertyName("home")] public string? Home { get; init; } diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateRangeQuery.g.cs index a5616c21d2d..537b0a37d46 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/DateRangeQuery.g.cs @@ -54,12 +54,6 @@ public override DateRangeQuery Read(ref Utf8JsonReader reader, Type typeToConver continue; } - if (property == "from") - { - variant.From = JsonSerializer.Deserialize(ref reader, options); - continue; - } - if (property == "gt") { variant.Gt = JsonSerializer.Deserialize(ref reader, options); @@ -101,12 +95,6 @@ public override DateRangeQuery Read(ref Utf8JsonReader reader, Type typeToConver variant.TimeZone = JsonSerializer.Deserialize(ref reader, options); continue; } - - if (property == "to") - { - variant.To = JsonSerializer.Deserialize(ref reader, options); - continue; - } } } @@ -135,12 +123,6 @@ public override void Write(Utf8JsonWriter writer, DateRangeQuery value, JsonSeri writer.WriteStringValue(value.Format); } - if (value.From is not null) - { - writer.WritePropertyName("from"); - JsonSerializer.Serialize(writer, value.From, options); - } - if (value.Gt is not null) { writer.WritePropertyName("gt"); @@ -183,12 +165,6 @@ public override void Write(Utf8JsonWriter writer, DateRangeQuery value, JsonSeri writer.WriteStringValue(value.TimeZone); } - if (value.To is not null) - { - writer.WritePropertyName("to"); - JsonSerializer.Serialize(writer, value.To, options); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -221,7 +197,6 @@ public DateRangeQuery(Elastic.Clients.Elasticsearch.Field field) /// /// public string? Format { get; set; } - public Elastic.Clients.Elasticsearch.DateMath? From { get; set; } /// /// @@ -265,7 +240,6 @@ public DateRangeQuery(Elastic.Clients.Elasticsearch.Field field) /// /// public string? TimeZone { get; set; } - public Elastic.Clients.Elasticsearch.DateMath? To { get; set; } } public sealed partial class DateRangeQueryDescriptor : SerializableDescriptor> @@ -279,7 +253,6 @@ public DateRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } private string? FormatValue { get; set; } - private Elastic.Clients.Elasticsearch.DateMath? FromValue { get; set; } private Elastic.Clients.Elasticsearch.DateMath? GtValue { get; set; } private Elastic.Clients.Elasticsearch.DateMath? GteValue { get; set; } private Elastic.Clients.Elasticsearch.DateMath? LtValue { get; set; } @@ -287,7 +260,6 @@ public DateRangeQueryDescriptor() : base() private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? RelationValue { get; set; } private string? TimeZoneValue { get; set; } - private Elastic.Clients.Elasticsearch.DateMath? ToValue { get; set; } /// /// @@ -332,12 +304,6 @@ public DateRangeQueryDescriptor Format(string? format) return Self; } - public DateRangeQueryDescriptor From(Elastic.Clients.Elasticsearch.DateMath? from) - { - FromValue = from; - return Self; - } - /// /// /// Greater than. @@ -410,12 +376,6 @@ public DateRangeQueryDescriptor TimeZone(string? timeZone) return Self; } - public DateRangeQueryDescriptor To(Elastic.Clients.Elasticsearch.DateMath? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -435,12 +395,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(FormatValue); } - if (FromValue is not null) - { - writer.WritePropertyName("from"); - JsonSerializer.Serialize(writer, FromValue, options); - } - if (GtValue is not null) { writer.WritePropertyName("gt"); @@ -483,12 +437,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(TimeZoneValue); } - if (ToValue is not null) - { - writer.WritePropertyName("to"); - JsonSerializer.Serialize(writer, ToValue, options); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -505,7 +453,6 @@ public DateRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } private string? FormatValue { get; set; } - private Elastic.Clients.Elasticsearch.DateMath? FromValue { get; set; } private Elastic.Clients.Elasticsearch.DateMath? GtValue { get; set; } private Elastic.Clients.Elasticsearch.DateMath? GteValue { get; set; } private Elastic.Clients.Elasticsearch.DateMath? LtValue { get; set; } @@ -513,7 +460,6 @@ public DateRangeQueryDescriptor() : base() private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? RelationValue { get; set; } private string? TimeZoneValue { get; set; } - private Elastic.Clients.Elasticsearch.DateMath? ToValue { get; set; } /// /// @@ -558,12 +504,6 @@ public DateRangeQueryDescriptor Format(string? format) return Self; } - public DateRangeQueryDescriptor From(Elastic.Clients.Elasticsearch.DateMath? from) - { - FromValue = from; - return Self; - } - /// /// /// Greater than. @@ -636,12 +576,6 @@ public DateRangeQueryDescriptor TimeZone(string? timeZone) return Self; } - public DateRangeQueryDescriptor To(Elastic.Clients.Elasticsearch.DateMath? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -661,12 +595,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(FormatValue); } - if (FromValue is not null) - { - writer.WritePropertyName("from"); - JsonSerializer.Serialize(writer, FromValue, options); - } - if (GtValue is not null) { writer.WritePropertyName("gt"); @@ -709,12 +637,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(TimeZoneValue); } - if (ToValue is not null) - { - writer.WritePropertyName("to"); - JsonSerializer.Serialize(writer, ToValue, options); - } - writer.WriteEndObject(); writer.WriteEndObject(); } 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 7fe667bd3bb..f175c27f412 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/NumberRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs index f9d5f0d2b2d..cfbc2a0079e 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/NumberRangeQuery.g.cs @@ -48,12 +48,6 @@ public override NumberRangeQuery Read(ref Utf8JsonReader reader, Type typeToConv continue; } - if (property == "from") - { - variant.From = JsonSerializer.Deserialize(ref reader, options); - continue; - } - if (property == "gt") { variant.Gt = JsonSerializer.Deserialize(ref reader, options); @@ -89,12 +83,6 @@ public override NumberRangeQuery Read(ref Utf8JsonReader reader, Type typeToConv variant.Relation = JsonSerializer.Deserialize(ref reader, options); continue; } - - if (property == "to") - { - variant.To = JsonSerializer.Deserialize(ref reader, options); - continue; - } } } @@ -117,12 +105,6 @@ public override void Write(Utf8JsonWriter writer, NumberRangeQuery value, JsonSe writer.WriteNumberValue(value.Boost.Value); } - if (value.From.HasValue) - { - writer.WritePropertyName("from"); - writer.WriteNumberValue(value.From.Value); - } - if (value.Gt.HasValue) { writer.WritePropertyName("gt"); @@ -159,12 +141,6 @@ public override void Write(Utf8JsonWriter writer, NumberRangeQuery value, JsonSe JsonSerializer.Serialize(writer, value.Relation, options); } - if (value.To.HasValue) - { - writer.WritePropertyName("to"); - writer.WriteNumberValue(value.To.Value); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -190,7 +166,6 @@ public NumberRangeQuery(Elastic.Clients.Elasticsearch.Field field) /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } - public double? From { get; set; } /// /// @@ -227,7 +202,6 @@ public NumberRangeQuery(Elastic.Clients.Elasticsearch.Field field) /// /// public Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? Relation { get; set; } - public double? To { get; set; } } public sealed partial class NumberRangeQueryDescriptor : SerializableDescriptor> @@ -240,14 +214,12 @@ public NumberRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } - private double? FromValue { get; set; } private double? GtValue { get; set; } private double? GteValue { get; set; } private double? LtValue { get; set; } private double? LteValue { get; set; } private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? RelationValue { get; set; } - private double? ToValue { get; set; } /// /// @@ -281,12 +253,6 @@ public NumberRangeQueryDescriptor Field(Expression From(double? from) - { - FromValue = from; - return Self; - } - /// /// /// Greater than. @@ -348,12 +314,6 @@ public NumberRangeQueryDescriptor Relation(Elastic.Clients.Elasticsea return Self; } - public NumberRangeQueryDescriptor To(double? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -367,12 +327,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(BoostValue.Value); } - if (FromValue.HasValue) - { - writer.WritePropertyName("from"); - writer.WriteNumberValue(FromValue.Value); - } - if (GtValue.HasValue) { writer.WritePropertyName("gt"); @@ -409,12 +363,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, RelationValue, options); } - if (ToValue.HasValue) - { - writer.WritePropertyName("to"); - writer.WriteNumberValue(ToValue.Value); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -430,14 +378,12 @@ public NumberRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } - private double? FromValue { get; set; } private double? GtValue { get; set; } private double? GteValue { get; set; } private double? LtValue { get; set; } private double? LteValue { get; set; } private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? RelationValue { get; set; } - private double? ToValue { get; set; } /// /// @@ -471,12 +417,6 @@ public NumberRangeQueryDescriptor Field(Expression /// /// Greater than. @@ -538,12 +478,6 @@ public NumberRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryDs return Self; } - public NumberRangeQueryDescriptor To(double? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -557,12 +491,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(BoostValue.Value); } - if (FromValue.HasValue) - { - writer.WritePropertyName("from"); - writer.WriteNumberValue(FromValue.Value); - } - if (GtValue.HasValue) { writer.WritePropertyName("gt"); @@ -599,12 +527,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, RelationValue, options); } - if (ToValue.HasValue) - { - writer.WritePropertyName("to"); - writer.WriteNumberValue(ToValue.Value); - } - writer.WriteEndObject(); writer.WriteEndObject(); } 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 2413f3deea1..35c8ba75904 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/TermRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermRangeQuery.g.cs index 71f3ccffc82..5e175e78f1b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/TermRangeQuery.g.cs @@ -48,12 +48,6 @@ public override TermRangeQuery Read(ref Utf8JsonReader reader, Type typeToConver continue; } - if (property == "from") - { - variant.From = JsonSerializer.Deserialize(ref reader, options); - continue; - } - if (property == "gt") { variant.Gt = JsonSerializer.Deserialize(ref reader, options); @@ -89,12 +83,6 @@ public override TermRangeQuery Read(ref Utf8JsonReader reader, Type typeToConver variant.Relation = JsonSerializer.Deserialize(ref reader, options); continue; } - - if (property == "to") - { - variant.To = JsonSerializer.Deserialize(ref reader, options); - continue; - } } } @@ -117,12 +105,6 @@ public override void Write(Utf8JsonWriter writer, TermRangeQuery value, JsonSeri writer.WriteNumberValue(value.Boost.Value); } - if (!string.IsNullOrEmpty(value.From)) - { - writer.WritePropertyName("from"); - writer.WriteStringValue(value.From); - } - if (!string.IsNullOrEmpty(value.Gt)) { writer.WritePropertyName("gt"); @@ -159,12 +141,6 @@ public override void Write(Utf8JsonWriter writer, TermRangeQuery value, JsonSeri JsonSerializer.Serialize(writer, value.Relation, options); } - if (!string.IsNullOrEmpty(value.To)) - { - writer.WritePropertyName("to"); - writer.WriteStringValue(value.To); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -190,7 +166,6 @@ public TermRangeQuery(Elastic.Clients.Elasticsearch.Field field) /// public float? Boost { get; set; } public Elastic.Clients.Elasticsearch.Field Field { get; set; } - public string? From { get; set; } /// /// @@ -227,7 +202,6 @@ public TermRangeQuery(Elastic.Clients.Elasticsearch.Field field) /// /// public Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? Relation { get; set; } - public string? To { get; set; } } public sealed partial class TermRangeQueryDescriptor : SerializableDescriptor> @@ -240,14 +214,12 @@ public TermRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } - private string? FromValue { get; set; } private string? GtValue { get; set; } private string? GteValue { get; set; } private string? LtValue { get; set; } private string? LteValue { get; set; } private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? RelationValue { get; set; } - private string? ToValue { get; set; } /// /// @@ -281,12 +253,6 @@ public TermRangeQueryDescriptor Field(Expression From(string? from) - { - FromValue = from; - return Self; - } - /// /// /// Greater than. @@ -348,12 +314,6 @@ public TermRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearc return Self; } - public TermRangeQueryDescriptor To(string? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -367,12 +327,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(BoostValue.Value); } - if (!string.IsNullOrEmpty(FromValue)) - { - writer.WritePropertyName("from"); - writer.WriteStringValue(FromValue); - } - if (!string.IsNullOrEmpty(GtValue)) { writer.WritePropertyName("gt"); @@ -409,12 +363,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, RelationValue, options); } - if (!string.IsNullOrEmpty(ToValue)) - { - writer.WritePropertyName("to"); - writer.WriteStringValue(ToValue); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -430,14 +378,12 @@ public TermRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } - private string? FromValue { get; set; } private string? GtValue { get; set; } private string? GteValue { get; set; } private string? LtValue { get; set; } private string? LteValue { get; set; } private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? RelationValue { get; set; } - private string? ToValue { get; set; } /// /// @@ -471,12 +417,6 @@ public TermRangeQueryDescriptor Field(Expression /// /// Greater than. @@ -538,12 +478,6 @@ public TermRangeQueryDescriptor Relation(Elastic.Clients.Elasticsearch.QueryDsl. return Self; } - public TermRangeQueryDescriptor To(string? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -557,12 +491,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteNumberValue(BoostValue.Value); } - if (!string.IsNullOrEmpty(FromValue)) - { - writer.WritePropertyName("from"); - writer.WriteStringValue(FromValue); - } - if (!string.IsNullOrEmpty(GtValue)) { writer.WritePropertyName("gt"); @@ -599,12 +527,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o JsonSerializer.Serialize(writer, RelationValue, options); } - if (!string.IsNullOrEmpty(ToValue)) - { - writer.WritePropertyName("to"); - writer.WriteStringValue(ToValue); - } - writer.WriteEndObject(); writer.WriteEndObject(); } 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 d3e4b3079ad..a56cf458603 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 abe905037fd..00000000000 --- 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/UntypedRangeQuery.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs index 3a45d04d350..582463372a6 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryDsl/UntypedRangeQuery.g.cs @@ -54,12 +54,6 @@ public override UntypedRangeQuery Read(ref Utf8JsonReader reader, Type typeToCon continue; } - if (property == "from") - { - variant.From = JsonSerializer.Deserialize(ref reader, options); - continue; - } - if (property == "gt") { variant.Gt = JsonSerializer.Deserialize(ref reader, options); @@ -101,12 +95,6 @@ public override UntypedRangeQuery Read(ref Utf8JsonReader reader, Type typeToCon variant.TimeZone = JsonSerializer.Deserialize(ref reader, options); continue; } - - if (property == "to") - { - variant.To = JsonSerializer.Deserialize(ref reader, options); - continue; - } } } @@ -135,12 +123,6 @@ public override void Write(Utf8JsonWriter writer, UntypedRangeQuery value, JsonS writer.WriteStringValue(value.Format); } - if (value.From is not null) - { - writer.WritePropertyName("from"); - JsonSerializer.Serialize(writer, value.From, options); - } - if (value.Gt is not null) { writer.WritePropertyName("gt"); @@ -183,12 +165,6 @@ public override void Write(Utf8JsonWriter writer, UntypedRangeQuery value, JsonS writer.WriteStringValue(value.TimeZone); } - if (value.To is not null) - { - writer.WritePropertyName("to"); - JsonSerializer.Serialize(writer, value.To, options); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -221,7 +197,6 @@ public UntypedRangeQuery(Elastic.Clients.Elasticsearch.Field field) /// /// public string? Format { get; set; } - public object? From { get; set; } /// /// @@ -265,7 +240,6 @@ public UntypedRangeQuery(Elastic.Clients.Elasticsearch.Field field) /// /// public string? TimeZone { get; set; } - public object? To { get; set; } } public sealed partial class UntypedRangeQueryDescriptor : SerializableDescriptor> @@ -279,7 +253,6 @@ public UntypedRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } private string? FormatValue { get; set; } - private object? FromValue { get; set; } private object? GtValue { get; set; } private object? GteValue { get; set; } private object? LtValue { get; set; } @@ -287,7 +260,6 @@ public UntypedRangeQueryDescriptor() : base() private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? RelationValue { get; set; } private string? TimeZoneValue { get; set; } - private object? ToValue { get; set; } /// /// @@ -332,12 +304,6 @@ public UntypedRangeQueryDescriptor Format(string? format) return Self; } - public UntypedRangeQueryDescriptor From(object? from) - { - FromValue = from; - return Self; - } - /// /// /// Greater than. @@ -410,12 +376,6 @@ public UntypedRangeQueryDescriptor TimeZone(string? timeZone) return Self; } - public UntypedRangeQueryDescriptor To(object? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -435,12 +395,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(FormatValue); } - if (FromValue is not null) - { - writer.WritePropertyName("from"); - JsonSerializer.Serialize(writer, FromValue, options); - } - if (GtValue is not null) { writer.WritePropertyName("gt"); @@ -483,12 +437,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(TimeZoneValue); } - if (ToValue is not null) - { - writer.WritePropertyName("to"); - JsonSerializer.Serialize(writer, ToValue, options); - } - writer.WriteEndObject(); writer.WriteEndObject(); } @@ -505,7 +453,6 @@ public UntypedRangeQueryDescriptor() : base() private float? BoostValue { get; set; } private Elastic.Clients.Elasticsearch.Field FieldValue { get; set; } private string? FormatValue { get; set; } - private object? FromValue { get; set; } private object? GtValue { get; set; } private object? GteValue { get; set; } private object? LtValue { get; set; } @@ -513,7 +460,6 @@ public UntypedRangeQueryDescriptor() : base() private string? QueryNameValue { get; set; } private Elastic.Clients.Elasticsearch.QueryDsl.RangeRelation? RelationValue { get; set; } private string? TimeZoneValue { get; set; } - private object? ToValue { get; set; } /// /// @@ -558,12 +504,6 @@ public UntypedRangeQueryDescriptor Format(string? format) return Self; } - public UntypedRangeQueryDescriptor From(object? from) - { - FromValue = from; - return Self; - } - /// /// /// Greater than. @@ -636,12 +576,6 @@ public UntypedRangeQueryDescriptor TimeZone(string? timeZone) return Self; } - public UntypedRangeQueryDescriptor To(object? to) - { - ToValue = to; - return Self; - } - protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) { if (FieldValue is null) @@ -661,12 +595,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(FormatValue); } - if (FromValue is not null) - { - writer.WritePropertyName("from"); - JsonSerializer.Serialize(writer, FromValue, options); - } - if (GtValue is not null) { writer.WritePropertyName("gt"); @@ -709,12 +637,6 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o writer.WriteStringValue(TimeZoneValue); } - if (ToValue is not null) - { - writer.WritePropertyName("to"); - JsonSerializer.Serialize(writer, ToValue, options); - } - writer.WriteEndObject(); writer.WriteEndObject(); } 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 dccca3386fb..00000000000 --- 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/QueryRulesetListItem.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs index 92c8db94d10..b2263dece8b 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/QueryRules/QueryRulesetListItem.g.cs @@ -31,7 +31,7 @@ public sealed partial class QueryRulesetListItem { /// /// - /// A map of criteria type to the number of rules of that type + /// A map of criteria type (e.g. exact) to the number of rules of that type /// /// [JsonInclude, JsonPropertyName("rule_criteria_types_counts")] @@ -52,4 +52,12 @@ public sealed partial class QueryRulesetListItem /// [JsonInclude, JsonPropertyName("rule_total_count")] public int RuleTotalCount { get; init; } + + /// + /// + /// A map of rule type (e.g. pinned) to the number of rules of that type + /// + /// + [JsonInclude, JsonPropertyName("rule_type_counts")] + public IReadOnlyDictionary RuleTypeCounts { get; init; } } \ 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 00000000000..6fa1ac86998 --- /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 c3a1b401dab..62c90d43295 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 797fea39b66..5a79a236a6a 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 00000000000..34346cfb0ce --- /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 645430c37b4..7dc4df34f85 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 00000000000..923ead8239e --- /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 00000000000..96dc9da83d0 --- /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/ApiKey.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/ApiKey.g.cs index 472cadce332..43a5eca1ad0 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/ApiKey.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/ApiKey.g.cs @@ -29,13 +29,24 @@ namespace Elastic.Clients.Elasticsearch.Security; public sealed partial class ApiKey { + /// + /// + /// The access granted to cross-cluster API keys. + /// 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; init; } + /// /// /// Creation time for the API key in milliseconds. /// /// [JsonInclude, JsonPropertyName("creation")] - public long? Creation { get; init; } + public long Creation { get; init; } /// /// @@ -60,7 +71,15 @@ public sealed partial class ApiKey /// /// [JsonInclude, JsonPropertyName("invalidated")] - public bool? Invalidated { get; init; } + public bool Invalidated { get; init; } + + /// + /// + /// If the key has been invalidated, invalidation time in milliseconds. + /// + /// + [JsonInclude, JsonPropertyName("invalidation")] + public long? Invalidation { get; init; } /// /// @@ -78,7 +97,7 @@ public sealed partial class ApiKey /// /// [JsonInclude, JsonPropertyName("metadata")] - public IReadOnlyDictionary? Metadata { get; init; } + public IReadOnlyDictionary Metadata { get; init; } /// /// @@ -102,7 +121,7 @@ public sealed partial class ApiKey /// /// [JsonInclude, JsonPropertyName("realm")] - public string? Realm { get; init; } + public string Realm { get; init; } /// /// @@ -120,14 +139,28 @@ public sealed partial class ApiKey /// [JsonInclude, JsonPropertyName("role_descriptors")] public IReadOnlyDictionary? RoleDescriptors { get; init; } + + /// + /// + /// Sorting values when using the sort parameter with the security.query_api_keys API. + /// + /// [JsonInclude, JsonPropertyName("_sort")] public IReadOnlyCollection? Sort { get; init; } + /// + /// + /// The type of the API key (e.g. rest or cross_cluster). + /// + /// + [JsonInclude, JsonPropertyName("type")] + public Elastic.Clients.Elasticsearch.Security.ApiKeyType Type { get; init; } + /// /// /// Principal for which this API key was created /// /// [JsonInclude, JsonPropertyName("username")] - public string? Username { get; init; } + public string Username { get; init; } } \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/AuthenticateApiKey.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/AuthenticateApiKey.g.cs new file mode 100644 index 00000000000..ecd48deda3c --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/AuthenticateApiKey.g.cs @@ -0,0 +1,36 @@ +// 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 AuthenticateApiKey +{ + [JsonInclude, JsonPropertyName("id")] + public string Id { 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/Security/IndicesPrivileges.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Security/IndicesPrivileges.g.cs index 3f6062507e6..3be8e4dec8a 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 53b1d944db9..e137275de92 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 00000000000..0cdfc809bc0 --- /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 068928f43c5..61c9a3199b2 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 00000000000..6a19a68c4ce --- /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 00000000000..0f48846bd95 --- /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 052fb4203d0..feecdc34beb 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 1091a7fbe9b..3eaf8158d4c 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 6df0ea3d1de..0cbba91ee67 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 00000000000..04a4ac7ddc5 --- /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 00564aac314..5bacdaccaa6 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/Tasks/ParentTaskInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/ParentTaskInfo.g.cs index f5b0374f997..7a5aee91b59 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/ParentTaskInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/ParentTaskInfo.g.cs @@ -37,6 +37,15 @@ public sealed partial class ParentTaskInfo public bool? Cancelled { get; init; } [JsonInclude, JsonPropertyName("children")] public IReadOnlyCollection? Children { get; init; } + + /// + /// + /// Human readable text that identifies the particular request that the task is performing. + /// For example, it might identify the search request being performed by a search task. + /// Other kinds of tasks have different descriptions, like _reindex which has the source and the destination, or _bulk which just has the number of requests and the destination indices. + /// Many requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request. + /// + /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } [JsonInclude, JsonPropertyName("headers")] @@ -56,7 +65,10 @@ public sealed partial class ParentTaskInfo /// /// - /// Task status information can vary wildly from task to task. + /// The internal status of the task, which varies from task to task. + /// The format also varies. + /// While the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes. + /// Fields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases. /// /// [JsonInclude, JsonPropertyName("status")] diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskInfo.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskInfo.g.cs index d8fb4dc6ccd..a07febde4e8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskInfo.g.cs +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/Tasks/TaskInfo.g.cs @@ -35,6 +35,15 @@ public sealed partial class TaskInfo public bool Cancellable { get; init; } [JsonInclude, JsonPropertyName("cancelled")] public bool? Cancelled { get; init; } + + /// + /// + /// Human readable text that identifies the particular request that the task is performing. + /// For example, it might identify the search request being performed by a search task. + /// Other kinds of tasks have different descriptions, like _reindex which has the source and the destination, or _bulk which just has the number of requests and the destination indices. + /// Many requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request. + /// + /// [JsonInclude, JsonPropertyName("description")] public string? Description { get; init; } [JsonInclude, JsonPropertyName("headers")] @@ -54,7 +63,10 @@ public sealed partial class TaskInfo /// /// - /// Task status information can vary wildly from task to task. + /// The internal status of the task, which varies from task to task. + /// The format also varies. + /// While the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes. + /// Fields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases. /// /// [JsonInclude, JsonPropertyName("status")] 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 00000000000..95ea8843489 --- /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/TextStructure/FieldStat.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TextStructure/FieldStat.g.cs new file mode 100644 index 00000000000..1476c5994f9 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TextStructure/FieldStat.g.cs @@ -0,0 +1,50 @@ +// 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.TextStructure; + +public sealed partial class FieldStat +{ + [JsonInclude, JsonPropertyName("cardinality")] + public int Cardinality { get; init; } + [JsonInclude, JsonPropertyName("count")] + public int Count { get; init; } + [JsonInclude, JsonPropertyName("earliest")] + public string? Earliest { get; init; } + [JsonInclude, JsonPropertyName("latest")] + public string? Latest { get; init; } + [JsonInclude, JsonPropertyName("max_value")] + public int? MaxValue { get; init; } + [JsonInclude, JsonPropertyName("mean_value")] + public int? MeanValue { get; init; } + [JsonInclude, JsonPropertyName("median_value")] + public int? MedianValue { get; init; } + [JsonInclude, JsonPropertyName("min_value")] + public int? MinValue { get; init; } + [JsonInclude, JsonPropertyName("top_hits")] + public IReadOnlyCollection TopHits { get; init; } +} \ No newline at end of file diff --git a/src/Elastic.Clients.Elasticsearch/_Generated/Types/TextStructure/TopHit.g.cs b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TextStructure/TopHit.g.cs new file mode 100644 index 00000000000..a2eae50ae63 --- /dev/null +++ b/src/Elastic.Clients.Elasticsearch/_Generated/Types/TextStructure/TopHit.g.cs @@ -0,0 +1,36 @@ +// 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.TextStructure; + +public sealed partial class TopHit +{ + [JsonInclude, JsonPropertyName("count")] + public long Count { get; init; } + [JsonInclude, JsonPropertyName("value")] + public object Value { get; init; } +} \ 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 ce73c0c79b2..8648694b682 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")] diff --git a/src/Elastic.Clients.Elasticsearch/_Shared/Api/BulkRequest.cs b/src/Elastic.Clients.Elasticsearch/_Shared/Api/BulkRequest.cs index b9a2bf5151e..853b13a8be5 100644 --- a/src/Elastic.Clients.Elasticsearch/_Shared/Api/BulkRequest.cs +++ b/src/Elastic.Clients.Elasticsearch/_Shared/Api/BulkRequest.cs @@ -32,13 +32,17 @@ namespace Elastic.Clients.Elasticsearch; public partial class BulkRequest : IStreamSerializable { - internal Request Self => this; + private static readonly IRequestConfiguration RequestConfigSingleton = new RequestConfiguration + { + Accept = "application/json", + ContentType = "application/x-ndjson" + }; - public BulkOperationsCollection Operations { get; set; } + internal Request Self => this; - internal override string ContentType => "application/x-ndjson"; + protected internal override IRequestConfiguration RequestConfig => RequestConfigSingleton; - internal override string Accept => "application/json"; + public BulkOperationsCollection Operations { get; set; } public void Serialize(Stream stream, IElasticsearchClientSettings settings, SerializationFormatting formatting = SerializationFormatting.None) { @@ -87,9 +91,13 @@ public async Task SerializeAsync(Stream stream, IElasticsearchClientSettings set public sealed partial class BulkRequestDescriptor : IStreamSerializable { - internal override string ContentType => "application/x-ndjson"; + private static readonly IRequestConfiguration RequestConfigSingleton = new RequestConfiguration + { + Accept = "application/json", + ContentType = "application/x-ndjson" + }; - internal override string Accept => "application/json"; + protected internal override IRequestConfiguration RequestConfig => RequestConfigSingleton; private readonly BulkOperationsCollection _operations = new(); diff --git a/src/Elastic.Clients.Elasticsearch/_Shared/Api/Esql/EsqlQueryRequest.cs b/src/Elastic.Clients.Elasticsearch/_Shared/Api/Esql/EsqlQueryRequest.cs index 3f5821e2cb0..981a599fcc3 100644 --- a/src/Elastic.Clients.Elasticsearch/_Shared/Api/Esql/EsqlQueryRequest.cs +++ b/src/Elastic.Clients.Elasticsearch/_Shared/Api/Esql/EsqlQueryRequest.cs @@ -12,18 +12,19 @@ #if ELASTICSEARCH_SERVERLESS namespace Elastic.Clients.Elasticsearch.Serverless.Esql; #else - namespace Elastic.Clients.Elasticsearch.Esql; #endif -internal sealed class EsqlResponseBuilder : CustomResponseBuilder +internal sealed class EsqlResponseBuilder : TypedResponseBuilder { - public override object DeserializeResponse(Serializer serializer, ApiCallDetails response, Stream stream) + protected override EsqlQueryResponse? Build(ApiCallDetails apiCallDetails, BoundConfiguration boundConfiguration, + Stream responseStream, + string contentType, long contentLength) { - var bytes = stream switch + var bytes = responseStream switch { MemoryStream ms => ms.ToArray(), - _ => BytesFromStream(stream) + _ => BytesFromStream(responseStream) }; return new EsqlQueryResponse { Data = bytes }; @@ -37,13 +38,14 @@ static byte[] BytesFromStream(Stream stream) } } - public override async Task DeserializeResponseAsync(Serializer serializer, ApiCallDetails response, Stream stream, - CancellationToken ctx = new CancellationToken()) + protected override async Task BuildAsync(ApiCallDetails apiCallDetails, BoundConfiguration boundConfiguration, + Stream responseStream, + string contentType, long contentLength, CancellationToken cancellationToken = default) { - var bytes = stream switch + var bytes = responseStream switch { MemoryStream ms => ms.ToArray(), - _ => await BytesFromStreamAsync(stream, ctx).ConfigureAwait(false) + _ => await BytesFromStreamAsync(responseStream, cancellationToken).ConfigureAwait(false) }; return new EsqlQueryResponse { Data = bytes }; @@ -62,10 +64,3 @@ static async Task BytesFromStreamAsync(Stream stream, CancellationToken } } } - -public sealed partial class EsqlQueryRequestParameters -{ - private static readonly EsqlResponseBuilder ResponseBuilder = new(); - - public EsqlQueryRequestParameters() => CustomResponseBuilder = ResponseBuilder; -} diff --git a/src/Elastic.Clients.Elasticsearch/_Shared/Client/ElasticsearchClient.cs b/src/Elastic.Clients.Elasticsearch/_Shared/Client/ElasticsearchClient.cs index c71b196dec4..faee0c33fbc 100644 --- a/src/Elastic.Clients.Elasticsearch/_Shared/Client/ElasticsearchClient.cs +++ b/src/Elastic.Clients.Elasticsearch/_Shared/Client/ElasticsearchClient.cs @@ -4,6 +4,7 @@ using System; using System.Collections.Generic; +using System.Diagnostics; using System.Linq; using System.Runtime.CompilerServices; using System.Text.Json; @@ -21,7 +22,6 @@ #if ELASTICSEARCH_SERVERLESS namespace Elastic.Clients.Elasticsearch.Serverless; #else - namespace Elastic.Clients.Elasticsearch; #endif @@ -165,14 +165,12 @@ private ValueTask DoRequestCoreAsync SendRequest() { - var (resolvedUrl, _, resolvedRouteValues, postData) = PrepareRequest(request, forceConfiguration); - var openTelemetryData = PrepareOpenTelemetryData(request, resolvedRouteValues); + var (endpointPath, resolvedRouteValues, postData) = PrepareRequest(request); + var openTelemetryDataMutator = GetOpenTelemetryDataMutator(request, resolvedRouteValues); return isAsync - ? new ValueTask(_transport - .RequestAsync(request.HttpMethod, resolvedUrl, postData, request.RequestParameters, in openTelemetryData, cancellationToken)) - : new ValueTask(_transport - .Request(request.HttpMethod, resolvedUrl, postData, request.RequestParameters, in openTelemetryData)); + ? new ValueTask(_transport.RequestAsync(endpointPath, postData, openTelemetryDataMutator, request.RequestConfig, cancellationToken)) + : new ValueTask(_transport.Request(endpointPath, postData, openTelemetryDataMutator, request.RequestConfig)); } async ValueTask SendRequestWithProductCheck() @@ -198,129 +196,108 @@ async ValueTask SendRequestWithProductCheckCore() { // Attach product check header - var hadRequestConfig = false; - HeadersList? originalHeaders = null; - - if (request.RequestParameters.RequestConfiguration is null) - request.RequestParameters.RequestConfiguration = new RequestConfiguration(); - else - { - originalHeaders = request.RequestParameters.RequestConfiguration.ResponseHeadersToParse; - hadRequestConfig = true; - } - - request.RequestParameters.RequestConfiguration.ResponseHeadersToParse = request.RequestParameters.RequestConfiguration.ResponseHeadersToParse.Count == 0 - ? new HeadersList("x-elastic-product") - : new HeadersList(request.RequestParameters.RequestConfiguration.ResponseHeadersToParse, "x-elastic-product"); + // TODO: The copy constructor should accept null values + var requestConfig = (request.RequestConfig is null) + ? new RequestConfiguration() + { + ResponseHeadersToParse = new HeadersList("x-elastic-product") + } + : new RequestConfiguration(request.RequestConfig) + { + ResponseHeadersToParse = (request.RequestConfig.ResponseHeadersToParse is { Count: > 0 }) + ? new HeadersList(request.RequestConfig.ResponseHeadersToParse, "x-elastic-product") + : new HeadersList("x-elastic-product") + }; // Send request - var (resolvedUrl, _, resolvedRouteValues, postData) = PrepareRequest(request, forceConfiguration); - var openTelemetryData = PrepareOpenTelemetryData(request, resolvedRouteValues); + var (endpointPath, resolvedRouteValues, postData) = PrepareRequest(request); + var openTelemetryDataMutator = GetOpenTelemetryDataMutator(request, resolvedRouteValues); TResponse response; if (isAsync) { response = await _transport - .RequestAsync(request.HttpMethod, resolvedUrl, postData, request.RequestParameters, in openTelemetryData, cancellationToken) + .RequestAsync(endpointPath, postData, openTelemetryDataMutator, requestConfig, cancellationToken) .ConfigureAwait(false); } else { - response = _transport - .Request(request.HttpMethod, resolvedUrl, postData, request.RequestParameters, in openTelemetryData); + response = _transport.Request(endpointPath, postData, openTelemetryDataMutator, requestConfig); } // Evaluate product check result var hasSuccessStatusCode = response.ApiCallDetails.HttpStatusCode is >= 200 and <= 299; - if (hasSuccessStatusCode) - { - var productCheckSucceeded = response.ApiCallDetails.TryGetHeader("x-elastic-product", out var values) && - values.FirstOrDefault(x => x.Equals("Elasticsearch", StringComparison.Ordinal)) is not null; - - _productCheckStatus = productCheckSucceeded - ? (int)ProductCheckStatus.Succeeded - : (int)ProductCheckStatus.Failed; - - if (_productCheckStatus == (int)ProductCheckStatus.Failed) - throw new UnsupportedProductException(UnsupportedProductException.InvalidProductError); - } - - if (request.RequestParameters.RequestConfiguration is null) - return response; - - // Reset request configuration - - if (!hadRequestConfig) - request.RequestParameters.RequestConfiguration = null; - else if (originalHeaders is { Count: > 0 }) - request.RequestParameters.RequestConfiguration.ResponseHeadersToParse = originalHeaders.Value; - if (!hasSuccessStatusCode) { // The product check is unreliable for non success status codes. // We have to re-try on the next request. _productCheckStatus = (int)ProductCheckStatus.NotChecked; + + return response; } + var productCheckSucceeded = response.ApiCallDetails.TryGetHeader("x-elastic-product", out var values) && + values.FirstOrDefault(x => x.Equals("Elasticsearch", StringComparison.Ordinal)) is not null; + + _productCheckStatus = productCheckSucceeded + ? (int)ProductCheckStatus.Succeeded + : (int)ProductCheckStatus.Failed; + + if (_productCheckStatus == (int)ProductCheckStatus.Failed) + throw new UnsupportedProductException(UnsupportedProductException.InvalidProductError); + return response; } } - private static OpenTelemetryData PrepareOpenTelemetryData(TRequest request, Dictionary resolvedRouteValues) + private static Action? GetOpenTelemetryDataMutator(TRequest request, Dictionary? resolvedRouteValues) where TRequest : Request where TRequestParameters : RequestParameters, new() { // If there are no subscribed listeners, we avoid some work and allocations if (!Elastic.Transport.Diagnostics.OpenTelemetry.ElasticTransportActivitySourceHasListeners) - return default; + return null; - // We fall back to a general operation name in cases where the derived request fails to override the property - var operationName = !string.IsNullOrEmpty(request.OperationName) ? request.OperationName : request.HttpMethod.GetStringValue(); + return OpenTelemetryDataMutator; - // TODO: Optimisation: We should consider caching these, either for cases where resolvedRouteValues is null, or - // caching per combination of route values. - // We should benchmark this first to assess the impact for common workloads. - // The former is likely going to save some short-lived allocations, but only for requests to endpoints without required path parts. - // The latter may bloat the cache as some combinations of path parts may rarely re-occur. - var attributes = new Dictionary + void OpenTelemetryDataMutator(Activity activity) { - [OpenTelemetry.SemanticConventions.DbOperation] = !string.IsNullOrEmpty(request.OperationName) ? request.OperationName : "unknown", - [$"{OpenTelemetrySpanAttributePrefix}schema_url"] = OpenTelemetrySchemaVersion - }; + // We fall back to a general operation name in cases where the derived request fails to override the property + var operationName = !string.IsNullOrEmpty(request.OperationName) ? request.OperationName : request.HttpMethod.GetStringValue(); + + // TODO: Optimisation: We should consider caching these, either for cases where resolvedRouteValues is null, or + // caching per combination of route values. + // We should benchmark this first to assess the impact for common workloads. + // The former is likely going to save some short-lived allocations, but only for requests to endpoints without required path parts. + // The latter may bloat the cache as some combinations of path parts may rarely re-occur. + + activity.DisplayName = operationName; + + activity.SetTag(OpenTelemetry.SemanticConventions.DbOperation, !string.IsNullOrEmpty(request.OperationName) ? request.OperationName : "unknown"); + activity.SetTag($"{OpenTelemetrySpanAttributePrefix}schema_url", OpenTelemetrySchemaVersion); + + if (resolvedRouteValues is null) + return; - if (resolvedRouteValues is not null) - { foreach (var value in resolvedRouteValues) { if (!string.IsNullOrEmpty(value.Key) && !string.IsNullOrEmpty(value.Value)) - attributes.Add($"{OpenTelemetrySpanAttributePrefix}path_parts.{value.Key}", value.Value); + activity.SetTag($"{OpenTelemetrySpanAttributePrefix}path_parts.{value.Key}", value.Value); } } - - var openTelemetryData = new OpenTelemetryData { SpanName = operationName, SpanAttributes = attributes }; - return openTelemetryData; } - private (string resolvedUrl, string urlTemplate, Dictionary? resolvedRouteValues, PostData data) PrepareRequest(TRequest request, - Action? forceConfiguration) + private (EndpointPath endpointPath, Dictionary? resolvedRouteValues, PostData data) PrepareRequest(TRequest request) where TRequest : Request where TRequestParameters : RequestParameters, new() { request.ThrowIfNull(nameof(request), "A request is required."); - if (forceConfiguration is not null) - ForceConfiguration(request, forceConfiguration); - - if (request.ContentType is not null) - ForceContentType(request, request.ContentType); - - if (request.Accept is not null) - ForceAccept(request, request.Accept); - - var (resolvedUrl, urlTemplate, routeValues) = request.GetUrl(ElasticsearchClientSettings); + var (resolvedUrl, _, routeValues) = request.GetUrl(ElasticsearchClientSettings); + var pathAndQuery = request.RequestParameters.CreatePathWithQueryStrings(resolvedUrl, ElasticsearchClientSettings); var postData = request.HttpMethod == HttpMethod.GET || @@ -328,45 +305,6 @@ private static OpenTelemetryData PrepareOpenTelemetryData(Request request, Action forceConfiguration) - where TRequestParameters : RequestParameters, new() - { - var configuration = request.RequestParameters.RequestConfiguration ?? new RequestConfiguration(); - forceConfiguration(configuration); - request.RequestParameters.RequestConfiguration = configuration; - } - - private static void ForceContentType(TRequest request, string contentType) - where TRequest : Request - where TRequestParameters : RequestParameters, new() - { - var configuration = request.RequestParameters.RequestConfiguration ?? new RequestConfiguration(); - configuration.Accept = contentType; - configuration.ContentType = contentType; - request.RequestParameters.RequestConfiguration = configuration; - } - - private static void ForceAccept(TRequest request, string acceptType) - where TRequest : Request - where TRequestParameters : RequestParameters, new() - { - var configuration = request.RequestParameters.RequestConfiguration ?? new RequestConfiguration(); - configuration.Accept = acceptType; - request.RequestParameters.RequestConfiguration = configuration; - } - - internal static void ForceJson(IRequestConfiguration requestConfiguration) - { - requestConfiguration.Accept = RequestData.DefaultMimeType; - requestConfiguration.ContentType = RequestData.DefaultMimeType; - } - - internal static void ForceTextPlain(IRequestConfiguration requestConfiguration) - { - requestConfiguration.Accept = RequestData.MimeTypeTextPlain; - requestConfiguration.ContentType = RequestData.MimeTypeTextPlain; + return (new EndpointPath(request.HttpMethod, pathAndQuery), routeValues, postData); } } diff --git a/src/Elastic.Clients.Elasticsearch/_Shared/Core/Configuration/ElasticsearchClientSettings.cs b/src/Elastic.Clients.Elasticsearch/_Shared/Core/Configuration/ElasticsearchClientSettings.cs index 62c3e7ce566..b8381c7df40 100644 --- a/src/Elastic.Clients.Elasticsearch/_Shared/Core/Configuration/ElasticsearchClientSettings.cs +++ b/src/Elastic.Clients.Elasticsearch/_Shared/Core/Configuration/ElasticsearchClientSettings.cs @@ -10,8 +10,10 @@ using System.Reflection; #if ELASTICSEARCH_SERVERLESS +using Elastic.Clients.Elasticsearch.Serverless.Esql; using Elastic.Clients.Elasticsearch.Serverless.Fluent; #else +using Elastic.Clients.Elasticsearch.Esql; using Elastic.Clients.Elasticsearch.Fluent; #endif @@ -104,9 +106,9 @@ public ElasticsearchClientSettings( /// [Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] -public abstract class - ElasticsearchClientSettingsBase : ConnectionConfigurationBase, - IElasticsearchClientSettings +public abstract class ElasticsearchClientSettingsBase : + ConnectionConfigurationBase, + IElasticsearchClientSettings where TConnectionSettings : ElasticsearchClientSettingsBase, IElasticsearchClientSettings { private readonly FluentDictionary _defaultIndices; @@ -381,19 +383,21 @@ public ConnectionConfiguration(NodePool nodePool, IRequestInvoker requestInvoker /// [Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] -public abstract class - ConnectionConfigurationBase : TransportConfigurationBase, - TransportClientConfigurationValues - where TConnectionConfiguration : ConnectionConfigurationBase, +public abstract class ConnectionConfigurationBase : + TransportConfigurationDescriptorBase, TransportClientConfigurationValues + where TConnectionConfiguration : ConnectionConfigurationBase, TransportClientConfigurationValues { private bool _includeServerStackTraceOnError; protected ConnectionConfigurationBase(NodePool nodePool, IRequestInvoker requestInvoker, Serializer? serializer, ProductRegistration registration = null) - : base(nodePool, requestInvoker, serializer, registration ?? new ElasticsearchProductRegistration(typeof(ElasticsearchClient))) => - UserAgent(ConnectionConfiguration.DefaultUserAgent); + : base(nodePool, requestInvoker, serializer, registration ?? new ElasticsearchProductRegistration(typeof(ElasticsearchClient))) + { + UserAgent(ConnectionConfiguration.DefaultUserAgent); + ResponseBuilder(new EsqlResponseBuilder()); + } bool TransportClientConfigurationValues.IncludeServerStackTraceOnError => _includeServerStackTraceOnError; diff --git a/src/Elastic.Clients.Elasticsearch/_Shared/Core/Request/PlainRequest.cs b/src/Elastic.Clients.Elasticsearch/_Shared/Core/Request/PlainRequest.cs index 912d1a46dbd..9e36e7f3894 100644 --- a/src/Elastic.Clients.Elasticsearch/_Shared/Core/Request/PlainRequest.cs +++ b/src/Elastic.Clients.Elasticsearch/_Shared/Core/Request/PlainRequest.cs @@ -15,6 +15,8 @@ namespace Elastic.Clients.Elasticsearch.Requests; public abstract class PlainRequest : Request where TParameters : RequestParameters, new() { + private IRequestConfiguration? _requestConfiguration; // TODO: Remove this from the request classes and add to the endpoint methods instead + // This internal ctor ensures that only types defined within the Elastic.Clients.Elasticsearch assembly can derive from this base class. // We don't expect consumers to derive from this public base class. internal PlainRequest() { } @@ -75,9 +77,9 @@ public string SourceQueryString /// Specify settings for this request alone, handy if you need a custom timeout or want to bypass sniffing, retries /// [JsonIgnore] - public IRequestConfiguration RequestConfiguration + public IRequestConfiguration? RequestConfiguration { - get => RequestParameters.RequestConfiguration; - set => RequestParameters.RequestConfiguration = value; + get => _requestConfiguration; + set => _requestConfiguration = value; } } diff --git a/src/Elastic.Clients.Elasticsearch/_Shared/Core/Request/Request.cs b/src/Elastic.Clients.Elasticsearch/_Shared/Core/Request/Request.cs index 2b643379e60..9d3a2470874 100644 --- a/src/Elastic.Clients.Elasticsearch/_Shared/Core/Request/Request.cs +++ b/src/Elastic.Clients.Elasticsearch/_Shared/Core/Request/Request.cs @@ -6,7 +6,6 @@ using System.Collections.Generic; using System.Text.Json.Serialization; using Elastic.Transport; -using Elastic.Transport.Diagnostics; #if ELASTICSEARCH_SERVERLESS namespace Elastic.Clients.Elasticsearch.Serverless.Requests; @@ -23,9 +22,7 @@ public abstract class Request // We don't expect consumers to derive from this public base class. internal Request() { } - internal virtual string? Accept { get; } = null; - - internal virtual string? ContentType { get; } = null; + [JsonIgnore] protected internal virtual IRequestConfiguration? RequestConfig { get; set; } /// /// The default HTTP method for the request which is based on the Elasticsearch Specification endpoint definition. @@ -68,28 +65,19 @@ internal virtual void BeforeRequest() { } public abstract class Request : Request where TParameters : RequestParameters, new() { - private readonly TParameters _parameters; - - internal Request() => _parameters = new TParameters(); + internal Request() => RequestParameters = new TParameters(); protected Request(Func pathSelector) { pathSelector(RouteValues); - _parameters = new TParameters(); + RequestParameters = new TParameters(); } - [JsonIgnore] internal TParameters RequestParameters => _parameters; + [JsonIgnore] internal TParameters RequestParameters { get; } protected TOut? Q(string name) => RequestParameters.GetQueryStringValue(name); protected void Q(string name, object? value) => RequestParameters.SetQueryString(name, value); protected void Q(string name, IStringable value) => RequestParameters.SetQueryString(name, value.GetString()); - - protected void SetAcceptHeader(string format) - { - RequestParameters.RequestConfiguration ??= new RequestConfiguration(); - RequestParameters.RequestConfiguration.Accept = - RequestParameters.AcceptHeaderFromFormat(format); - } } diff --git a/src/Elastic.Clients.Elasticsearch/_Shared/Core/Request/RequestDescriptor.cs b/src/Elastic.Clients.Elasticsearch/_Shared/Core/Request/RequestDescriptor.cs index 77ad327e1f5..157552162a8 100644 --- a/src/Elastic.Clients.Elasticsearch/_Shared/Core/Request/RequestDescriptor.cs +++ b/src/Elastic.Clients.Elasticsearch/_Shared/Core/Request/RequestDescriptor.cs @@ -22,9 +22,10 @@ namespace Elastic.Clients.Elasticsearch.Requests; /// /// Base class for all request descriptor types. /// -public abstract partial class RequestDescriptor : Request, ISelfSerializable - where TDescriptor : RequestDescriptor - where TParameters : RequestParameters, new() +public abstract partial class RequestDescriptor : + Request, ISelfSerializable + where TDescriptor : RequestDescriptor + where TParameters : RequestParameters, new() { private readonly TDescriptor _descriptor; @@ -56,12 +57,11 @@ protected TDescriptor Qs(string name, IStringable value) /// /// Specify settings for this request alone, handy if you need a custom timeout or want to bypass sniffing, retries /// - public TDescriptor RequestConfiguration( - Func configurationSelector) + public TDescriptor RequestConfiguration(Func configurationSelector) { - var rc = RequestParameters.RequestConfiguration; - RequestParameters.RequestConfiguration = - configurationSelector?.Invoke(new RequestConfigurationDescriptor(rc)) ?? rc; + RequestConfig = configurationSelector?.Invoke(RequestConfig is null + ? new RequestConfigurationDescriptor() + : new RequestConfigurationDescriptor(RequestConfig)) ?? RequestConfig; return _descriptor; } diff --git a/src/Elastic.Clients.Elasticsearch/_Shared/Helpers/BulkAllObservable.cs b/src/Elastic.Clients.Elasticsearch/_Shared/Helpers/BulkAllObservable.cs index e452e3465f1..e622b1436df 100644 --- a/src/Elastic.Clients.Elasticsearch/_Shared/Helpers/BulkAllObservable.cs +++ b/src/Elastic.Clients.Elasticsearch/_Shared/Helpers/BulkAllObservable.cs @@ -124,7 +124,7 @@ private async Task BulkAsync(IList buffer, long page, int ba var response = await _client.BulkAsync(s => { - s.RequestParameters.RequestConfiguration = new RequestConfiguration { DisableAuditTrail = false }; + s.RequestConfiguration(x => x.DisableAuditTrail(false)); s.Index(request.Index); s.Timeout(request.Timeout); diff --git a/src/Elastic.Clients.Elasticsearch/_Shared/Helpers/RequestParametersExtensions.cs b/src/Elastic.Clients.Elasticsearch/_Shared/Helpers/RequestParametersExtensions.cs deleted file mode 100644 index 0640c806a70..00000000000 --- a/src/Elastic.Clients.Elasticsearch/_Shared/Helpers/RequestParametersExtensions.cs +++ /dev/null @@ -1,29 +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. - - -using System; -using Elastic.Transport; - -#if ELASTICSEARCH_SERVERLESS -namespace Elastic.Clients.Elasticsearch.Serverless; -#else -namespace Elastic.Clients.Elasticsearch; -#endif - -internal static class RequestParametersExtensions -{ - internal static void SetRequestMetaData(this RequestParameters parameters, RequestMetaData requestMetaData) - { - if (parameters is null) - throw new ArgumentNullException(nameof(parameters)); - - if (requestMetaData is null) - throw new ArgumentNullException(nameof(requestMetaData)); - - parameters.RequestConfiguration ??= new RequestConfiguration(); - - parameters.RequestConfiguration.RequestMetaData = requestMetaData; - } -} diff --git a/src/Playground/Playground.csproj b/src/Playground/Playground.csproj index a2095681e91..004205ffb13 100644 --- a/src/Playground/Playground.csproj +++ b/src/Playground/Playground.csproj @@ -10,7 +10,7 @@ - + diff --git a/tests/Tests.ClusterLauncher/Tests.ClusterLauncher.csproj b/tests/Tests.ClusterLauncher/Tests.ClusterLauncher.csproj index 8f5d8102e48..7935ae2f92a 100644 --- a/tests/Tests.ClusterLauncher/Tests.ClusterLauncher.csproj +++ b/tests/Tests.ClusterLauncher/Tests.ClusterLauncher.csproj @@ -1,7 +1,7 @@ Exe - net6.0;net8.0 + net8.0 false diff --git a/tests/Tests.Core/Client/FixedResponseClient.cs b/tests/Tests.Core/Client/FixedResponseClient.cs index 8a33f59ed50..5a23d866ba0 100644 --- a/tests/Tests.Core/Client/FixedResponseClient.cs +++ b/tests/Tests.Core/Client/FixedResponseClient.cs @@ -17,7 +17,7 @@ public static ElasticsearchClient Create( object response, int statusCode = 200, Func modifySettings = null, - string contentType = RequestData.DefaultMimeType, + string contentType = BoundConfiguration.DefaultContentType, Exception exception = null ) { @@ -29,7 +29,7 @@ public static ElasticsearchClientSettings CreateConnectionSettings( object response, int statusCode = 200, Func modifySettings = null, - string contentType = RequestData.DefaultMimeType, + string contentType = BoundConfiguration.DefaultContentType, Exception exception = null, Serializer serializer = null ) @@ -46,7 +46,7 @@ public static ElasticsearchClientSettings CreateConnectionSettings( break; default: { - responseBytes = contentType == RequestData.DefaultMimeType + responseBytes = contentType == BoundConfiguration.DefaultContentType ? serializer.SerializeToBytes(response, TestClient.Default.ElasticsearchClientSettings.MemoryStreamFactory) : Encoding.UTF8.GetBytes(response.ToString()); diff --git a/tests/Tests/ClientConcepts/OpenTelemetry/OpenTelemetryTests.cs b/tests/Tests/ClientConcepts/OpenTelemetry/OpenTelemetryTests.cs index 3fb2b955881..05ae1f13b5f 100644 --- a/tests/Tests/ClientConcepts/OpenTelemetry/OpenTelemetryTests.cs +++ b/tests/Tests/ClientConcepts/OpenTelemetry/OpenTelemetryTests.cs @@ -32,34 +32,34 @@ public async Task BasicOpenTelemetryTest() client.Ping(); - VerifyActivity(oTelActivity, "ping"); + VerifyActivity(oTelActivity, "ping", "HEAD"); await client.PingAsync(); - VerifyActivity(oTelActivity, "ping"); + VerifyActivity(oTelActivity, "ping", "HEAD"); await client.SearchAsync(s => s.Index("test").Query(q => q.MatchAll(m => { }))); - VerifyActivity(oTelActivity, "search", "http://localhost:9200/test/_search?pretty=true&error_trace=true"); + VerifyActivity(oTelActivity, "search", "POST", "http://localhost:9200/test/_search?pretty=true&error_trace=true"); - static void VerifyActivity(Activity oTelActivity, string operation, string url = null) + static void VerifyActivity(Activity oTelActivity, string displayName, string operation, string url = null) { oTelActivity.Should().NotBeNull(); oTelActivity.Kind.Should().Be(ActivityKind.Client); - oTelActivity.DisplayName.Should().Be(operation); oTelActivity.OperationName.Should().Be(operation); + oTelActivity.DisplayName.Should().Be(displayName); oTelActivity.Tags.Should().Contain(n => n.Key == "elastic.transport.product.name" && n.Value == "elasticsearch-net"); oTelActivity.Tags.Should().Contain(n => n.Key == "db.system" && n.Value == "elasticsearch"); - oTelActivity.Tags.Should().Contain(n => n.Key == "db.operation" && n.Value == operation); + oTelActivity.Tags.Should().Contain(n => n.Key == "db.operation" && n.Value == displayName); oTelActivity.Tags.Should().Contain(n => n.Key == "db.user" && n.Value == "elastic"); oTelActivity.Tags.Should().Contain(n => n.Key == "url.full" && n.Value == (url ?? "http://localhost:9200/?pretty=true&error_trace=true")); oTelActivity.Tags.Should().Contain(n => n.Key == "server.address" && n.Value == "localhost"); - oTelActivity.Tags.Should().Contain(n => n.Key == "http.request.method" && n.Value == (operation == "ping" ? "HEAD" : "POST")); + oTelActivity.Tags.Should().Contain(n => n.Key == "http.request.method" && n.Value == (displayName == "ping" ? "HEAD" : "POST")); - switch (operation) + switch (displayName) { case "search": oTelActivity.Tags.Should().Contain(n => n.Key == "db.elasticsearch.path_parts.index" && n.Value == "test"); diff --git a/tests/Tests/Tests.csproj b/tests/Tests/Tests.csproj index e764cc6a729..a99139377b6 100644 --- a/tests/Tests/Tests.csproj +++ b/tests/Tests/Tests.csproj @@ -1,6 +1,6 @@ - net6.0;net8.0 + net8.0 $(NoWarn);xUnit1013 True True @@ -10,7 +10,7 @@ - +