/* 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.ClusterApi
{
///<summary>Request options for AllocationExplain <para>https://opensearch.org/docs/latest/opensearch/rest-api/cluster-allocation/</para></summary>
public class ClusterAllocationExplainRequestParameters : RequestParameters<ClusterAllocationExplainRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => true;
///<summary>Return information about disk usage and shard sizes (default: false)</summary>
public bool? IncludeDiskInfo
{
get => Q<bool? >("include_disk_info");
set => Q("include_disk_info", value);
}
///<summary>Return 'YES' decisions in explanation (default: false)</summary>
public bool? IncludeYesDecisions
{
get => Q<bool? >("include_yes_decisions");
set => Q("include_yes_decisions", value);
}
}
///<summary>Request options for DeleteComponentTemplate <para>https://opensearch.org/docs/latest/opensearch/index-templates/</para></summary>
public class DeleteComponentTemplateRequestParameters : RequestParameters<DeleteComponentTemplateRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.DELETE;
public override bool SupportsBody => false;
///<summary>Specify timeout for connection to master node</summary>
///<remarks>Deprecated as of OpenSearch 2.0, use <see cref="ClusterManagerTimeSpanout"/> instead</remarks>
public TimeSpan MasterTimeSpanout
{
get => Q<TimeSpan>("master_timeout");
set => Q("master_timeout", value);
}
///<summary>Specify timeout for connection to cluster_manager node</summary>
///<remarks>Introduced in OpenSearch 2.0 instead of <see cref="MasterTimeSpanout"/></remarks>
public TimeSpan ClusterManagerTimeSpanout
{
get => Q<TimeSpan>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
///<summary>Explicit operation timeout</summary>
public TimeSpan Timeout
{
get => Q<TimeSpan>("timeout");
set => Q("timeout", value);
}
}
///<summary>Request options for DeleteVotingConfigExclusions <para></para></summary>
public class DeleteVotingConfigExclusionsRequestParameters : RequestParameters<DeleteVotingConfigExclusionsRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.DELETE;
public override bool SupportsBody => false;
///<summary>Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list.</summary>
public bool? WaitForRemoval
{
get => Q<bool? >("wait_for_removal");
set => Q("wait_for_removal", value);
}
}
///<summary>Request options for ExistsComponentTemplate <para>https://opensearch.org/docs/latest/opensearch/index-templates/</para></summary>
public class ExistsComponentTemplateRequestParameters : RequestParameters<ExistsComponentTemplateRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.HEAD;
public override bool SupportsBody => false;
///<summary>Return local information, do not retrieve the state from cluster_manager node (default: false)</summary>
public bool? Local
{
get => Q<bool? >("local");
set => Q("local", value);
}
///<summary>Explicit operation timeout for connection to master node</summary>
///<remarks>Deprecated as of OpenSearch 2.0, use <see cref="ClusterManagerTimeSpanout"/> instead</remarks>
public TimeSpan MasterTimeSpanout
{
get => Q<TimeSpan>("master_timeout");
set => Q("master_timeout", value);
}
///<summary>Explicit operation timeout for connection to cluster_manager node</summary>
///<remarks>Introduced in OpenSearch 2.0 instead of <see cref="MasterTimeSpanout"/></remarks>
public TimeSpan ClusterManagerTimeSpanout
{
get => Q<TimeSpan>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
}
///<summary>Request options for GetComponentTemplate <para>https://opensearch.org/docs/latest/opensearch/index-templates/</para></summary>
public class GetComponentTemplateRequestParameters : RequestParameters<GetComponentTemplateRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///<summary>Return local information, do not retrieve the state from cluster_manager node (default: false)</summary>
public bool? Local
{
get => Q<bool? >("local");
set => Q("local", value);
}
///<summary>Explicit operation timeout for connection to master node</summary>
///<remarks>Deprecated as of OpenSearch 2.0, use <see cref="ClusterManagerTimeSpanout"/> instead</remarks>
public TimeSpan MasterTimeSpanout
{
get => Q<TimeSpan>("master_timeout");
set => Q("master_timeout", value);
}
///<summary>Explicit operation timeout for connection to cluster_manager node</summary>
///<remarks>Introduced in OpenSearch 2.0 instead of <see cref="MasterTimeSpanout"/></remarks>
public TimeSpan ClusterManagerTimeSpanout
{
get => Q<TimeSpan>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
}
///<summary>Request options for GetSettings <para>https://opensearch.org/docs/latest/opensearch/rest-api/cluster-settings/</para></summary>
public class ClusterGetSettingsRequestParameters : RequestParameters<ClusterGetSettingsRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///<summary>Return settings in flat format (default: false)</summary>
public bool? FlatSettings
{
get => Q<bool? >("flat_settings");
set => Q("flat_settings", value);
}
///<summary>Whether to return all default clusters setting.</summary>
public bool? IncludeDefaults
{
get => Q<bool? >("include_defaults");
set => Q("include_defaults", value);
}
///<summary>Explicit operation timeout for connection to master node</summary>
///<remarks>Deprecated as of OpenSearch 2.0, use <see cref="ClusterManagerTimeSpanout"/> instead</remarks>
public TimeSpan MasterTimeSpanout
{
get => Q<TimeSpan>("master_timeout");
set => Q("master_timeout", value);
}
///<summary>Explicit operation timeout for connection to cluster_manager node</summary>
///<remarks>Introduced in OpenSearch 2.0 instead of <see cref="MasterTimeSpanout"/></remarks>
public TimeSpan ClusterManagerTimeSpanout
{
get => Q<TimeSpan>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
///<summary>Explicit operation timeout</summary>
public TimeSpan Timeout
{
get => Q<TimeSpan>("timeout");
set => Q("timeout", value);
}
}
///<summary>Request options for Health <para>https://opensearch.org/docs/latest/opensearch/rest-api/cluster-health/</para></summary>
public class ClusterHealthRequestParameters : RequestParameters<ClusterHealthRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///<summary>Whether to expand wildcard expression to concrete indices that are open, closed or both.</summary>
public ExpandWildcards? ExpandWildcards
{
get => Q<ExpandWildcards? >("expand_wildcards");
set => Q("expand_wildcards", value);
}
///<summary>Specify the level of detail for returned information</summary>
public Level? Level
{
get => Q<Level? >("level");
set => Q("level", value);
}
///<summary>Return local information, do not retrieve the state from cluster_manager node (default: false)</summary>
public bool? Local
{
get => Q<bool? >("local");
set => Q("local", value);
}
///<summary>Explicit operation timeout for connection to master node</summary>
///<remarks>Deprecated as of OpenSearch 2.0, use <see cref="ClusterManagerTimeSpanout"/> instead</remarks>
public TimeSpan MasterTimeSpanout
{
get => Q<TimeSpan>("master_timeout");
set => Q("master_timeout", value);
}
///<summary>Explicit operation timeout for connection to cluster_manager node</summary>
///<remarks>Introduced in OpenSearch 2.0 instead of <see cref="MasterTimeSpanout"/></remarks>
public TimeSpan ClusterManagerTimeSpanout
{
get => Q<TimeSpan>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
///<summary>Explicit operation timeout</summary>
public TimeSpan Timeout
{
get => Q<TimeSpan>("timeout");
set => Q("timeout", value);
}
///<summary>Wait until the specified number of shards is active</summary>
public string WaitForActiveShards
{
get => Q<string>("wait_for_active_shards");
set => Q("wait_for_active_shards", value);
}
///<summary>Wait until all currently queued events with the given priority are processed</summary>
public WaitForEvents? WaitForEvents
{
get => Q<WaitForEvents? >("wait_for_events");
set => Q("wait_for_events", value);
}
///<summary>Whether to wait until there are no initializing shards in the cluster</summary>
public bool? WaitForNoInitializingShards
{
get => Q<bool? >("wait_for_no_initializing_shards");
set => Q("wait_for_no_initializing_shards", value);
}
///<summary>Whether to wait until there are no relocating shards in the cluster</summary>
public bool? WaitForNoRelocatingShards
{
get => Q<bool? >("wait_for_no_relocating_shards");
set => Q("wait_for_no_relocating_shards", value);
}
///<summary>Wait until the specified number of nodes is available</summary>
public string WaitForNodes
{
get => Q<string>("wait_for_nodes");
set => Q("wait_for_nodes", value);
}
///<summary>Wait until cluster is in a specific state</summary>
public WaitForStatus? WaitForStatus
{
get => Q<WaitForStatus? >("wait_for_status");
set => Q("wait_for_status", value);
}
}
///<summary>Request options for PendingTasks <para>https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-pending-tasks/</para></summary>
public class ClusterPendingTasksRequestParameters : RequestParameters<ClusterPendingTasksRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///<summary>Return local information, do not retrieve the state from cluster_manager node (default: false)</summary>
public bool? Local
{
get => Q<bool? >("local");
set => Q("local", value);
}
///<summary>Specify timeout for connection to master node</summary>
///<remarks>Deprecated as of OpenSearch 2.0, use <see cref="ClusterManagerTimeSpanout"/> instead</remarks>
public TimeSpan MasterTimeSpanout
{
get => Q<TimeSpan>("master_timeout");
set => Q("master_timeout", value);
}
///<summary>Specify timeout for connection to cluster_manager node</summary>
///<remarks>Introduced in OpenSearch 2.0 instead of <see cref="MasterTimeSpanout"/></remarks>
public TimeSpan ClusterManagerTimeSpanout
{
get => Q<TimeSpan>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
}
///<summary>Request options for PostVotingConfigExclusions <para></para></summary>
public class PostVotingConfigExclusionsRequestParameters : RequestParameters<PostVotingConfigExclusionsRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => false;
///<summary>
/// A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify
/// ?node_names.
///</summary>
public string NodeIds
{
get => Q<string>("node_ids");
set => Q("node_ids", value);
}
///<summary>
/// A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify
/// ?node_ids.
///</summary>
public string NodeNames
{
get => Q<string>("node_names");
set => Q("node_names", value);
}
///<summary>Explicit operation timeout</summary>
public TimeSpan Timeout
{
get => Q<TimeSpan>("timeout");
set => Q("timeout", value);
}
}
///<summary>Request options for PutComponentTemplate <para>https://opensearch.org/docs/latest/opensearch/index-templates/</para></summary>
public class PutComponentTemplateRequestParameters : RequestParameters<PutComponentTemplateRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
public override bool SupportsBody => true;
///<summary>Whether the index template should only be added if new or can also replace an existing one</summary>
public bool? Create
{
get => Q<bool? >("create");
set => Q("create", value);
}
///<summary>Specify timeout for connection to master node</summary>
///<remarks>Deprecated as of OpenSearch 2.0, use <see cref="ClusterManagerTimeSpanout"/> instead</remarks>
public TimeSpan MasterTimeSpanout
{
get => Q<TimeSpan>("master_timeout");
set => Q("master_timeout", value);
}
///<summary>Specify timeout for connection to cluster_manager node</summary>
///<remarks>Introduced in OpenSearch 2.0 instead of <see cref="MasterTimeSpanout"/></remarks>
public TimeSpan ClusterManagerTimeSpanout
{
get => Q<TimeSpan>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
///<summary>Explicit operation timeout</summary>
public TimeSpan Timeout
{
get => Q<TimeSpan>("timeout");
set => Q("timeout", value);
}
}
///<summary>Request options for PutSettings <para>https://opensearch.org/docs/latest/opensearch/rest-api/cluster-settings/</para></summary>
public class ClusterPutSettingsRequestParameters : RequestParameters<ClusterPutSettingsRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
public override bool SupportsBody => true;
///<summary>Return settings in flat format (default: false)</summary>
public bool? FlatSettings
{
get => Q<bool? >("flat_settings");
set => Q("flat_settings", value);
}
///<summary>Explicit operation timeout for connection to master node</summary>
///<remarks>Deprecated as of OpenSearch 2.0, use <see cref="ClusterManagerTimeSpanout"/> instead</remarks>
public TimeSpan MasterTimeSpanout
{
get => Q<TimeSpan>("master_timeout");
set => Q("master_timeout", value);
}
///<summary>Explicit operation timeout for connection to cluster_manager node</summary>
///<remarks>Introduced in OpenSearch 2.0 instead of <see cref="MasterTimeSpanout"/></remarks>
public TimeSpan ClusterManagerTimeSpanout
{
get => Q<TimeSpan>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
///<summary>Explicit operation timeout</summary>
public TimeSpan Timeout
{
get => Q<TimeSpan>("timeout");
set => Q("timeout", value);
}
}
///<summary>Request options for RemoteInfo <para>https://opensearch.org/docs/latest/opensearch/rest-api/remote-info/</para></summary>
public class RemoteInfoRequestParameters : RequestParameters<RemoteInfoRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
}
///<summary>Request options for Reroute <para></para></summary>
public class ClusterRerouteRequestParameters : RequestParameters<ClusterRerouteRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => true;
///<summary>Simulate the operation only and return the resulting state</summary>
public bool? DryRun
{
get => Q<bool? >("dry_run");
set => Q("dry_run", value);
}
///<summary>Return an explanation of why the commands can or cannot be executed</summary>
public bool? Explain
{
get => Q<bool? >("explain");
set => Q("explain", value);
}
///<summary>Explicit operation timeout for connection to master node</summary>
///<remarks>Deprecated as of OpenSearch 2.0, use <see cref="ClusterManagerTimeSpanout"/> instead</remarks>
public TimeSpan MasterTimeSpanout
{
get => Q<TimeSpan>("master_timeout");
set => Q("master_timeout", value);
}
///<summary>Explicit operation timeout for connection to cluster_manager node</summary>
///<remarks>Introduced in OpenSearch 2.0 instead of <see cref="MasterTimeSpanout"/></remarks>
public TimeSpan ClusterManagerTimeSpanout
{
get => Q<TimeSpan>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
///<summary>Limit the information returned to the specified metrics. Defaults to all but metadata</summary>
public string[] Metric
{
get => Q<string[]>("metric");
set => Q("metric", value);
}
///<summary>Retries allocation of shards that are blocked due to too many subsequent allocation failures</summary>
public bool? RetryFailed
{
get => Q<bool? >("retry_failed");
set => Q("retry_failed", value);
}
///<summary>Explicit operation timeout</summary>
public TimeSpan Timeout
{
get => Q<TimeSpan>("timeout");
set => Q("timeout", value);
}
}
///<summary>Request options for State <para></para></summary>
public class ClusterStateRequestParameters : RequestParameters<ClusterStateRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///<summary>
/// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have
/// been specified)
///</summary>
public bool? AllowNoIndices
{
get => Q<bool? >("allow_no_indices");
set => Q("allow_no_indices", value);
}
///<summary>Whether to expand wildcard expression to concrete indices that are open, closed or both.</summary>
public ExpandWildcards? ExpandWildcards
{
get => Q<ExpandWildcards? >("expand_wildcards");
set => Q("expand_wildcards", value);
}
///<summary>Return settings in flat format (default: false)</summary>
public bool? FlatSettings
{
get => Q<bool? >("flat_settings");
set => Q("flat_settings", value);
}
///<summary>Whether specified concrete indices should be ignored when unavailable (missing or closed)</summary>
public bool? IgnoreUnavailable
{
get => Q<bool? >("ignore_unavailable");
set => Q("ignore_unavailable", value);
}
///<summary>Return local information, do not retrieve the state from cluster_manager node (default: false)</summary>
public bool? Local
{
get => Q<bool? >("local");
set => Q("local", value);
}
///<summary>Specify timeout for connection to master node</summary>
///<remarks>Deprecated as of OpenSearch 2.0, use <see cref="ClusterManagerTimeSpanout"/> instead</remarks>
public TimeSpan MasterTimeSpanout
{
get => Q<TimeSpan>("master_timeout");
set => Q("master_timeout", value);
}
///<summary>Specify timeout for connection to cluster_manager node</summary>
///<remarks>Introduced in OpenSearch 2.0 instead of <see cref="MasterTimeSpanout"/></remarks>
public TimeSpan ClusterManagerTimeSpanout
{
get => Q<TimeSpan>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
///<summary>Wait for the metadata version to be equal or greater than the specified metadata version</summary>
public long? WaitForMetadataVersion
{
get => Q<long? >("wait_for_metadata_version");
set => Q("wait_for_metadata_version", value);
}
///<summary>The maximum time to wait for wait_for_metadata_version before timing out</summary>
public TimeSpan WaitForTimeout
{
get => Q<TimeSpan>("wait_for_timeout");
set => Q("wait_for_timeout", value);
}
}
///<summary>Request options for Stats <para></para></summary>
public class ClusterStatsRequestParameters : RequestParameters<ClusterStatsRequestParameters>
{
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
///<summary>Return settings in flat format (default: false)</summary>
public bool? FlatSettings
{
get => Q<bool? >("flat_settings");
set => Q("flat_settings", value);
}
///<summary>Explicit operation timeout</summary>
public TimeSpan Timeout
{
get => Q<TimeSpan>("timeout");
set => Q("timeout", value);
}
}
}