/* 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.IndicesApi
{
///
/// Indices APIs.
/// Not intended to be instantiated directly. Use the property
/// on .
///
///
public partial class LowLevelIndicesNamespace : NamespacedClientProxy
{
internal LowLevelIndicesNamespace(OpenSearchLowLevelClient client): base(client)
{
}
///PUT on /{index}/_block/{block}
///A comma separated list of indices to add a block to
///The block to add (one of read, write, read_only or metadata)
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse AddBlock(string index, string block, AddIndexBlockRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(PUT, Url($"{index:index}/_block/{block:block}"), null, RequestParams(requestParameters));
///PUT on /{index}/_block/{block}
///A comma separated list of indices to add a block to
///The block to add (one of read, write, read_only or metadata)
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.add_block", "index, block")]
public Task AddBlockAsync(string index, string block, AddIndexBlockRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(PUT, Url($"{index:index}/_block/{block:block}"), ctx, null, RequestParams(requestParameters));
///POST on /_analyze
///Define analyzer/tokenizer parameters and the text on which the analysis should be performed
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse AnalyzeForAll(PostData body, AnalyzeRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, "_analyze", body, RequestParams(requestParameters));
///POST on /_analyze
///Define analyzer/tokenizer parameters and the text on which the analysis should be performed
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.analyze", "body")]
public Task AnalyzeForAllAsync(PostData body, AnalyzeRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, "_analyze", ctx, body, RequestParams(requestParameters));
///POST on /{index}/_analyze
///The name of the index to scope the operation
///Define analyzer/tokenizer parameters and the text on which the analysis should be performed
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Analyze(string index, PostData body, AnalyzeRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, Url($"{index:index}/_analyze"), body, RequestParams(requestParameters));
///POST on /{index}/_analyze
///The name of the index to scope the operation
///Define analyzer/tokenizer parameters and the text on which the analysis should be performed
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.analyze", "index, body")]
public Task AnalyzeAsync(string index, PostData body, AnalyzeRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, Url($"{index:index}/_analyze"), ctx, body, RequestParams(requestParameters));
///POST on /_cache/clear
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse ClearCacheForAll(ClearCacheRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, "_cache/clear", null, RequestParams(requestParameters));
///POST on /_cache/clear
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.clear_cache", "")]
public Task ClearCacheForAllAsync(ClearCacheRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, "_cache/clear", ctx, null, RequestParams(requestParameters));
///POST on /{index}/_cache/clear
///A comma-separated list of index name to limit the operation
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse ClearCache(string index, ClearCacheRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, Url($"{index:index}/_cache/clear"), null, RequestParams(requestParameters));
///POST on /{index}/_cache/clear
///A comma-separated list of index name to limit the operation
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.clear_cache", "index")]
public Task ClearCacheAsync(string index, ClearCacheRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, Url($"{index:index}/_cache/clear"), ctx, null, RequestParams(requestParameters));
///PUT on /{index}/_clone/{target} https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/clone/
///The name of the source index to clone
///The name of the target index to clone into
///The configuration for the target index (`settings` and `aliases`)
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Clone(string index, string target, PostData body, CloneIndexRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(PUT, Url($"{index:index}/_clone/{target:target}"), body, RequestParams(requestParameters));
///PUT on /{index}/_clone/{target} https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/clone/
///The name of the source index to clone
///The name of the target index to clone into
///The configuration for the target index (`settings` and `aliases`)
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.clone", "index, target, body")]
public Task CloneAsync(string index, string target, PostData body, CloneIndexRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(PUT, Url($"{index:index}/_clone/{target:target}"), ctx, body, RequestParams(requestParameters));
///POST on /{index}/_close https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/close-index/
///A comma separated list of indices to close
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Close(string index, CloseIndexRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, Url($"{index:index}/_close"), null, RequestParams(requestParameters));
///POST on /{index}/_close https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/close-index/
///A comma separated list of indices to close
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.close", "index")]
public Task CloseAsync(string index, CloseIndexRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, Url($"{index:index}/_close"), ctx, null, RequestParams(requestParameters));
///PUT on /{index} https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/
///The name of the index
///The configuration for the index (`settings` and `mappings`)
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Create(string index, PostData body, CreateIndexRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(PUT, Url($"{index:index}"), body, RequestParams(requestParameters));
///PUT on /{index} https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/create-index/
///The name of the index
///The configuration for the index (`settings` and `mappings`)
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.create", "index, body")]
public Task CreateAsync(string index, PostData body, CreateIndexRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(PUT, Url($"{index:index}"), ctx, body, RequestParams(requestParameters));
///DELETE on /{index} https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/delete-index/
///A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Delete(string index, DeleteIndexRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(DELETE, Url($"{index:index}"), null, RequestParams(requestParameters));
///DELETE on /{index} https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/delete-index/
///A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.delete", "index")]
public Task DeleteAsync(string index, DeleteIndexRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(DELETE, Url($"{index:index}"), ctx, null, RequestParams(requestParameters));
///DELETE on /{index}/_alias/{name} https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of index names (supports wildcards); use `_all` for all indices
///A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse DeleteAlias(string index, string name, DeleteAliasRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(DELETE, Url($"{index:index}/_alias/{name:name}"), null, RequestParams(requestParameters));
///DELETE on /{index}/_alias/{name} https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of index names (supports wildcards); use `_all` for all indices
///A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.delete_alias", "index, name")]
public Task DeleteAliasAsync(string index, string name, DeleteAliasRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(DELETE, Url($"{index:index}/_alias/{name:name}"), ctx, null, RequestParams(requestParameters));
///DELETE on /_index_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The name of the template
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse DeleteTemplateV2ForAll(string name, DeleteIndexTemplateV2RequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(DELETE, Url($"_index_template/{name:name}"), null, RequestParams(requestParameters));
///DELETE on /_index_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The name of the template
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.delete_index_template", "name")]
public Task DeleteTemplateV2ForAllAsync(string name, DeleteIndexTemplateV2RequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(DELETE, Url($"_index_template/{name:name}"), ctx, null, RequestParams(requestParameters));
///DELETE on /_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The name of the template
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse DeleteTemplateForAll(string name, DeleteIndexTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(DELETE, Url($"_template/{name:name}"), null, RequestParams(requestParameters));
///DELETE on /_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The name of the template
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.delete_template", "name")]
public Task DeleteTemplateForAllAsync(string name, DeleteIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(DELETE, Url($"_template/{name:name}"), ctx, null, RequestParams(requestParameters));
///HEAD on /{index} https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/
///A comma-separated list of index names
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Exists(string index, IndexExistsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(HEAD, Url($"{index:index}"), null, RequestParams(requestParameters));
///HEAD on /{index} https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/
///A comma-separated list of index names
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.exists", "index")]
public Task ExistsAsync(string index, IndexExistsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(HEAD, Url($"{index:index}"), ctx, null, RequestParams(requestParameters));
///HEAD on /_alias/{name} https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of alias names to return
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse AliasExistsForAll(string name, AliasExistsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(HEAD, Url($"_alias/{name:name}"), null, RequestParams(requestParameters));
///HEAD on /_alias/{name} https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of alias names to return
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.exists_alias", "name")]
public Task AliasExistsForAllAsync(string name, AliasExistsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(HEAD, Url($"_alias/{name:name}"), ctx, null, RequestParams(requestParameters));
///HEAD on /{index}/_alias/{name} https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of index names to filter aliases
///A comma-separated list of alias names to return
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse AliasExists(string index, string name, AliasExistsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(HEAD, Url($"{index:index}/_alias/{name:name}"), null, RequestParams(requestParameters));
///HEAD on /{index}/_alias/{name} https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of index names to filter aliases
///A comma-separated list of alias names to return
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.exists_alias", "index, name")]
public Task AliasExistsAsync(string index, string name, AliasExistsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(HEAD, Url($"{index:index}/_alias/{name:name}"), ctx, null, RequestParams(requestParameters));
///HEAD on /_index_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The name of the template
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse ExistsTemplateForAll(string name, ExistsIndexTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(HEAD, Url($"_index_template/{name:name}"), null, RequestParams(requestParameters));
///HEAD on /_index_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The name of the template
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.exists_index_template", "name")]
public Task ExistsTemplateForAllAsync(string name, ExistsIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(HEAD, Url($"_index_template/{name:name}"), ctx, null, RequestParams(requestParameters));
///HEAD on /_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The comma separated names of the index templates
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse TemplateExistsForAll(string name, IndexTemplateExistsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(HEAD, Url($"_template/{name:name}"), null, RequestParams(requestParameters));
///HEAD on /_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The comma separated names of the index templates
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.exists_template", "name")]
public Task TemplateExistsForAllAsync(string name, IndexTemplateExistsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(HEAD, Url($"_template/{name:name}"), ctx, null, RequestParams(requestParameters));
///HEAD on /{index}/_mapping/{type} https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/
///A comma-separated list of index names; use `_all` to check the types across all indices
///A comma-separated list of document types to check
///Request specific configuration such as querystring parameters & request specific connection settings.
///Deprecated as of OpenSearch 2.0
public TResponse TypeExists(string index, string type, TypeExistsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(HEAD, Url($"{index:index}/_mapping/{type:type}"), null, RequestParams(requestParameters));
///HEAD on /{index}/_mapping/{type} https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/
///A comma-separated list of index names; use `_all` to check the types across all indices
///A comma-separated list of document types to check
///Request specific configuration such as querystring parameters & request specific connection settings.
///Deprecated as of OpenSearch 2.0
[MapsApi("indices.exists_type", "index, type")]
public Task TypeExistsAsync(string index, string type, TypeExistsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(HEAD, Url($"{index:index}/_mapping/{type:type}"), ctx, null, RequestParams(requestParameters));
///POST on /_flush
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse FlushForAll(FlushRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, "_flush", null, RequestParams(requestParameters));
///POST on /_flush
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.flush", "")]
public Task FlushForAllAsync(FlushRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, "_flush", ctx, null, RequestParams(requestParameters));
///POST on /{index}/_flush
///A comma-separated list of index names; use the special string `_all` or Indices.All for all indices
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Flush(string index, FlushRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, Url($"{index:index}/_flush"), null, RequestParams(requestParameters));
///POST on /{index}/_flush
///A comma-separated list of index names; use the special string `_all` or Indices.All for all indices
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.flush", "index")]
public Task FlushAsync(string index, FlushRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, Url($"{index:index}/_flush"), ctx, null, RequestParams(requestParameters));
///POST on /_forcemerge
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse ForceMergeForAll(ForceMergeRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, "_forcemerge", null, RequestParams(requestParameters));
///POST on /_forcemerge
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.forcemerge", "")]
public Task ForceMergeForAllAsync(ForceMergeRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, "_forcemerge", ctx, null, RequestParams(requestParameters));
///POST on /{index}/_forcemerge
///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 ForceMerge(string index, ForceMergeRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, Url($"{index:index}/_forcemerge"), null, RequestParams(requestParameters));
///POST on /{index}/_forcemerge
///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("indices.forcemerge", "index")]
public Task ForceMergeAsync(string index, ForceMergeRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, Url($"{index:index}/_forcemerge"), ctx, null, RequestParams(requestParameters));
///GET on /{index} https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/get-index/
///A comma-separated list of index names
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Get(string index, GetIndexRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"{index:index}"), null, RequestParams(requestParameters));
///GET on /{index} https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/get-index/
///A comma-separated list of index names
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get", "index")]
public Task GetAsync(string index, GetIndexRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"{index:index}"), ctx, null, RequestParams(requestParameters));
///GET on /_alias https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetAliasForAll(GetAliasRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_alias", null, RequestParams(requestParameters));
///GET on /_alias https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_alias", "")]
public Task GetAliasForAllAsync(GetAliasRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_alias", ctx, null, RequestParams(requestParameters));
///GET on /_alias/{name} https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of alias names to return
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetAliasForAll(string name, GetAliasRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"_alias/{name:name}"), null, RequestParams(requestParameters));
///GET on /_alias/{name} https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of alias names to return
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_alias", "name")]
public Task GetAliasForAllAsync(string name, GetAliasRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"_alias/{name:name}"), ctx, null, RequestParams(requestParameters));
///GET on /{index}/_alias/{name} https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of index names to filter aliases
///A comma-separated list of alias names to return
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetAlias(string index, string name, GetAliasRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"{index:index}/_alias/{name:name}"), null, RequestParams(requestParameters));
///GET on /{index}/_alias/{name} https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of index names to filter aliases
///A comma-separated list of alias names to return
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_alias", "index, name")]
public Task GetAliasAsync(string index, string name, GetAliasRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"{index:index}/_alias/{name:name}"), ctx, null, RequestParams(requestParameters));
///GET on /{index}/_alias https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of index names to filter aliases
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetAlias(string index, GetAliasRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"{index:index}/_alias"), null, RequestParams(requestParameters));
///GET on /{index}/_alias https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of index names to filter aliases
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_alias", "index")]
public Task GetAliasAsync(string index, GetAliasRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"{index:index}/_alias"), ctx, null, RequestParams(requestParameters));
///GET on /_mapping/field/{fields} https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
///A comma-separated list of fields
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetFieldMappingForAll(string fields, GetFieldMappingRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"_mapping/field/{fields:fields}"), null, RequestParams(requestParameters));
///GET on /_mapping/field/{fields} https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
///A comma-separated list of fields
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_field_mapping", "fields")]
public Task GetFieldMappingForAllAsync(string fields, GetFieldMappingRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"_mapping/field/{fields:fields}"), ctx, null, RequestParams(requestParameters));
///GET on /{index}/_mapping/field/{fields} https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
///A comma-separated list of index names
///A comma-separated list of fields
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetFieldMapping(string index, string fields, GetFieldMappingRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"{index:index}/_mapping/field/{fields:fields}"), null, RequestParams(requestParameters));
///GET on /{index}/_mapping/field/{fields} https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
///A comma-separated list of index names
///A comma-separated list of fields
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_field_mapping", "index, fields")]
public Task GetFieldMappingAsync(string index, string fields, GetFieldMappingRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"{index:index}/_mapping/field/{fields:fields}"), ctx, null, RequestParams(requestParameters));
///GET on /_index_template https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetTemplateV2ForAll(GetIndexTemplateV2RequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_index_template", null, RequestParams(requestParameters));
///GET on /_index_template https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_index_template", "")]
public Task GetTemplateV2ForAllAsync(GetIndexTemplateV2RequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_index_template", ctx, null, RequestParams(requestParameters));
///GET on /_index_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The comma separated names of the index templates
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetTemplateV2ForAll(string name, GetIndexTemplateV2RequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"_index_template/{name:name}"), null, RequestParams(requestParameters));
///GET on /_index_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The comma separated names of the index templates
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_index_template", "name")]
public Task GetTemplateV2ForAllAsync(string name, GetIndexTemplateV2RequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"_index_template/{name:name}"), ctx, null, RequestParams(requestParameters));
///GET on /_mapping https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetMappingForAll(GetMappingRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_mapping", null, RequestParams(requestParameters));
///GET on /_mapping https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_mapping", "")]
public Task GetMappingForAllAsync(GetMappingRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_mapping", ctx, null, RequestParams(requestParameters));
///GET on /{index}/_mapping https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
///A comma-separated list of index names
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetMapping(string index, GetMappingRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"{index:index}/_mapping"), null, RequestParams(requestParameters));
///GET on /{index}/_mapping https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
///A comma-separated list of index names
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_mapping", "index")]
public Task GetMappingAsync(string index, GetMappingRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"{index:index}/_mapping"), ctx, null, RequestParams(requestParameters));
///GET on /_settings
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetSettingsForAll(GetIndexSettingsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_settings", null, RequestParams(requestParameters));
///GET on /_settings
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_settings", "")]
public Task GetSettingsForAllAsync(GetIndexSettingsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_settings", ctx, null, RequestParams(requestParameters));
///GET on /{index}/_settings
///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 GetSettings(string index, GetIndexSettingsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"{index:index}/_settings"), null, RequestParams(requestParameters));
///GET on /{index}/_settings
///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("indices.get_settings", "index")]
public Task GetSettingsAsync(string index, GetIndexSettingsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"{index:index}/_settings"), ctx, null, RequestParams(requestParameters));
///GET on /{index}/_settings/{name}
///A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices
///The name of the settings that should be included
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetSettings(string index, string name, GetIndexSettingsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"{index:index}/_settings/{name:name}"), null, RequestParams(requestParameters));
///GET on /{index}/_settings/{name}
///A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices
///The name of the settings that should be included
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_settings", "index, name")]
public Task GetSettingsAsync(string index, string name, GetIndexSettingsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"{index:index}/_settings/{name:name}"), ctx, null, RequestParams(requestParameters));
///GET on /_settings/{name}
///The name of the settings that should be included
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetSettingsForAll(string name, GetIndexSettingsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"_settings/{name:name}"), null, RequestParams(requestParameters));
///GET on /_settings/{name}
///The name of the settings that should be included
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_settings", "name")]
public Task GetSettingsForAllAsync(string name, GetIndexSettingsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"_settings/{name:name}"), ctx, null, RequestParams(requestParameters));
///GET on /_template https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetTemplateForAll(GetIndexTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_template", null, RequestParams(requestParameters));
///GET on /_template https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_template", "")]
public Task GetTemplateForAllAsync(GetIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_template", ctx, null, RequestParams(requestParameters));
///GET on /_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The comma separated names of the index templates
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse GetTemplateForAll(string name, GetIndexTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"_template/{name:name}"), null, RequestParams(requestParameters));
///GET on /_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The comma separated names of the index templates
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.get_template", "name")]
public Task GetTemplateForAllAsync(string name, GetIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"_template/{name:name}"), ctx, null, RequestParams(requestParameters));
///POST on /{index}/_open https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/close-index/
///A comma separated list of indices to open
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Open(string index, OpenIndexRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, Url($"{index:index}/_open"), null, RequestParams(requestParameters));
///POST on /{index}/_open https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/close-index/
///A comma separated list of indices to open
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.open", "index")]
public Task OpenAsync(string index, OpenIndexRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, Url($"{index:index}/_open"), ctx, null, RequestParams(requestParameters));
///PUT on /{index}/_alias/{name} https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
///The name of the alias to be created or updated
///The settings for the alias, such as `routing` or `filter`
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse PutAlias(string index, string name, PostData body, PutAliasRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(PUT, Url($"{index:index}/_alias/{name:name}"), body, RequestParams(requestParameters));
///PUT on /{index}/_alias/{name} https://opensearch.org/docs/latest/opensearch/rest-api/alias/
///A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices.
///The name of the alias to be created or updated
///The settings for the alias, such as `routing` or `filter`
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.put_alias", "index, name, body")]
public Task PutAliasAsync(string index, string name, PostData body, PutAliasRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(PUT, Url($"{index:index}/_alias/{name:name}"), ctx, body, RequestParams(requestParameters));
///PUT on /_index_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The name of the template
///The template definition
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse PutTemplateV2ForAll(string name, PostData body, PutIndexTemplateV2RequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(PUT, Url($"_index_template/{name:name}"), body, RequestParams(requestParameters));
///PUT on /_index_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The name of the template
///The template definition
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.put_index_template", "name, body")]
public Task PutTemplateV2ForAllAsync(string name, PostData body, PutIndexTemplateV2RequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(PUT, Url($"_index_template/{name:name}"), ctx, body, RequestParams(requestParameters));
///PUT on /{index}/_mapping https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
///A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
///The mapping definition
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse PutMapping(string index, PostData body, PutMappingRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(PUT, Url($"{index:index}/_mapping"), body, RequestParams(requestParameters));
///PUT on /{index}/_mapping https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
///A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
///The mapping definition
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.put_mapping", "index, body")]
public Task PutMappingAsync(string index, PostData body, PutMappingRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(PUT, Url($"{index:index}/_mapping"), ctx, body, RequestParams(requestParameters));
///PUT on /_settings
///The index settings to be updated
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse UpdateSettingsForAll(PostData body, UpdateIndexSettingsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(PUT, "_settings", body, RequestParams(requestParameters));
///PUT on /_settings
///The index settings to be updated
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.put_settings", "body")]
public Task UpdateSettingsForAllAsync(PostData body, UpdateIndexSettingsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(PUT, "_settings", ctx, body, RequestParams(requestParameters));
///PUT on /{index}/_settings
///A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices
///The index settings to be updated
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse UpdateSettings(string index, PostData body, UpdateIndexSettingsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(PUT, Url($"{index:index}/_settings"), body, RequestParams(requestParameters));
///PUT on /{index}/_settings
///A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices
///The index settings to be updated
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.put_settings", "index, body")]
public Task UpdateSettingsAsync(string index, PostData body, UpdateIndexSettingsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(PUT, Url($"{index:index}/_settings"), ctx, body, RequestParams(requestParameters));
///PUT on /_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The name of the template
///The template definition
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse PutTemplateForAll(string name, PostData body, PutIndexTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(PUT, Url($"_template/{name:name}"), body, RequestParams(requestParameters));
///PUT on /_template/{name} https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
///The name of the template
///The template definition
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.put_template", "name, body")]
public Task PutTemplateForAllAsync(string name, PostData body, PutIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(PUT, Url($"_template/{name:name}"), ctx, body, RequestParams(requestParameters));
///GET on /_recovery
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse RecoveryStatusForAll(RecoveryStatusRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, "_recovery", null, RequestParams(requestParameters));
///GET on /_recovery
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.recovery", "")]
public Task RecoveryStatusForAllAsync(RecoveryStatusRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, "_recovery", ctx, null, RequestParams(requestParameters));
///GET on /{index}/_recovery
///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 RecoveryStatus(string index, RecoveryStatusRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"{index:index}/_recovery"), null, RequestParams(requestParameters));
///GET on /{index}/_recovery
///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("indices.recovery", "index")]
public Task RecoveryStatusAsync(string index, RecoveryStatusRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(GET, Url($"{index:index}/_recovery"), ctx, null, RequestParams(requestParameters));
///POST on /_refresh https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
///Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse RefreshForAll(RefreshRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, "_refresh", null, RequestParams(requestParameters));
///POST on /_refresh https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
///Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("indices.refresh", "")]
public Task RefreshForAllAsync(RefreshRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, "_refresh", ctx, null, RequestParams(requestParameters));
///POST on /{index}/_refresh https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
///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 Refresh(string index, RefreshRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(POST, Url($"{index:index}/_refresh"), null, RequestParams(requestParameters));
///POST on /{index}/_refresh https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
///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("indices.refresh", "index")]
public Task RefreshAsync(string index, RefreshRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new() => DoRequestAsync(POST, Url($"{index:index}/_refresh"), ctx, null, RequestParams(requestParameters));
///GET on /_resolve/index/{name}
///A comma-separated list of names or wildcard expressions
///Request specific configuration such as querystring parameters & request specific connection settings.
///Note: Experimental within the OpenSearch server, this functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. This functionality is subject to potential breaking changes within a minor version, meaning that your referencing code may break when this library is upgraded.
public TResponse ResolveForAll(string name, ResolveIndexRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() => DoRequest(GET, Url($"_resolve/index/{name:name}"), null, RequestParams(requestParameters));
///GET on /_resolve/index/{name}