/* 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.Specification.IndicesApi
{
///Request options for AddBlock
public class AddIndexBlockRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
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);
}
///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 Analyze
public class AnalyzeRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => true;
///The name of the index to scope the operation
public string IndexQueryString
{
get => Q("index");
set => Q("index", value);
}
}
///Request options for ClearCache
public class ClearCacheRequestParameters : 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);
}
///Clear field data
public bool? Fielddata
{
get => Q("fielddata");
set => Q("fielddata", value);
}
///A comma-separated list of fields to clear when using the `fielddata` parameter (default: all)
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);
}
///A comma-separated list of index name to limit the operation
public string[] IndexQueryString
{
get => Q("index");
set => Q("index", value);
}
///Clear query caches
public bool? Query
{
get => Q("query");
set => Q("query", value);
}
///Clear request cache
public bool? Request
{
get => Q("request");
set => Q("request", value);
}
}
///Request options for Clone https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/clone/
public class CloneIndexRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
public override bool SupportsBody => true;
///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);
}
///Set the number of active shards to wait for on the cloned index before the operation returns.
public string WaitForActiveShards
{
get => Q("wait_for_active_shards");
set => Q("wait_for_active_shards", value);
}
}
///Request options for Close https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/close-index/
public class CloseIndexRequestParameters : 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);
}
///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);
}
///
/// Sets the number of active shards to wait for before the operation returns. Set to `index-setting` to wait according to the index setting
/// `index.write.wait_for_active_shards`, or `all` to wait for all shards, or an integer. Defaults to `0`.
///
public string WaitForActiveShards
{
get => Q("wait_for_active_shards");
set => Q("wait_for_active_shards", value);
}
}
///Request options for Create https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/
public class CreateIndexRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
public override bool SupportsBody => true;
///Whether a type should be expected in the body of the mappings.
///Deprecated as of OpenSearch 2.0
public bool? IncludeTypeName
{
get => Q("include_type_name");
set => Q("include_type_name", 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);
}
///Set the number of active shards to wait for before the operation returns.
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/index-apis/delete-index/
public class DeleteIndexRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.DELETE;
public override bool SupportsBody => false;
///Ignore if a wildcard expression resolves to no concrete indices (default: false)
public bool? AllowNoIndices
{
get => Q("allow_no_indices");
set => Q("allow_no_indices", value);
}
///Whether wildcard expressions should get expanded to open or closed indices (default: open)
public ExpandWildcards? ExpandWildcards
{
get => Q("expand_wildcards");
set => Q("expand_wildcards", value);
}
///Ignore unavailable indexes (default: false)
public bool? IgnoreUnavailable
{
get => Q("ignore_unavailable");
set => Q("ignore_unavailable", 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 DeleteAlias https://opensearch.org/docs/latest/opensearch/rest-api/alias/
public class DeleteAliasRequestParameters : 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 timestamp for the document
public TimeSpan Timeout
{
get => Q("timeout");
set => Q("timeout", value);
}
}
///Request options for DeleteTemplateV2 https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
public class DeleteIndexTemplateV2RequestParameters : 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 DeleteTemplate https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
public class DeleteIndexTemplateRequestParameters : 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 Exists https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/
public class IndexExistsRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.HEAD;
public override bool SupportsBody => false;
///Ignore if a wildcard expression resolves to no concrete indices (default: false)
public bool? AllowNoIndices
{
get => Q("allow_no_indices");
set => Q("allow_no_indices", value);
}
///Whether wildcard expressions should get expanded to open or closed indices (default: open)
public ExpandWildcards? ExpandWildcards
{
get => Q("expand_wildcards");
set => Q("expand_wildcards", value);
}
///Return settings in flat format (default: false)
public bool? FlatSettings
{
get => Q("flat_settings");
set => Q("flat_settings", value);
}
///Ignore unavailable indexes (default: false)
public bool? IgnoreUnavailable
{
get => Q("ignore_unavailable");
set => Q("ignore_unavailable", value);
}
///Whether to return all default setting for each of the indices.
public bool? IncludeDefaults
{
get => Q("include_defaults");
set => Q("include_defaults", 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);
}
}
///Request options for AliasExists https://opensearch.org/docs/latest/opensearch/rest-api/alias/
public class AliasExistsRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.HEAD;
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);
}
}
///Request options for ExistsTemplate https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
public class ExistsIndexTemplateRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.HEAD;
public override bool SupportsBody => false;
///Return settings in flat format (default: false)
public bool? FlatSettings
{
get => Q("flat_settings");
set => Q("flat_settings", 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);
}
///Explicit operation 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);
}
///Explicit operation 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 TemplateExists https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
public class IndexTemplateExistsRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.HEAD;
public override bool SupportsBody => false;
///Return settings in flat format (default: false)
public bool? FlatSettings
{
get => Q("flat_settings");
set => Q("flat_settings", 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);
}
///Explicit operation 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);
}
///Explicit operation 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 TypeExists https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/
///Deprecated as of OpenSearch 2.0
public class TypeExistsRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.HEAD;
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);
}
}
///Request options for Flush
public class FlushRequestParameters : 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 a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if
/// transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
///
public bool? Force
{
get => Q("force");
set => Q("force", 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);
}
///
/// If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default
/// is true. If set to false the flush will be skipped iff if another flush operation is already running.
///
public bool? WaitIfOngoing
{
get => Q("wait_if_ongoing");
set => Q("wait_if_ongoing", value);
}
}
///Request options for SyncedFlush
public class SyncedFlushRequestParameters : 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);
}
}
///Request options for ForceMerge
public class ForceMergeRequestParameters : 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);
}
///Specify whether the index should be flushed after performing the operation (default: true)
public bool? Flush
{
get => Q("flush");
set => Q("flush", 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);
}
///The number of segments the index should be merged into (default: dynamic)
public long? MaxNumSegments
{
get => Q("max_num_segments");
set => Q("max_num_segments", value);
}
///Specify whether the operation should only expunge deleted documents
public bool? OnlyExpungeDeletes
{
get => Q("only_expunge_deletes");
set => Q("only_expunge_deletes", value);
}
}
///Request options for Get https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/get-index/
public class GetIndexRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///Ignore if a wildcard expression resolves to no concrete indices (default: false)
public bool? AllowNoIndices
{
get => Q("allow_no_indices");
set => Q("allow_no_indices", value);
}
///Whether wildcard expressions should get expanded to open or closed indices (default: open)
public ExpandWildcards? ExpandWildcards
{
get => Q("expand_wildcards");
set => Q("expand_wildcards", value);
}
///Return settings in flat format (default: false)
public bool? FlatSettings
{
get => Q("flat_settings");
set => Q("flat_settings", value);
}
///Ignore unavailable indexes (default: false)
public bool? IgnoreUnavailable
{
get => Q("ignore_unavailable");
set => Q("ignore_unavailable", value);
}
///Whether to return all default setting for each of the indices.
public bool? IncludeDefaults
{
get => Q("include_defaults");
set => Q("include_defaults", value);
}
///Whether to add the type name to the response (default: false)
///Deprecated as of OpenSearch 2.0
public bool? IncludeTypeName
{
get => Q("include_type_name");
set => Q("include_type_name", 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 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 GetAlias https://opensearch.org/docs/latest/opensearch/rest-api/alias/
public class GetAliasRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
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);
}
}
///Request options for GetFieldMapping https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
public class GetFieldMappingRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
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);
}
///Whether the default mapping values should be returned as well
public bool? IncludeDefaults
{
get => Q("include_defaults");
set => Q("include_defaults", value);
}
///Whether a type should be returned in the body of the mappings.
///Deprecated as of OpenSearch 2.0
public bool? IncludeTypeName
{
get => Q("include_type_name");
set => Q("include_type_name", 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);
}
}
///Request options for GetTemplateV2 https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
public class GetIndexTemplateV2RequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///Return settings in flat format (default: false)
public bool? FlatSettings
{
get => Q("flat_settings");
set => Q("flat_settings", 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);
}
///Explicit operation 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);
}
///Explicit operation 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 GetMapping https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
public class GetMappingRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
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);
}
///Whether to add the type name to the response (default: false)
///Deprecated as of OpenSearch 2.0
public bool? IncludeTypeName
{
get => Q("include_type_name");
set => Q("include_type_name", 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);
}
}
///Request options for GetSettings
public class GetIndexSettingsRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
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);
}
///Return settings in flat format (default: false)
public bool? FlatSettings
{
get => Q("flat_settings");
set => Q("flat_settings", 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);
}
///Whether to return all default setting for each of the indices.
public bool? IncludeDefaults
{
get => Q("include_defaults");
set => Q("include_defaults", 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 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 GetTemplate https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
public class GetIndexTemplateRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///Return settings in flat format (default: false)
public bool? FlatSettings
{
get => Q("flat_settings");
set => Q("flat_settings", value);
}
///Whether a type should be returned in the body of the mappings.
///Deprecated as of OpenSearch 2.0
public bool? IncludeTypeName
{
get => Q("include_type_name");
set => Q("include_type_name", 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);
}
///Explicit operation 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);
}
///Explicit operation 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 Open https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/close-index/
public class OpenIndexRequestParameters : 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);
}
///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);
}
///Sets the number of active shards to wait for before the operation returns.
public string WaitForActiveShards
{
get => Q("wait_for_active_shards");
set => Q("wait_for_active_shards", value);
}
}
///Request options for PutAlias https://opensearch.org/docs/latest/opensearch/rest-api/alias/
public class PutAliasRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
public override bool SupportsBody => true;
///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 timestamp for the document
public TimeSpan Timeout
{
get => Q("timeout");
set => Q("timeout", value);
}
}
///Request options for PutTemplateV2 https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
public class PutIndexTemplateV2RequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
public override bool SupportsBody => true;
///User defined reason for creating/updating the index template
public string Cause
{
get => Q("cause");
set => Q("cause", value);
}
///Whether the index template should only be added if new or can also replace an existing one
public bool? Create
{
get => Q("create");
set => Q("create", 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);
}
}
///Request options for PutMapping https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
public class PutMappingRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
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);
}
///Whether a type should be expected in the body of the mappings.
///Deprecated as of OpenSearch 2.0
public bool? IncludeTypeName
{
get => Q("include_type_name");
set => Q("include_type_name", 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);
}
///When true, applies mappings only to the write index of an alias
public bool? WriteIndexOnly
{
get => Q("write_index_only");
set => Q("write_index_only", value);
}
}
///Request options for UpdateSettings
public class UpdateIndexSettingsRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
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);
}
///Return settings in flat format (default: false)
public bool? FlatSettings
{
get => Q("flat_settings");
set => Q("flat_settings", 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 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);
}
///Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`
public bool? PreserveExisting
{
get => Q("preserve_existing");
set => Q("preserve_existing", value);
}
///Explicit operation timeout
public TimeSpan Timeout
{
get => Q("timeout");
set => Q("timeout", value);
}
}
///Request options for PutTemplate https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
public class PutIndexTemplateRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
public override bool SupportsBody => true;
///Whether the index template should only be added if new or can also replace an existing one
public bool? Create
{
get => Q("create");
set => Q("create", value);
}
///Whether a type should be returned in the body of the mappings.
///Deprecated as of OpenSearch 2.0
public bool? IncludeTypeName
{
get => Q("include_type_name");
set => Q("include_type_name", 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);
}
}
///Request options for RecoveryStatus
public class RecoveryStatusRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///Display only those recoveries that are currently on-going
public bool? ActiveOnly
{
get => Q("active_only");
set => Q("active_only", value);
}
///Whether to display detailed information about shard recovery
public bool? Detailed
{
get => Q("detailed");
set => Q("detailed", value);
}
}
///Request options for Refresh https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
public class RefreshRequestParameters : 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);
}
}
///Request options for Resolve
public class ResolveIndexRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///Whether wildcard expressions should get expanded to open or closed indices (default: open)
public ExpandWildcards? ExpandWildcards
{
get => Q("expand_wildcards");
set => Q("expand_wildcards", value);
}
}
///Request options for Rollover https://opensearch.org/docs/latest/opensearch/data-streams/#step-5-rollover-a-data-stream
public class RolloverIndexRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => true;
///If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false
public bool? DryRun
{
get => Q("dry_run");
set => Q("dry_run", value);
}
///Whether a type should be included in the body of the mappings.
///Deprecated as of OpenSearch 2.0
public bool? IncludeTypeName
{
get => Q("include_type_name");
set => Q("include_type_name", 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);
}
///Set the number of active shards to wait for on the newly created rollover index before the operation returns.
public string WaitForActiveShards
{
get => Q("wait_for_active_shards");
set => Q("wait_for_active_shards", value);
}
}
///Request options for Segments https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-segments/
public class SegmentsRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
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);
}
///Includes detailed memory usage by Lucene.
public bool? Verbose
{
get => Q("verbose");
set => Q("verbose", value);
}
}
///Request options for ShardStores
public class IndicesShardStoresRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
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);
}
///A comma-separated list of statuses used to filter on shards to get store information for
public string[] Status
{
get => Q("status");
set => Q("status", value);
}
}
///Request options for Shrink https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/shrink-index/
public class ShrinkIndexRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
public override bool SupportsBody => true;
///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);
}
///Set the number of active shards to wait for on the shrunken index before the operation returns.
public string WaitForActiveShards
{
get => Q("wait_for_active_shards");
set => Q("wait_for_active_shards", value);
}
}
///Request options for SimulateIndexTemplate https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
public class SimulateIndexTemplateRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => true;
///User defined reason for dry-run creating the new template for simulation purposes
public string Cause
{
get => Q("cause");
set => Q("cause", value);
}
///Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one
public bool? Create
{
get => Q("create");
set => Q("create", 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);
}
}
///Request options for SimulateTemplate https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
public class SimulateTemplateRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => true;
///User defined reason for dry-run creating the new template for simulation purposes
public string Cause
{
get => Q("cause");
set => Q("cause", value);
}
///Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one
public bool? Create
{
get => Q("create");
set => Q("create", 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);
}
}
///Request options for Split https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/split/
public class SplitIndexRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
public override bool SupportsBody => true;
///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);
}
///Set the number of active shards to wait for on the shrunken index before the operation returns.
public string WaitForActiveShards
{
get => Q("wait_for_active_shards");
set => Q("wait_for_active_shards", value);
}
}
///Request options for Stats https://opensearch.org/docs/latest/opensearch/stats-api/
public class IndicesStatsRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
public string[] CompletionFields
{
get => Q("completion_fields");
set => Q("completion_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);
}
///A comma-separated list of fields for `fielddata` index metric (supports wildcards)
public string[] FielddataFields
{
get => Q("fielddata_fields");
set => Q("fielddata_fields", value);
}
///A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
public string[] Fields
{
get => Q("fields");
set => Q("fields", value);
}
///If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices
public bool? ForbidClosedIndices
{
get => Q("forbid_closed_indices");
set => Q("forbid_closed_indices", value);
}
///A comma-separated list of search groups for `search` index metric
public string[] Groups
{
get => Q("groups");
set => Q("groups", value);
}
///Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
public bool? IncludeSegmentFileSizes
{
get => Q("include_segment_file_sizes");
set => Q("include_segment_file_sizes", value);
}
///If set to true segment stats will include stats for segments that are not currently loaded into memory
public bool? IncludeUnloadedSegments
{
get => Q("include_unloaded_segments");
set => Q("include_unloaded_segments", value);
}
///Return stats aggregated at cluster, index or shard level
public Level? Level
{
get => Q("level");
set => Q("level", value);
}
}
///Request options for BulkAlias https://opensearch.org/docs/latest/opensearch/rest-api/alias/
public class BulkAliasRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => true;
///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 timeout
public TimeSpan Timeout
{
get => Q("timeout");
set => Q("timeout", value);
}
}
///Request options for ValidateQuery
public class ValidateQueryRequestParameters : RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => true;
///Execute validation on all shards instead of one random shard per index
public bool? AllShards
{
get => Q("all_shards");
set => Q("all_shards", value);
}
///
/// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have
/// been specified)
///
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);
}
///