/* 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.Collections.Specialized;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using OpenSearch.Net;
using static OpenSearch.Net.HttpMethod;
// ReSharper disable InterpolatedStringExpressionIsNotIFormattable
// ReSharper disable once CheckNamespace
// ReSharper disable InterpolatedStringExpressionIsNotIFormattable
// ReSharper disable RedundantExtendsListEntry
namespace OpenSearch.Net.Specification.ClusterApi
{
///
/// Cluster APIs.
/// Not intended to be instantiated directly. Use the property
/// on .
///
///
public partial class LowLevelClusterNamespace : NamespacedClientProxy
{
internal LowLevelClusterNamespace(OpenSearchLowLevelClient client): base(client)
{
}
///POST on /_cluster/allocation/explain https://opensearch.org/docs/latest/opensearch/rest-api/cluster-allocation/
///The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse AllocationExplain(PostData body, ClusterAllocationExplainRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, "_cluster/allocation/explain", body, RequestParams(requestParameters));
///POST on /_cluster/allocation/explain https://opensearch.org/docs/latest/opensearch/rest-api/cluster-allocation/
///The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.allocation_explain", "body")]
public Task AllocationExplainAsync(PostData body, ClusterAllocationExplainRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, "_cluster/allocation/explain", ctx, body, RequestParams(requestParameters));
///DELETE on /_component_template/{name} https://opensearch.org/docs/latest/opensearch/index-templates/
///The name of the template
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse DeleteComponentTemplate(string name, DeleteComponentTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(DELETE, Url($"_component_template/{name:name}"), null, RequestParams(requestParameters));
///DELETE on /_component_template/{name} https://opensearch.org/docs/latest/opensearch/index-templates/
///The name of the template
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.delete_component_template", "name")]
public Task DeleteComponentTemplateAsync(string name, DeleteComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(DELETE, Url($"_component_template/{name:name}"), ctx, null, RequestParams(requestParameters));
///DELETE on /_cluster/voting_config_exclusions
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse DeleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(DELETE, "_cluster/voting_config_exclusions", null, RequestParams(requestParameters));
///DELETE on /_cluster/voting_config_exclusions
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.delete_voting_config_exclusions", "")]
public Task DeleteVotingConfigExclusionsAsync(DeleteVotingConfigExclusionsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(DELETE, "_cluster/voting_config_exclusions", ctx, null, RequestParams(requestParameters));
///HEAD on /_component_template/{name} https://opensearch.org/docs/latest/opensearch/index-templates/
///The name of the template
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse ExistsComponentTemplate(string name, ExistsComponentTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(HEAD, Url($"_component_template/{name:name}"), null, RequestParams(requestParameters));
///HEAD on /_component_template/{name} https://opensearch.org/docs/latest/opensearch/index-templates/
///The name of the template
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.exists_component_template", "name")]
public Task ExistsComponentTemplateAsync(string name, ExistsComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(HEAD, Url($"_component_template/{name:name}"), ctx, null, RequestParams(requestParameters));
///GET on /_component_template https://opensearch.org/docs/latest/opensearch/index-templates/
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetComponentTemplate(GetComponentTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_component_template", null, RequestParams(requestParameters));
///GET on /_component_template https://opensearch.org/docs/latest/opensearch/index-templates/
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.get_component_template", "")]
public Task GetComponentTemplateAsync(GetComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_component_template", ctx, null, RequestParams(requestParameters));
///GET on /_component_template/{name} https://opensearch.org/docs/latest/opensearch/index-templates/
///The comma separated names of the component templates
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetComponentTemplate(string name, GetComponentTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"_component_template/{name:name}"), null, RequestParams(requestParameters));
///GET on /_component_template/{name} https://opensearch.org/docs/latest/opensearch/index-templates/
///The comma separated names of the component templates
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.get_component_template", "name")]
public Task GetComponentTemplateAsync(string name, GetComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"_component_template/{name:name}"), ctx, null, RequestParams(requestParameters));
///GET on /_cluster/settings https://opensearch.org/docs/latest/opensearch/rest-api/cluster-settings/
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetSettings(ClusterGetSettingsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_cluster/settings", null, RequestParams(requestParameters));
///GET on /_cluster/settings https://opensearch.org/docs/latest/opensearch/rest-api/cluster-settings/
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.get_settings", "")]
public Task GetSettingsAsync(ClusterGetSettingsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_cluster/settings", ctx, null, RequestParams(requestParameters));
///GET on /_cluster/health https://opensearch.org/docs/latest/opensearch/rest-api/cluster-health/
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Health(ClusterHealthRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_cluster/health", null, RequestParams(requestParameters));
///GET on /_cluster/health https://opensearch.org/docs/latest/opensearch/rest-api/cluster-health/
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.health", "")]
public Task HealthAsync(ClusterHealthRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_cluster/health", ctx, null, RequestParams(requestParameters));
///GET on /_cluster/health/{index} https://opensearch.org/docs/latest/opensearch/rest-api/cluster-health/
///Limit the information returned to a specific index
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Health(string index, ClusterHealthRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"_cluster/health/{index:index}"), null, RequestParams(requestParameters));
///GET on /_cluster/health/{index} https://opensearch.org/docs/latest/opensearch/rest-api/cluster-health/
///Limit the information returned to a specific index
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.health", "index")]
public Task HealthAsync(string index, ClusterHealthRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"_cluster/health/{index:index}"), ctx, null, RequestParams(requestParameters));
///GET on /_cluster/pending_tasks https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-pending-tasks/
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse PendingTasks(ClusterPendingTasksRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_cluster/pending_tasks", null, RequestParams(requestParameters));
///GET on /_cluster/pending_tasks https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-pending-tasks/
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.pending_tasks", "")]
public Task PendingTasksAsync(ClusterPendingTasksRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_cluster/pending_tasks", ctx, null, RequestParams(requestParameters));
///POST on /_cluster/voting_config_exclusions
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse PostVotingConfigExclusions(PostVotingConfigExclusionsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, "_cluster/voting_config_exclusions", null, RequestParams(requestParameters));
///POST on /_cluster/voting_config_exclusions
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.post_voting_config_exclusions", "")]
public Task PostVotingConfigExclusionsAsync(PostVotingConfigExclusionsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, "_cluster/voting_config_exclusions", ctx, null, RequestParams(requestParameters));
///PUT on /_component_template/{name} https://opensearch.org/docs/latest/opensearch/index-templates/
///The name of the template
///The template definition
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse PutComponentTemplate(string name, PostData body, PutComponentTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(PUT, Url($"_component_template/{name:name}"), body, RequestParams(requestParameters));
///PUT on /_component_template/{name} https://opensearch.org/docs/latest/opensearch/index-templates/
///The name of the template
///The template definition
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.put_component_template", "name, body")]
public Task PutComponentTemplateAsync(string name, PostData body, PutComponentTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(PUT, Url($"_component_template/{name:name}"), ctx, body, RequestParams(requestParameters));
///PUT on /_cluster/settings https://opensearch.org/docs/latest/opensearch/rest-api/cluster-settings/
///The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse PutSettings(PostData body, ClusterPutSettingsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(PUT, "_cluster/settings", body, RequestParams(requestParameters));
///PUT on /_cluster/settings https://opensearch.org/docs/latest/opensearch/rest-api/cluster-settings/
///The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.put_settings", "body")]
public Task PutSettingsAsync(PostData body, ClusterPutSettingsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(PUT, "_cluster/settings", ctx, body, RequestParams(requestParameters));
///GET on /_remote/info https://opensearch.org/docs/latest/opensearch/rest-api/remote-info/
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse RemoteInfo(RemoteInfoRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_remote/info", null, RequestParams(requestParameters));
///GET on /_remote/info https://opensearch.org/docs/latest/opensearch/rest-api/remote-info/
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.remote_info", "")]
public Task RemoteInfoAsync(RemoteInfoRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_remote/info", ctx, null, RequestParams(requestParameters));
///POST on /_cluster/reroute
///The definition of `commands` to perform (`move`, `cancel`, `allocate`)
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Reroute(PostData body, ClusterRerouteRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, "_cluster/reroute", body, RequestParams(requestParameters));
///POST on /_cluster/reroute
///The definition of `commands` to perform (`move`, `cancel`, `allocate`)
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.reroute", "body")]
public Task RerouteAsync(PostData body, ClusterRerouteRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, "_cluster/reroute", ctx, body, RequestParams(requestParameters));
///GET on /_cluster/state
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse State(ClusterStateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_cluster/state", null, RequestParams(requestParameters));
///GET on /_cluster/state
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.state", "")]
public Task StateAsync(ClusterStateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_cluster/state", ctx, null, RequestParams(requestParameters));
///GET on /_cluster/state/{metric}
///Limit the information returned to the specified metrics
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse State(string metric, ClusterStateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"_cluster/state/{metric:metric}"), null, RequestParams(requestParameters));
///GET on /_cluster/state/{metric}
///Limit the information returned to the specified metrics
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.state", "metric")]
public Task StateAsync(string metric, ClusterStateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"_cluster/state/{metric:metric}"), ctx, null, RequestParams(requestParameters));
///GET on /_cluster/state/{metric}/{index}
///Limit the information returned to the specified metrics
///A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse State(string metric, string index, ClusterStateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"_cluster/state/{metric:metric}/{index:index}"), null, RequestParams(requestParameters));
///GET on /_cluster/state/{metric}/{index}
///Limit the information returned to the specified metrics
///A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.state", "metric, index")]
public Task StateAsync(string metric, string index, ClusterStateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"_cluster/state/{metric:metric}/{index:index}"), ctx, null, RequestParams(requestParameters));
///GET on /_cluster/stats
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Stats(ClusterStatsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_cluster/stats", null, RequestParams(requestParameters));
///GET on /_cluster/stats
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.stats", "")]
public Task StatsAsync(ClusterStatsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_cluster/stats", ctx, null, RequestParams(requestParameters));
///GET on /_cluster/stats/nodes/{node_id}
///A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Stats(string nodeId, ClusterStatsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"_cluster/stats/nodes/{nodeId:nodeId}"), null, RequestParams(requestParameters));
///GET on /_cluster/stats/nodes/{node_id}
///A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cluster.stats", "node_id")]
public Task StatsAsync(string nodeId, ClusterStatsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"_cluster/stats/nodes/{nodeId:nodeId}"), ctx, null, RequestParams(requestParameters));
}
}