/* SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. */ /* * Modifications Copyright OpenSearch Contributors. See * GitHub history for details. * * Licensed to Elasticsearch B.V. under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch B.V. licenses this file to you under * the Apache License, Version 2.0 (the "License"); you may * not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ // ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗ // ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝ // ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗ // ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝ // ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗ // ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝ // ----------------------------------------------- // // This file is automatically generated // Please do not edit these files manually // Run the following in the root of the repos: // // *NIX : ./build.sh codegen // Windows : build.bat codegen // // ----------------------------------------------- // ReSharper disable RedundantUsingDirective using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Linq.Expressions; // ReSharper disable once CheckNamespace namespace OpenSearch.Net { ///Request options for Bulk https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/ public class BulkRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; ///The pipeline id to preprocess incoming documents with public string Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// /// If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this /// operation visible to search, if `false` (the default) then do nothing with refreshes. /// public Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///Sets require_alias for all incoming documents. Defaults to unset (false) public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } ///Specific routing value public string Routing { get => Q("routing"); set => Q("routing", value); } ///True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request public bool? SourceEnabled { get => Q("_source"); set => Q("_source", value); } ///Default list of fields to exclude from the returned _source field, can be overridden on each sub-request public string[] SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } ///Default list of fields to extract and return from the _source field, can be overridden on each sub-request public string[] SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } ///Explicit operation timeout public TimeSpan Timeout { get => Q("timeout"); set => Q("timeout", value); } ///Default document type for items which don't provide one public string TypeQueryString { get => Q("type"); set => Q("type", value); } /// /// Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard /// only. 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) /// public string WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } ///Request options for ClearScroll https://opensearch.org/docs/latest/opensearch/rest-api/scroll/ public class ClearScrollRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.DELETE; public override bool SupportsBody => true; } ///Request options for Count https://opensearch.org/docs/latest/opensearch/rest-api/count/ public class CountRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; /// /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have /// been specified) /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } ///Specify whether wildcard and prefix queries should be analyzed (default: false) public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } ///The analyzer to use for the query string public string Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } ///The default operator for query string query (AND or OR) public DefaultOperator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } ///The field to use as default where no field prefix is given in the query string public string Df { get => Q("df"); set => Q("df", value); } ///Whether to expand wildcard expression to concrete indices that are open, closed or both. public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } ///Whether specified concrete, expanded or aliased indices should be ignored when throttled public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } ///Whether specified concrete indices should be ignored when unavailable (missing or closed) public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } ///Specify whether format-based query failures (such as providing text to a numeric field) should be ignored public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } ///Include only documents with a specific `_score` value in the result public double? MinScore { get => Q("min_score"); set => Q("min_score", value); } ///Specify the node or shard the operation should be performed on (default: random) public string Preference { get => Q("preference"); set => Q("preference", value); } ///Query in the Lucene query string syntax public string QueryOnQueryString { get => Q("q"); set => Q("q", value); } ///A comma-separated list of specific routing values public string[] Routing { get => Q("routing"); set => Q("routing", value); } ///The maximum count for each shard, upon reaching which the query execution will terminate early public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } } ///Request options for Create https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/index-document/ public class CreateRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.PUT; public override bool SupportsBody => true; ///The pipeline id to preprocess incoming documents with public string Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// /// If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this /// operation visible to search, if `false` (the default) then do nothing with refreshes. /// public Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///Specific routing value public string Routing { get => Q("routing"); set => Q("routing", value); } ///Explicit operation timeout public TimeSpan Timeout { get => Q("timeout"); set => Q("timeout", value); } ///Explicit version number for concurrency control public long? Version { get => Q("version"); set => Q("version", value); } ///Specific version type public VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// /// Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard /// only. 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) /// public string WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } ///Request options for Delete https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-document/ public class DeleteRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.DELETE; public override bool SupportsBody => false; ///only perform the delete operation if the last operation that has changed the document has the specified primary term public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } ///only perform the delete operation if the last operation that has changed the document has the specified sequence number public long? IfSequenceNumber { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// /// If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this /// operation visible to search, if `false` (the default) then do nothing with refreshes. /// public Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///Specific routing value public string Routing { get => Q("routing"); set => Q("routing", value); } ///Explicit operation timeout public TimeSpan Timeout { get => Q("timeout"); set => Q("timeout", value); } ///Explicit version number for concurrency control public long? Version { get => Q("version"); set => Q("version", value); } ///Specific version type public VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// /// Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard /// only. 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) /// public string WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } ///Request options for DeleteByQuery https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/ public class DeleteByQueryRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; /// /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have /// been specified) /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } ///Specify whether wildcard and prefix queries should be analyzed (default: false) public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } ///The analyzer to use for the query string public string Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } ///What to do when the delete by query hits version conflicts? public Conflicts? Conflicts { get => Q("conflicts"); set => Q("conflicts", value); } ///The default operator for query string query (AND or OR) public DefaultOperator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } ///The field to use as default where no field prefix is given in the query string public string Df { get => Q("df"); set => Q("df", value); } ///Whether to expand wildcard expression to concrete indices that are open, closed or both. public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } ///Starting offset (default: 0) public long? From { get => Q("from"); set => Q("from", value); } ///Whether specified concrete indices should be ignored when unavailable (missing or closed) public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } ///Specify whether format-based query failures (such as providing text to a numeric field) should be ignored public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } ///Specify the node or shard the operation should be performed on (default: random) public string Preference { get => Q("preference"); set => Q("preference", value); } ///Query in the Lucene query string syntax public string QueryOnQueryString { get => Q("q"); set => Q("q", value); } ///Should the effected indexes be refreshed? public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///Specify if request cache should be used for this request or not, defaults to index level setting public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } ///The throttle for this request in sub-requests per second. -1 means no throttle. public long? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } ///A comma-separated list of specific routing values public string[] Routing { get => Q("routing"); set => Q("routing", value); } ///Specify how long a consistent view of the index should be maintained for scrolled search public TimeSpan Scroll { get => Q("scroll"); set => Q("scroll", value); } ///Size on the scroll request powering the delete by query public long? ScrollSize { get => Q("scroll_size"); set => Q("scroll_size", value); } ///Explicit timeout for each search request. Defaults to no timeout. public TimeSpan SearchTimeout { get => Q("search_timeout"); set => Q("search_timeout", value); } ///Search operation type public SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } ///The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. public long? Slices { get => Q("slices"); set => Q("slices", value); } ///A comma-separated list of <field>:<direction> pairs public string[] Sort { get => Q("sort"); set => Q("sort", value); } ///True or false to return the _source field or not, or a list of fields to return public bool? SourceEnabled { get => Q("_source"); set => Q("_source", value); } ///A list of fields to exclude from the returned _source field public string[] SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } ///A list of fields to extract and return from the _source field public string[] SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } ///Specific 'tag' of the request for logging and statistical purposes public string[] Stats { get => Q("stats"); set => Q("stats", value); } ///The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } ///Time each individual bulk request should wait for shards that are unavailable. public TimeSpan Timeout { get => Q("timeout"); set => Q("timeout", value); } ///Specify whether to return document version as part of a hit public bool? Version { get => Q("version"); set => Q("version", value); } /// /// Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the /// primary shard only. 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) /// public string WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } ///Should the request should block until the delete by query is complete. public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } ///Request options for DeleteByQueryRethrottle https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/ public class DeleteByQueryRethrottleRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => false; ///The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. public long? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } ///Request options for DeleteScript public class DeleteScriptRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.DELETE; public override bool SupportsBody => false; ///Specify timeout for connection to master node ///Deprecated as of OpenSearch 2.0, use instead public TimeSpan MasterTimeSpanout { get => Q("master_timeout"); set => Q("master_timeout", value); } ///Specify timeout for connection to cluster_manager node ///Introduced in OpenSearch 2.0 instead of public TimeSpan ClusterManagerTimeSpanout { get => Q("cluster_manager_timeout"); set => Q("cluster_manager_timeout", value); } ///Explicit operation timeout public TimeSpan Timeout { get => Q("timeout"); set => Q("timeout", value); } } ///Request options for DocumentExists https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/ public class DocumentExistsRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.HEAD; public override bool SupportsBody => false; ///Specify the node or shard the operation should be performed on (default: random) public string Preference { get => Q("preference"); set => Q("preference", value); } ///Specify whether to perform the operation in realtime or search mode public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } ///Refresh the shard containing the document before performing the operation public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///Specific routing value public string Routing { get => Q("routing"); set => Q("routing", value); } ///True or false to return the _source field or not, or a list of fields to return public bool? SourceEnabled { get => Q("_source"); set => Q("_source", value); } ///A list of fields to exclude from the returned _source field public string[] SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } ///A list of fields to extract and return from the _source field public string[] SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } ///A comma-separated list of stored fields to return in the response public string[] StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } ///Explicit version number for concurrency control public long? Version { get => Q("version"); set => Q("version", value); } ///Specific version type public VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } ///Request options for SourceExists https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/ public class SourceExistsRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.HEAD; public override bool SupportsBody => false; ///Specify the node or shard the operation should be performed on (default: random) public string Preference { get => Q("preference"); set => Q("preference", value); } ///Specify whether to perform the operation in realtime or search mode public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } ///Refresh the shard containing the document before performing the operation public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///Specific routing value public string Routing { get => Q("routing"); set => Q("routing", value); } ///True or false to return the _source field or not, or a list of fields to return public bool? SourceEnabled { get => Q("_source"); set => Q("_source", value); } ///A list of fields to exclude from the returned _source field public string[] SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } ///A list of fields to extract and return from the _source field public string[] SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } ///Explicit version number for concurrency control public long? Version { get => Q("version"); set => Q("version", value); } ///Specific version type public VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } ///Request options for Explain https://opensearch.org/docs/latest/opensearch/rest-api/explain/ public class ExplainRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; ///Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false) public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } ///The analyzer for the query string query public string Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } ///The default operator for query string query (AND or OR) public DefaultOperator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } ///The default field for query string query (default: _all) public string Df { get => Q("df"); set => Q("df", value); } ///Specify whether format-based query failures (such as providing text to a numeric field) should be ignored public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } ///Specify the node or shard the operation should be performed on (default: random) public string Preference { get => Q("preference"); set => Q("preference", value); } ///Query in the Lucene query string syntax public string QueryOnQueryString { get => Q("q"); set => Q("q", value); } ///Specific routing value public string Routing { get => Q("routing"); set => Q("routing", value); } ///True or false to return the _source field or not, or a list of fields to return public bool? SourceEnabled { get => Q("_source"); set => Q("_source", value); } ///A list of fields to exclude from the returned _source field public string[] SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } ///A list of fields to extract and return from the _source field public string[] SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } ///A comma-separated list of stored fields to return in the response public string[] StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } } ///Request options for FieldCapabilities public class FieldCapabilitiesRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; /// /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have /// been specified) /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } ///Whether to expand wildcard expression to concrete indices that are open, closed or both. public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } ///A comma-separated list of field names public string[] Fields { get => Q("fields"); set => Q("fields", value); } ///Whether specified concrete indices should be ignored when unavailable (missing or closed) public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } ///Indicates whether unmapped fields should be included in the response. public bool? IncludeUnmapped { get => Q("include_unmapped"); set => Q("include_unmapped", value); } } ///Request options for Get https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/ public class GetRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.GET; public override bool SupportsBody => false; ///Specify the node or shard the operation should be performed on (default: random) public string Preference { get => Q("preference"); set => Q("preference", value); } ///Specify whether to perform the operation in realtime or search mode public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } ///Refresh the shard containing the document before performing the operation public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///Specific routing value public string Routing { get => Q("routing"); set => Q("routing", value); } ///True or false to return the _source field or not, or a list of fields to return public bool? SourceEnabled { get => Q("_source"); set => Q("_source", value); } ///A list of fields to exclude from the returned _source field public string[] SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } ///A list of fields to extract and return from the _source field public string[] SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } ///A comma-separated list of stored fields to return in the response public string[] StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } ///Explicit version number for concurrency control public long? Version { get => Q("version"); set => Q("version", value); } ///Specific version type public VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } ///Request options for GetScript public class GetScriptRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.GET; public override bool SupportsBody => false; ///Specify timeout for connection to master node ///Deprecated as of OpenSearch 2.0, use instead public TimeSpan MasterTimeSpanout { get => Q("master_timeout"); set => Q("master_timeout", value); } ///Specify timeout for connection to cluster_manager node ///Introduced in OpenSearch 2.0 instead of public TimeSpan ClusterManagerTimeSpanout { get => Q("cluster_manager_timeout"); set => Q("cluster_manager_timeout", value); } } ///Request options for GetScriptContext public class GetScriptContextRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.GET; public override bool SupportsBody => false; } ///Request options for GetScriptLanguages public class GetScriptLanguagesRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.GET; public override bool SupportsBody => false; } ///Request options for Source https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/ public class SourceRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.GET; public override bool SupportsBody => false; ///Specify the node or shard the operation should be performed on (default: random) public string Preference { get => Q("preference"); set => Q("preference", value); } ///Specify whether to perform the operation in realtime or search mode public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } ///Refresh the shard containing the document before performing the operation public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///Specific routing value public string Routing { get => Q("routing"); set => Q("routing", value); } ///True or false to return the _source field or not, or a list of fields to return public bool? SourceEnabled { get => Q("_source"); set => Q("_source", value); } ///A list of fields to exclude from the returned _source field public string[] SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } ///A list of fields to extract and return from the _source field public string[] SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } ///Explicit version number for concurrency control public long? Version { get => Q("version"); set => Q("version", value); } ///Specific version type public VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } ///Request options for Index https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/index-document/ public class IndexRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.PUT; public override bool SupportsBody => true; ///only perform the index operation if the last operation that has changed the document has the specified primary term public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } ///only perform the index operation if the last operation that has changed the document has the specified sequence number public long? IfSequenceNumber { get => Q("if_seq_no"); set => Q("if_seq_no", value); } /// /// Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit /// document ID /// public OpType? OpType { get => Q("op_type"); set => Q("op_type", value); } ///The pipeline id to preprocess incoming documents with public string Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } /// /// If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this /// operation visible to search, if `false` (the default) then do nothing with refreshes. /// public Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///When true, requires destination to be an alias. Default is false public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } ///Specific routing value public string Routing { get => Q("routing"); set => Q("routing", value); } ///Explicit operation timeout public TimeSpan Timeout { get => Q("timeout"); set => Q("timeout", value); } ///Explicit version number for concurrency control public long? Version { get => Q("version"); set => Q("version", value); } ///Specific version type public VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// /// Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard /// only. 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) /// public string WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } ///Request options for RootNodeInfo https://opensearch.org/docs/latest/opensearch/index/ public class RootNodeInfoRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.GET; public override bool SupportsBody => false; } ///Request options for MultiGet https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/multi-get/ public class MultiGetRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; ///Specify the node or shard the operation should be performed on (default: random) public string Preference { get => Q("preference"); set => Q("preference", value); } ///Specify whether to perform the operation in realtime or search mode public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } ///Refresh the shard containing the document before performing the operation public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///Specific routing value public string Routing { get => Q("routing"); set => Q("routing", value); } ///True or false to return the _source field or not, or a list of fields to return public bool? SourceEnabled { get => Q("_source"); set => Q("_source", value); } ///A list of fields to exclude from the returned _source field public string[] SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } ///A list of fields to extract and return from the _source field public string[] SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } ///A comma-separated list of stored fields to return in the response public string[] StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } } ///Request options for MultiSearch https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/ public class MultiSearchRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; ///Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } ///Controls the maximum number of concurrent searches the multi search api will execute public long? MaxConcurrentSearches { get => Q("max_concurrent_searches"); set => Q("max_concurrent_searches", value); } /// /// The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of /// the search on the cluster in order to limit the number of concurrent shard requests /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } /// /// A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search /// request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can /// not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are /// disjoint. /// public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } ///Search operation type public SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } ///Indicates whether hits.total should be rendered as an integer or an object in the rest search response public bool? TotalHitsAsInteger { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } ///Specify whether aggregation and suggester names should be prefixed by their respective types in the response public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } ///Request options for MultiSearchTemplate https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/ public class MultiSearchTemplateRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; ///Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } ///Controls the maximum number of concurrent searches the multi search api will execute public long? MaxConcurrentSearches { get => Q("max_concurrent_searches"); set => Q("max_concurrent_searches", value); } ///Search operation type public SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } ///Indicates whether hits.total should be rendered as an integer or an object in the rest search response public bool? TotalHitsAsInteger { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } ///Specify whether aggregation and suggester names should be prefixed by their respective types in the response public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } ///Request options for MultiTermVectors public class MultiTermVectorsRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; /// /// Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned /// documents unless otherwise specified in body "params" or "docs". /// public bool? FieldStatistics { get => Q("field_statistics"); set => Q("field_statistics", value); } ///A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs". public string[] Fields { get => Q("fields"); set => Q("fields", value); } ///Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". public bool? Offsets { get => Q("offsets"); set => Q("offsets", value); } ///Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". public bool? Payloads { get => Q("payloads"); set => Q("payloads", value); } ///Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". public bool? Positions { get => Q("positions"); set => Q("positions", value); } /// /// Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise /// specified in body "params" or "docs". /// public string Preference { get => Q("preference"); set => Q("preference", value); } ///Specifies if requests are real-time as opposed to near-real-time (default: true). public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } ///Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs". public string Routing { get => Q("routing"); set => Q("routing", value); } /// /// Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified /// in body "params" or "docs". /// public bool? TermStatistics { get => Q("term_statistics"); set => Q("term_statistics", value); } ///Explicit version number for concurrency control public long? Version { get => Q("version"); set => Q("version", value); } ///Specific version type public VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } ///Request options for Ping https://opensearch.org/docs/latest/opensearch/index/ public class PingRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.HEAD; public override bool SupportsBody => false; } ///Request options for PutScript public class PutScriptRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.PUT; public override bool SupportsBody => true; ///Context name to compile script against public string Context { get => Q("context"); set => Q("context", value); } ///Specify timeout for connection to master node ///Deprecated as of OpenSearch 2.0, use instead public TimeSpan MasterTimeSpanout { get => Q("master_timeout"); set => Q("master_timeout", value); } ///Specify timeout for connection to cluster_manager node ///Introduced in OpenSearch 2.0 instead of public TimeSpan ClusterManagerTimeSpanout { get => Q("cluster_manager_timeout"); set => Q("cluster_manager_timeout", value); } ///Explicit operation timeout public TimeSpan Timeout { get => Q("timeout"); set => Q("timeout", value); } } ///Request options for RankEval public class RankEvalRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; /// /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have /// been specified) /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } ///Whether to expand wildcard expression to concrete indices that are open, closed or both. public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } ///Whether specified concrete indices should be ignored when unavailable (missing or closed) public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } ///Search operation type public SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } } ///Request options for ReindexOnServer https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/ public class ReindexOnServerRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; ///Should the affected indexes be refreshed? public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///The throttle to set on this request in sub-requests per second. -1 means no throttle. public long? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } ///Control how long to keep the search context alive public TimeSpan Scroll { get => Q("scroll"); set => Q("scroll", value); } ///The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. public long? Slices { get => Q("slices"); set => Q("slices", value); } ///Time each individual bulk request should wait for shards that are unavailable. public TimeSpan Timeout { get => Q("timeout"); set => Q("timeout", value); } /// /// Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard /// only. 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) /// public string WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } ///Should the request should block until the reindex is complete. public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } ///Request options for ReindexRethrottle https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/ public class ReindexRethrottleRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => false; ///The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. public long? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } ///Request options for RenderSearchTemplate https://opensearch.org/docs/latest/opensearch/search-template/ public class RenderSearchTemplateRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; } ///Request options for ExecutePainlessScript public class ExecutePainlessScriptRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; } ///Request options for Scroll https://opensearch.org/docs/latest/opensearch/rest-api/search/#request-body public class ScrollRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; ///Indicates whether hits.total should be rendered as an integer or an object in the rest search response public bool? TotalHitsAsInteger { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } } ///Request options for Search https://opensearch.org/docs/latest/opensearch/rest-api/search/ public class SearchRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; /// /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have /// been specified) /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } ///Indicate if an error should be returned if there is a partial search failure or timeout public bool? AllowPartialSearchResults { get => Q("allow_partial_search_results"); set => Q("allow_partial_search_results", value); } ///Specify whether wildcard and prefix queries should be analyzed (default: false) public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } ///The analyzer to use for the query string public string Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } /// /// The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism /// to reduce the memory overhead per search request if the potential number of shards in the request can be large. /// public long? BatchedReduceSize { get => Q("batched_reduce_size"); set => Q("batched_reduce_size", value); } ///Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } ///The default operator for query string query (AND or OR) public DefaultOperator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } ///The field to use as default where no field prefix is given in the query string public string Df { get => Q("df"); set => Q("df", value); } ///A comma-separated list of fields to return as the docvalue representation of a field for each hit public string[] DocValueFields { get => Q("docvalue_fields"); set => Q("docvalue_fields", value); } ///Whether to expand wildcard expression to concrete indices that are open, closed or both. public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } ///Whether specified concrete, expanded or aliased indices should be ignored when throttled public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } ///Whether specified concrete indices should be ignored when unavailable (missing or closed) public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } ///Specify whether format-based query failures (such as providing text to a numeric field) should be ignored public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } /// /// The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the /// search on the cluster in order to limit the number of concurrent shard requests /// public long? MaxConcurrentShardRequests { get => Q("max_concurrent_shard_requests"); set => Q("max_concurrent_shard_requests", value); } ///The minimum compatible version that all shards involved in search should have for this request to be successful public string MinCompatibleShardNode { get => Q("min_compatible_shard_node"); set => Q("min_compatible_shard_node", value); } /// /// A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search /// request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can /// not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are /// disjoint. /// public long? PreFilterShardSize { get => Q("pre_filter_shard_size"); set => Q("pre_filter_shard_size", value); } ///Specify the node or shard the operation should be performed on (default: random) public string Preference { get => Q("preference"); set => Q("preference", value); } ///Query in the Lucene query string syntax public string QueryOnQueryString { get => Q("q"); set => Q("q", value); } ///Specify if request cache should be used for this request or not, defaults to index level setting public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } ///A comma-separated list of specific routing values public string[] Routing { get => Q("routing"); set => Q("routing", value); } ///Specify how long a consistent view of the index should be maintained for scrolled search public TimeSpan Scroll { get => Q("scroll"); set => Q("scroll", value); } ///Search operation type public SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } ///Specify whether to return sequence number and primary term of the last modification of each hit public bool? SequenceNumberPrimaryTerm { get => Q("seq_no_primary_term"); set => Q("seq_no_primary_term", value); } ///Specific 'tag' of the request for logging and statistical purposes public string[] Stats { get => Q("stats"); set => Q("stats", value); } ///A comma-separated list of stored fields to return as part of a hit public string[] StoredFields { get => Q("stored_fields"); set => Q("stored_fields", value); } ///Specify which field to use for suggestions public string SuggestField { get => Q("suggest_field"); set => Q("suggest_field", value); } ///Specify suggest mode public SuggestMode? SuggestMode { get => Q("suggest_mode"); set => Q("suggest_mode", value); } ///How many suggestions to return in response public long? SuggestSize { get => Q("suggest_size"); set => Q("suggest_size", value); } ///The source text for which the suggestions should be returned public string SuggestText { get => Q("suggest_text"); set => Q("suggest_text", value); } ///Indicates whether hits.total should be rendered as an integer or an object in the rest search response public bool? TotalHitsAsInteger { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } ///Indicate if the number of documents that match the query should be tracked public string TrackTotalHits { get => Q("track_total_hits"); set => Q("track_total_hits", value); } ///Specify whether aggregation and suggester names should be prefixed by their respective types in the response public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } ///Request options for SearchShards https://opensearch.org/docs/latest/security-plugin/access-control/cross-cluster-search/ public class SearchShardsRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => false; /// /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have /// been specified) /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } ///Whether to expand wildcard expression to concrete indices that are open, closed or both. public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } ///Whether specified concrete indices should be ignored when unavailable (missing or closed) public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } ///Return local information, do not retrieve the state from cluster_manager node (default: false) public bool? Local { get => Q("local"); set => Q("local", value); } ///Specify the node or shard the operation should be performed on (default: random) public string Preference { get => Q("preference"); set => Q("preference", value); } ///Specific routing value public string Routing { get => Q("routing"); set => Q("routing", value); } } ///Request options for SearchTemplate https://opensearch.org/docs/latest/opensearch/search-template/ public class SearchTemplateRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; /// /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have /// been specified) /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } ///Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution public bool? CcsMinimizeRoundtrips { get => Q("ccs_minimize_roundtrips"); set => Q("ccs_minimize_roundtrips", value); } ///Whether to expand wildcard expression to concrete indices that are open, closed or both. public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } ///Specify whether to return detailed information about score computation as part of a hit public bool? Explain { get => Q("explain"); set => Q("explain", value); } ///Whether specified concrete, expanded or aliased indices should be ignored when throttled public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } ///Whether specified concrete indices should be ignored when unavailable (missing or closed) public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } ///Specify the node or shard the operation should be performed on (default: random) public string Preference { get => Q("preference"); set => Q("preference", value); } ///Specify whether to profile the query execution public bool? Profile { get => Q("profile"); set => Q("profile", value); } ///A comma-separated list of specific routing values public string[] Routing { get => Q("routing"); set => Q("routing", value); } ///Specify how long a consistent view of the index should be maintained for scrolled search public TimeSpan Scroll { get => Q("scroll"); set => Q("scroll", value); } ///Search operation type public SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } ///Indicates whether hits.total should be rendered as an integer or an object in the rest search response public bool? TotalHitsAsInteger { get => Q("rest_total_hits_as_int"); set => Q("rest_total_hits_as_int", value); } ///Specify whether aggregation and suggester names should be prefixed by their respective types in the response public bool? TypedKeys { get => Q("typed_keys"); set => Q("typed_keys", value); } } ///Request options for TermVectors public class TermVectorsRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; ///Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. public bool? FieldStatistics { get => Q("field_statistics"); set => Q("field_statistics", value); } ///A comma-separated list of fields to return. public string[] Fields { get => Q("fields"); set => Q("fields", value); } ///Specifies if term offsets should be returned. public bool? Offsets { get => Q("offsets"); set => Q("offsets", value); } ///Specifies if term payloads should be returned. public bool? Payloads { get => Q("payloads"); set => Q("payloads", value); } ///Specifies if term positions should be returned. public bool? Positions { get => Q("positions"); set => Q("positions", value); } ///Specify the node or shard the operation should be performed on (default: random). public string Preference { get => Q("preference"); set => Q("preference", value); } ///Specifies if request is real-time as opposed to near-real-time (default: true). public bool? Realtime { get => Q("realtime"); set => Q("realtime", value); } ///Specific routing value. public string Routing { get => Q("routing"); set => Q("routing", value); } ///Specifies if total term frequency and document frequency should be returned. public bool? TermStatistics { get => Q("term_statistics"); set => Q("term_statistics", value); } ///Explicit version number for concurrency control public long? Version { get => Q("version"); set => Q("version", value); } ///Specific version type public VersionType? VersionType { get => Q("version_type"); set => Q("version_type", value); } } ///Request options for Update https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-document/ public class UpdateRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; ///only perform the update operation if the last operation that has changed the document has the specified primary term public long? IfPrimaryTerm { get => Q("if_primary_term"); set => Q("if_primary_term", value); } ///only perform the update operation if the last operation that has changed the document has the specified sequence number public long? IfSequenceNumber { get => Q("if_seq_no"); set => Q("if_seq_no", value); } ///The script language (default: painless) public string Lang { get => Q("lang"); set => Q("lang", value); } /// /// If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this /// operation visible to search, if `false` (the default) then do nothing with refreshes. /// public Refresh? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///When true, requires destination is an alias. Default is false public bool? RequireAlias { get => Q("require_alias"); set => Q("require_alias", value); } ///Specify how many times should the operation be retried when a conflict occurs (default: 0) public long? RetryOnConflict { get => Q("retry_on_conflict"); set => Q("retry_on_conflict", value); } ///Specific routing value public string Routing { get => Q("routing"); set => Q("routing", value); } ///True or false to return the _source field or not, or a list of fields to return public bool? SourceEnabled { get => Q("_source"); set => Q("_source", value); } ///Explicit operation timeout public TimeSpan Timeout { get => Q("timeout"); set => Q("timeout", value); } /// /// Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard /// only. 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) /// public string WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } } ///Request options for UpdateByQuery https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/ public class UpdateByQueryRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => true; /// /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have /// been specified) /// public bool? AllowNoIndices { get => Q("allow_no_indices"); set => Q("allow_no_indices", value); } ///Specify whether wildcard and prefix queries should be analyzed (default: false) public bool? AnalyzeWildcard { get => Q("analyze_wildcard"); set => Q("analyze_wildcard", value); } ///The analyzer to use for the query string public string Analyzer { get => Q("analyzer"); set => Q("analyzer", value); } ///What to do when the update by query hits version conflicts? public Conflicts? Conflicts { get => Q("conflicts"); set => Q("conflicts", value); } ///The default operator for query string query (AND or OR) public DefaultOperator? DefaultOperator { get => Q("default_operator"); set => Q("default_operator", value); } ///The field to use as default where no field prefix is given in the query string public string Df { get => Q("df"); set => Q("df", value); } ///Whether to expand wildcard expression to concrete indices that are open, closed or both. public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } ///Starting offset (default: 0) public long? From { get => Q("from"); set => Q("from", value); } ///Whether specified concrete indices should be ignored when unavailable (missing or closed) public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } ///Specify whether format-based query failures (such as providing text to a numeric field) should be ignored public bool? Lenient { get => Q("lenient"); set => Q("lenient", value); } ///Ingest pipeline to set on index requests made by this action. (default: none) public string Pipeline { get => Q("pipeline"); set => Q("pipeline", value); } ///Specify the node or shard the operation should be performed on (default: random) public string Preference { get => Q("preference"); set => Q("preference", value); } ///Query in the Lucene query string syntax public string QueryOnQueryString { get => Q("q"); set => Q("q", value); } ///Should the affected indexes be refreshed? public bool? Refresh { get => Q("refresh"); set => Q("refresh", value); } ///Specify if request cache should be used for this request or not, defaults to index level setting public bool? RequestCache { get => Q("request_cache"); set => Q("request_cache", value); } ///The throttle to set on this request in sub-requests per second. -1 means no throttle. public long? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } ///A comma-separated list of specific routing values public string[] Routing { get => Q("routing"); set => Q("routing", value); } ///Specify how long a consistent view of the index should be maintained for scrolled search public TimeSpan Scroll { get => Q("scroll"); set => Q("scroll", value); } ///Size on the scroll request powering the update by query public long? ScrollSize { get => Q("scroll_size"); set => Q("scroll_size", value); } ///Explicit timeout for each search request. Defaults to no timeout. public TimeSpan SearchTimeout { get => Q("search_timeout"); set => Q("search_timeout", value); } ///Search operation type public SearchType? SearchType { get => Q("search_type"); set => Q("search_type", value); } ///The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. public long? Slices { get => Q("slices"); set => Q("slices", value); } ///A comma-separated list of <field>:<direction> pairs public string[] Sort { get => Q("sort"); set => Q("sort", value); } ///True or false to return the _source field or not, or a list of fields to return public bool? SourceEnabled { get => Q("_source"); set => Q("_source", value); } ///A list of fields to exclude from the returned _source field public string[] SourceExcludes { get => Q("_source_excludes"); set => Q("_source_excludes", value); } ///A list of fields to extract and return from the _source field public string[] SourceIncludes { get => Q("_source_includes"); set => Q("_source_includes", value); } ///Specific 'tag' of the request for logging and statistical purposes public string[] Stats { get => Q("stats"); set => Q("stats", value); } ///The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. public long? TerminateAfter { get => Q("terminate_after"); set => Q("terminate_after", value); } ///Time each individual bulk request should wait for shards that are unavailable. public TimeSpan Timeout { get => Q("timeout"); set => Q("timeout", value); } ///Specify whether to return document version as part of a hit public bool? Version { get => Q("version"); set => Q("version", value); } ///Should the document increment the version number (internal) on hit or not (reindex) public bool? VersionType { get => Q("version_type"); set => Q("version_type", value); } /// /// Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the /// primary shard only. 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) /// public string WaitForActiveShards { get => Q("wait_for_active_shards"); set => Q("wait_for_active_shards", value); } ///Should the request should block until the update by query operation is complete. public bool? WaitForCompletion { get => Q("wait_for_completion"); set => Q("wait_for_completion", value); } } ///Request options for UpdateByQueryRethrottle https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/ public class UpdateByQueryRethrottleRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.POST; public override bool SupportsBody => false; ///The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. public long? RequestsPerSecond { get => Q("requests_per_second"); set => Q("requests_per_second", value); } } }