Class LowLevelIndicesNamespace

Indices APIs.

Not intended to be instantiated directly. Use the Indices property on IOpenSearchLowLevelClient.

Inheritance

object

NamespacedClientProxy

LowLevelIndicesNamespace

Inherited Members

NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)

NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.IndicesApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelIndicesNamespace : NamespacedClientProxy

Methods

AddBlockAsync<TResponse>(string, IndexApiBlock?, AddIndexBlockRequestParameters, CancellationToken)

PUT on /{index}/_block/{block}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> AddBlockAsync<TResponse>(string index, IndexApiBlock? block, AddIndexBlockRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma separated list of indexes to add a block to.
IndexApiBlock?	block	The block to add (one of read, write, read_only or metadata).
AddIndexBlockRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

AddBlock<TResponse>(string, IndexApiBlock?, AddIndexBlockRequestParameters)

PUT on /{index}/_block/{block}

https://opensearch.org/docs/latest

Declaration

public TResponse AddBlock<TResponse>(string index, IndexApiBlock? block, AddIndexBlockRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma separated list of indexes to add a block to.
IndexApiBlock?	block	The block to add (one of read, write, read_only or metadata).
AddIndexBlockRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

AliasExistsAsync<TResponse>(string, string, AliasExistsRequestParameters, CancellationToken)

HEAD on /{index}/_alias/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> AliasExistsAsync<TResponse>(string index, string name, AliasExistsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
string	name	Comma-separated list of aliases to check. Supports wildcards (*).
AliasExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

AliasExistsForAllAsync<TResponse>(string, AliasExistsRequestParameters, CancellationToken)

HEAD on /_alias/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> AliasExistsForAllAsync<TResponse>(string name, AliasExistsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list of aliases to check. Supports wildcards (*).
AliasExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

AliasExistsForAll<TResponse>(string, AliasExistsRequestParameters)

HEAD on /_alias/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse AliasExistsForAll<TResponse>(string name, AliasExistsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list of aliases to check. Supports wildcards (*).
AliasExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

AliasExists<TResponse>(string, string, AliasExistsRequestParameters)

HEAD on /{index}/_alias/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse AliasExists<TResponse>(string index, string name, AliasExistsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
string	name	Comma-separated list of aliases to check. Supports wildcards (*).
AliasExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

AnalyzeAsync<TResponse>(string, PostData, AnalyzeRequestParameters, CancellationToken)

POST on /{index}/_analyze

https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/

Declaration

public Task<TResponse> AnalyzeAsync<TResponse>(string index, PostData body, AnalyzeRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Index used to derive the analyzer. If specified, the analyzer or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.
PostData	body	Define analyzer/tokenizer parameters and the text on which the analysis should be performed.
AnalyzeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

AnalyzeForAllAsync<TResponse>(PostData, AnalyzeRequestParameters, CancellationToken)

POST on /_analyze

https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/

Declaration

public Task<TResponse> AnalyzeForAllAsync<TResponse>(PostData body, AnalyzeRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Define analyzer/tokenizer parameters and the text on which the analysis should be performed.
AnalyzeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

AnalyzeForAll<TResponse>(PostData, AnalyzeRequestParameters)

POST on /_analyze

https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/

Declaration

public TResponse AnalyzeForAll<TResponse>(PostData body, AnalyzeRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	Define analyzer/tokenizer parameters and the text on which the analysis should be performed.
AnalyzeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Analyze<TResponse>(string, PostData, AnalyzeRequestParameters)

POST on /{index}/_analyze

https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/

Declaration

public TResponse Analyze<TResponse>(string index, PostData body, AnalyzeRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Index used to derive the analyzer. If specified, the analyzer or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.
PostData	body	Define analyzer/tokenizer parameters and the text on which the analysis should be performed.
AnalyzeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

BulkAliasForAllAsync<TResponse>(PostData, BulkAliasRequestParameters, CancellationToken)

POST on /_aliases

https://opensearch.org/docs/latest/api-reference/index-apis/alias/

Declaration

public Task<TResponse> BulkAliasForAllAsync<TResponse>(PostData body, BulkAliasRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The definition of actions to perform.
BulkAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

BulkAliasForAll<TResponse>(PostData, BulkAliasRequestParameters)

POST on /_aliases

https://opensearch.org/docs/latest/api-reference/index-apis/alias/

Declaration

public TResponse BulkAliasForAll<TResponse>(PostData body, BulkAliasRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The definition of actions to perform.
BulkAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ClearCacheAsync<TResponse>(string, ClearCacheRequestParameters, CancellationToken)

POST on /{index}/_cache/clear

https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/

Declaration

public Task<TResponse> ClearCacheAsync<TResponse>(string index, ClearCacheRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
ClearCacheRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ClearCacheForAllAsync<TResponse>(ClearCacheRequestParameters, CancellationToken)

POST on /_cache/clear

https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/

Declaration

public Task<TResponse> ClearCacheForAllAsync<TResponse>(ClearCacheRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClearCacheRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ClearCacheForAll<TResponse>(ClearCacheRequestParameters)

POST on /_cache/clear

https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/

Declaration

public TResponse ClearCacheForAll<TResponse>(ClearCacheRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClearCacheRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ClearCache<TResponse>(string, ClearCacheRequestParameters)

POST on /{index}/_cache/clear

https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/

Declaration

public TResponse ClearCache<TResponse>(string index, ClearCacheRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
ClearCacheRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

CloneAsync<TResponse>(string, string, PostData, CloneIndexRequestParameters, CancellationToken)

PUT on /{index}/_clone/{target}

https://opensearch.org/docs/latest/api-reference/index-apis/clone/

Declaration

public Task<TResponse> CloneAsync<TResponse>(string index, string target, PostData body, CloneIndexRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the source index to clone.
string	target	Name of the target index to create.
PostData	body	The configuration for the target index (settings and aliases).
CloneIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Clone<TResponse>(string, string, PostData, CloneIndexRequestParameters)

PUT on /{index}/_clone/{target}

https://opensearch.org/docs/latest/api-reference/index-apis/clone/

Declaration

public TResponse Clone<TResponse>(string index, string target, PostData body, CloneIndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the source index to clone.
string	target	Name of the target index to create.
PostData	body	The configuration for the target index (settings and aliases).
CloneIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

CloseAsync<TResponse>(string, CloseIndexRequestParameters, CancellationToken)

POST on /{index}/_close

https://opensearch.org/docs/latest/api-reference/index-apis/close-index/

Declaration

public Task<TResponse> CloseAsync<TResponse>(string index, CloseIndexRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list or wildcard expression of index names used to limit the request.
CloseIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Close<TResponse>(string, CloseIndexRequestParameters)

POST on /{index}/_close

https://opensearch.org/docs/latest/api-reference/index-apis/close-index/

Declaration

public TResponse Close<TResponse>(string index, CloseIndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list or wildcard expression of index names used to limit the request.
CloseIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ComposableTemplateExistsForAllAsync<TResponse>(string, ComposableIndexTemplateExistsRequestParameters, CancellationToken)

HEAD on /_index_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/

Declaration

public Task<TResponse> ComposableTemplateExistsForAllAsync<TResponse>(string name, ComposableIndexTemplateExistsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the index template to check existence of. Wildcard (*) expressions are supported.
ComposableIndexTemplateExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ComposableTemplateExistsForAll<TResponse>(string, ComposableIndexTemplateExistsRequestParameters)

HEAD on /_index_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/

Declaration

public TResponse ComposableTemplateExistsForAll<TResponse>(string name, ComposableIndexTemplateExistsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the index template to check existence of. Wildcard (*) expressions are supported.
ComposableIndexTemplateExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

CreateAsync<TResponse>(string, PostData, CreateIndexRequestParameters, CancellationToken)

PUT on /{index}

https://opensearch.org/docs/latest/api-reference/index-apis/create-index/

Declaration

public Task<TResponse> CreateAsync<TResponse>(string index, PostData body, CreateIndexRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the index you wish to create.
PostData	body	The configuration for the index (settings and mappings).
CreateIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

CreateDataStreamForAllAsync<TResponse>(string, PostData, CreateDataStreamRequestParameters, CancellationToken)

PUT on /_data_stream/{name}

https://opensearch.org/docs/latest/im-plugin/data-streams/

Declaration

public Task<TResponse> CreateDataStreamForAllAsync<TResponse>(string name, PostData body, CreateDataStreamRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include \, /, *, ?, ", <, >, |, ,, #, :, or a space character; Cannot start with -, _, +, or .ds-; Cannot be . or ..; Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster.
PostData	body	The data stream definition.
CreateDataStreamRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

CreateDataStreamForAll<TResponse>(string, PostData, CreateDataStreamRequestParameters)

PUT on /_data_stream/{name}

https://opensearch.org/docs/latest/im-plugin/data-streams/

Declaration

public TResponse CreateDataStreamForAll<TResponse>(string name, PostData body, CreateDataStreamRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include \, /, *, ?, ", <, >, |, ,, #, :, or a space character; Cannot start with -, _, +, or .ds-; Cannot be . or ..; Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster.
PostData	body	The data stream definition.
CreateDataStreamRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Create<TResponse>(string, PostData, CreateIndexRequestParameters)

PUT on /{index}

https://opensearch.org/docs/latest/api-reference/index-apis/create-index/

Declaration

public TResponse Create<TResponse>(string index, PostData body, CreateIndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the index you wish to create.
PostData	body	The configuration for the index (settings and mappings).
CreateIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DataStreamsStatsForAllAsync<TResponse>(DataStreamsStatsRequestParameters, CancellationToken)

GET on /_data_stream/_stats

https://opensearch.org/docs/latest/im-plugin/data-streams/

Declaration

public Task<TResponse> DataStreamsStatsForAllAsync<TResponse>(DataStreamsStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DataStreamsStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DataStreamsStatsForAllAsync<TResponse>(string, DataStreamsStatsRequestParameters, CancellationToken)

GET on /_data_stream/{name}/_stats

https://opensearch.org/docs/latest/im-plugin/data-streams/

Declaration

public Task<TResponse> DataStreamsStatsForAllAsync<TResponse>(string name, DataStreamsStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list of data streams used to limit the request. Wildcard expressions (*) are supported. To target all data streams in a cluster, omit this parameter or use *.
DataStreamsStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DataStreamsStatsForAll<TResponse>(DataStreamsStatsRequestParameters)

GET on /_data_stream/_stats

https://opensearch.org/docs/latest/im-plugin/data-streams/

Declaration

public TResponse DataStreamsStatsForAll<TResponse>(DataStreamsStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DataStreamsStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DataStreamsStatsForAll<TResponse>(string, DataStreamsStatsRequestParameters)

GET on /_data_stream/{name}/_stats

https://opensearch.org/docs/latest/im-plugin/data-streams/

Declaration

public TResponse DataStreamsStatsForAll<TResponse>(string name, DataStreamsStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list of data streams used to limit the request. Wildcard expressions (*) are supported. To target all data streams in a cluster, omit this parameter or use *.
DataStreamsStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DeleteAliasAsync<TResponse>(string, string, DeleteAliasRequestParameters, CancellationToken)

DELETE on /{index}/_alias/{name}

https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases

Declaration

public Task<TResponse> DeleteAliasAsync<TResponse>(string index, string name, DeleteAliasRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*).
string	name	Comma-separated list of aliases to remove. Supports wildcards (*). To remove all aliases, use * or _all.
DeleteAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteAlias<TResponse>(string, string, DeleteAliasRequestParameters)

DELETE on /{index}/_alias/{name}

https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases

Declaration

public TResponse DeleteAlias<TResponse>(string index, string name, DeleteAliasRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*).
string	name	Comma-separated list of aliases to remove. Supports wildcards (*). To remove all aliases, use * or _all.
DeleteAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DeleteAsync<TResponse>(string, DeleteIndexRequestParameters, CancellationToken)

DELETE on /{index}

https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/

Declaration

public Task<TResponse> DeleteAsync<TResponse>(string index, DeleteIndexRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of indexes to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (*) or _all. To use wildcards or _all, set the action.destructive_requires_name cluster setting to false.
DeleteIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteComposableTemplateForAllAsync<TResponse>(string, DeleteComposableIndexTemplateRequestParameters, CancellationToken)

DELETE on /_index_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template

Declaration

public Task<TResponse> DeleteComposableTemplateForAllAsync<TResponse>(string name, DeleteComposableIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the index template to delete. Wildcard (*) expressions are supported.
DeleteComposableIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteComposableTemplateForAll<TResponse>(string, DeleteComposableIndexTemplateRequestParameters)

DELETE on /_index_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template

Declaration

public TResponse DeleteComposableTemplateForAll<TResponse>(string name, DeleteComposableIndexTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the index template to delete. Wildcard (*) expressions are supported.
DeleteComposableIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DeleteDataStreamForAllAsync<TResponse>(string, DeleteDataStreamRequestParameters, CancellationToken)

DELETE on /_data_stream/{name}

https://opensearch.org/docs/latest/im-plugin/data-streams/

Declaration

public Task<TResponse> DeleteDataStreamForAllAsync<TResponse>(string name, DeleteDataStreamRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list of data streams to delete. Wildcard (*) expressions are supported.
DeleteDataStreamRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteDataStreamForAll<TResponse>(string, DeleteDataStreamRequestParameters)

DELETE on /_data_stream/{name}

https://opensearch.org/docs/latest/im-plugin/data-streams/

Declaration

public TResponse DeleteDataStreamForAll<TResponse>(string name, DeleteDataStreamRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list of data streams to delete. Wildcard (*) expressions are supported.
DeleteDataStreamRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

DeleteTemplateForAllAsync<TResponse>(string, DeleteIndexTemplateRequestParameters, CancellationToken)

DELETE on /_template/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> DeleteTemplateForAllAsync<TResponse>(string name, DeleteIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the legacy index template to delete. Wildcard (*) expressions are supported.
DeleteIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteTemplateForAll<TResponse>(string, DeleteIndexTemplateRequestParameters)

DELETE on /_template/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse DeleteTemplateForAll<TResponse>(string name, DeleteIndexTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the legacy index template to delete. Wildcard (*) expressions are supported.
DeleteIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Delete<TResponse>(string, DeleteIndexRequestParameters)

DELETE on /{index}

https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/

Declaration

public TResponse Delete<TResponse>(string index, DeleteIndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of indexes to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (*) or _all. To use wildcards or _all, set the action.destructive_requires_name cluster setting to false.
DeleteIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ExistsAsync<TResponse>(string, IndexExistsRequestParameters, CancellationToken)

HEAD on /{index}

https://opensearch.org/docs/latest/api-reference/index-apis/exists/

Declaration

public Task<TResponse> ExistsAsync<TResponse>(string index, IndexExistsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases. Supports wildcards (*).
IndexExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Exists<TResponse>(string, IndexExistsRequestParameters)

HEAD on /{index}

https://opensearch.org/docs/latest/api-reference/index-apis/exists/

Declaration

public TResponse Exists<TResponse>(string index, IndexExistsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases. Supports wildcards (*).
IndexExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

FlushAsync<TResponse>(string, FlushRequestParameters, CancellationToken)

POST on /{index}/_flush

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> FlushAsync<TResponse>(string index, FlushRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases to flush. Supports wildcards (*). To flush all data streams and indexes, omit this parameter or use * or _all.
FlushRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

FlushForAllAsync<TResponse>(FlushRequestParameters, CancellationToken)

POST on /_flush

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> FlushForAllAsync<TResponse>(FlushRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FlushRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

FlushForAll<TResponse>(FlushRequestParameters)

POST on /_flush

https://opensearch.org/docs/latest

Declaration

public TResponse FlushForAll<TResponse>(FlushRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FlushRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Flush<TResponse>(string, FlushRequestParameters)

POST on /{index}/_flush

https://opensearch.org/docs/latest

Declaration

public TResponse Flush<TResponse>(string index, FlushRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases to flush. Supports wildcards (*). To flush all data streams and indexes, omit this parameter or use * or _all.
FlushRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ForceMergeAsync<TResponse>(string, ForceMergeRequestParameters, CancellationToken)

POST on /{index}/_forcemerge

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> ForceMergeAsync<TResponse>(string index, ForceMergeRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of index names; use the special string _all or Indices.All to perform the operation on all indexes.
ForceMergeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ForceMergeForAllAsync<TResponse>(ForceMergeRequestParameters, CancellationToken)

POST on /_forcemerge

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> ForceMergeForAllAsync<TResponse>(ForceMergeRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ForceMergeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ForceMergeForAll<TResponse>(ForceMergeRequestParameters)

POST on /_forcemerge

https://opensearch.org/docs/latest

Declaration

public TResponse ForceMergeForAll<TResponse>(ForceMergeRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ForceMergeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ForceMerge<TResponse>(string, ForceMergeRequestParameters)

POST on /{index}/_forcemerge

https://opensearch.org/docs/latest

Declaration

public TResponse ForceMerge<TResponse>(string index, ForceMergeRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of index names; use the special string _all or Indices.All to perform the operation on all indexes.
ForceMergeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetAliasAsync<TResponse>(string, GetAliasRequestParameters, CancellationToken)

GET on /{index}/_alias

https://opensearch.org/docs/latest/im-plugin/index-alias/

Declaration

public Task<TResponse> GetAliasAsync<TResponse>(string index, GetAliasRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
GetAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetAliasAsync<TResponse>(string, string, GetAliasRequestParameters, CancellationToken)

GET on /{index}/_alias/{name}

https://opensearch.org/docs/latest/im-plugin/index-alias/

Declaration

public Task<TResponse> GetAliasAsync<TResponse>(string index, string name, GetAliasRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
string	name	Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.
GetAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetAliasForAllAsync<TResponse>(GetAliasRequestParameters, CancellationToken)

GET on /_alias

https://opensearch.org/docs/latest/im-plugin/index-alias/

Declaration

public Task<TResponse> GetAliasForAllAsync<TResponse>(GetAliasRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetAliasForAllAsync<TResponse>(string, GetAliasRequestParameters, CancellationToken)

GET on /_alias/{name}

https://opensearch.org/docs/latest/im-plugin/index-alias/

Declaration

public Task<TResponse> GetAliasForAllAsync<TResponse>(string name, GetAliasRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.
GetAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetAliasForAll<TResponse>(GetAliasRequestParameters)

GET on /_alias

https://opensearch.org/docs/latest/im-plugin/index-alias/

Declaration

public TResponse GetAliasForAll<TResponse>(GetAliasRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetAliasForAll<TResponse>(string, GetAliasRequestParameters)

GET on /_alias/{name}

https://opensearch.org/docs/latest/im-plugin/index-alias/

Declaration

public TResponse GetAliasForAll<TResponse>(string name, GetAliasRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.
GetAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetAlias<TResponse>(string, GetAliasRequestParameters)

GET on /{index}/_alias

https://opensearch.org/docs/latest/im-plugin/index-alias/

Declaration

public TResponse GetAlias<TResponse>(string index, GetAliasRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
GetAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetAlias<TResponse>(string, string, GetAliasRequestParameters)

GET on /{index}/_alias/{name}

https://opensearch.org/docs/latest/im-plugin/index-alias/

Declaration

public TResponse GetAlias<TResponse>(string index, string name, GetAliasRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
string	name	Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.
GetAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetAsync<TResponse>(string, GetIndexRequestParameters, CancellationToken)

GET on /{index}

https://opensearch.org/docs/latest/api-reference/index-apis/get-index/

Declaration

public Task<TResponse> GetAsync<TResponse>(string index, GetIndexRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported.
GetIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetComposableTemplateForAllAsync<TResponse>(GetComposableIndexTemplateRequestParameters, CancellationToken)

GET on /_index_template

https://opensearch.org/docs/latest/im-plugin/index-templates/

Declaration

public Task<TResponse> GetComposableTemplateForAllAsync<TResponse>(GetComposableIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetComposableIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetComposableTemplateForAllAsync<TResponse>(string, GetComposableIndexTemplateRequestParameters, CancellationToken)

GET on /_index_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/

Declaration

public Task<TResponse> GetComposableTemplateForAllAsync<TResponse>(string name, GetComposableIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the index template to retrieve. Wildcard (*) expressions are supported.
GetComposableIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetComposableTemplateForAll<TResponse>(GetComposableIndexTemplateRequestParameters)

GET on /_index_template

https://opensearch.org/docs/latest/im-plugin/index-templates/

Declaration

public TResponse GetComposableTemplateForAll<TResponse>(GetComposableIndexTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetComposableIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetComposableTemplateForAll<TResponse>(string, GetComposableIndexTemplateRequestParameters)

GET on /_index_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/

Declaration

public TResponse GetComposableTemplateForAll<TResponse>(string name, GetComposableIndexTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the index template to retrieve. Wildcard (*) expressions are supported.
GetComposableIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetDataStreamForAllAsync<TResponse>(GetDataStreamRequestParameters, CancellationToken)

GET on /_data_stream

https://opensearch.org/docs/latest/im-plugin/data-streams/

Declaration

public Task<TResponse> GetDataStreamForAllAsync<TResponse>(GetDataStreamRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetDataStreamRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetDataStreamForAllAsync<TResponse>(string, GetDataStreamRequestParameters, CancellationToken)

GET on /_data_stream/{name}

https://opensearch.org/docs/latest/im-plugin/data-streams/

Declaration

public Task<TResponse> GetDataStreamForAllAsync<TResponse>(string name, GetDataStreamRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list of data stream names used to limit the request. Wildcard (*) expressions are supported. If omitted, all data streams are returned.
GetDataStreamRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetDataStreamForAll<TResponse>(GetDataStreamRequestParameters)

GET on /_data_stream

https://opensearch.org/docs/latest/im-plugin/data-streams/

Declaration

public TResponse GetDataStreamForAll<TResponse>(GetDataStreamRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetDataStreamRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetDataStreamForAll<TResponse>(string, GetDataStreamRequestParameters)

GET on /_data_stream/{name}

https://opensearch.org/docs/latest/im-plugin/data-streams/

Declaration

public TResponse GetDataStreamForAll<TResponse>(string name, GetDataStreamRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list of data stream names used to limit the request. Wildcard (*) expressions are supported. If omitted, all data streams are returned.
GetDataStreamRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetFieldMappingAsync<TResponse>(string, string, GetFieldMappingRequestParameters, CancellationToken)

GET on /{index}/_mapping/field/{fields}

https://opensearch.org/docs/latest/field-types/index/

Declaration

public Task<TResponse> GetFieldMappingAsync<TResponse>(string index, string fields, GetFieldMappingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
string	fields	Comma-separated list or wildcard expression of fields used to limit returned information.
GetFieldMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetFieldMappingForAllAsync<TResponse>(string, GetFieldMappingRequestParameters, CancellationToken)

GET on /_mapping/field/{fields}

https://opensearch.org/docs/latest/field-types/index/

Declaration

public Task<TResponse> GetFieldMappingForAllAsync<TResponse>(string fields, GetFieldMappingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	fields	Comma-separated list or wildcard expression of fields used to limit returned information.
GetFieldMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetFieldMappingForAll<TResponse>(string, GetFieldMappingRequestParameters)

GET on /_mapping/field/{fields}

https://opensearch.org/docs/latest/field-types/index/

Declaration

public TResponse GetFieldMappingForAll<TResponse>(string fields, GetFieldMappingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	fields	Comma-separated list or wildcard expression of fields used to limit returned information.
GetFieldMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetFieldMapping<TResponse>(string, string, GetFieldMappingRequestParameters)

GET on /{index}/_mapping/field/{fields}

https://opensearch.org/docs/latest/field-types/index/

Declaration

public TResponse GetFieldMapping<TResponse>(string index, string fields, GetFieldMappingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
string	fields	Comma-separated list or wildcard expression of fields used to limit returned information.
GetFieldMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetMappingAsync<TResponse>(string, GetMappingRequestParameters, CancellationToken)

GET on /{index}/_mapping

https://opensearch.org/docs/latest/field-types/index/#get-a-mapping

Declaration

public Task<TResponse> GetMappingAsync<TResponse>(string index, GetMappingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
GetMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetMappingForAllAsync<TResponse>(GetMappingRequestParameters, CancellationToken)

GET on /_mapping

https://opensearch.org/docs/latest/field-types/index/#get-a-mapping

Declaration

public Task<TResponse> GetMappingForAllAsync<TResponse>(GetMappingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetMappingForAll<TResponse>(GetMappingRequestParameters)

GET on /_mapping

https://opensearch.org/docs/latest/field-types/index/#get-a-mapping

Declaration

public TResponse GetMappingForAll<TResponse>(GetMappingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetMapping<TResponse>(string, GetMappingRequestParameters)

GET on /{index}/_mapping

https://opensearch.org/docs/latest/field-types/index/#get-a-mapping

Declaration

public TResponse GetMapping<TResponse>(string index, GetMappingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
GetMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetSettingsAsync<TResponse>(string, GetIndexSettingsRequestParameters, CancellationToken)

GET on /{index}/_settings

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/

Declaration

public Task<TResponse> GetSettingsAsync<TResponse>(string index, GetIndexSettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
GetIndexSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetSettingsAsync<TResponse>(string, string, GetIndexSettingsRequestParameters, CancellationToken)

GET on /{index}/_settings/{name}

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/

Declaration

public Task<TResponse> GetSettingsAsync<TResponse>(string index, string name, GetIndexSettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
string	name	Comma-separated list or wildcard expression of settings to retrieve.
GetIndexSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetSettingsForAllAsync<TResponse>(GetIndexSettingsRequestParameters, CancellationToken)

GET on /_settings

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/

Declaration

public Task<TResponse> GetSettingsForAllAsync<TResponse>(GetIndexSettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetIndexSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetSettingsForAllAsync<TResponse>(string, GetIndexSettingsRequestParameters, CancellationToken)

GET on /_settings/{name}

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/

Declaration

public Task<TResponse> GetSettingsForAllAsync<TResponse>(string name, GetIndexSettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list or wildcard expression of settings to retrieve.
GetIndexSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetSettingsForAll<TResponse>(GetIndexSettingsRequestParameters)

GET on /_settings

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/

Declaration

public TResponse GetSettingsForAll<TResponse>(GetIndexSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetIndexSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetSettingsForAll<TResponse>(string, GetIndexSettingsRequestParameters)

GET on /_settings/{name}

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/

Declaration

public TResponse GetSettingsForAll<TResponse>(string name, GetIndexSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list or wildcard expression of settings to retrieve.
GetIndexSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetSettings<TResponse>(string, GetIndexSettingsRequestParameters)

GET on /{index}/_settings

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/

Declaration

public TResponse GetSettings<TResponse>(string index, GetIndexSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
GetIndexSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetSettings<TResponse>(string, string, GetIndexSettingsRequestParameters)

GET on /{index}/_settings/{name}

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/

Declaration

public TResponse GetSettings<TResponse>(string index, string name, GetIndexSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
string	name	Comma-separated list or wildcard expression of settings to retrieve.
GetIndexSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetTemplateForAllAsync<TResponse>(GetIndexTemplateRequestParameters, CancellationToken)

GET on /_template

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> GetTemplateForAllAsync<TResponse>(GetIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetTemplateForAllAsync<TResponse>(string, GetIndexTemplateRequestParameters, CancellationToken)

GET on /_template/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> GetTemplateForAllAsync<TResponse>(string name, GetIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. To return all index templates, omit this parameter or use a value of _all or *.
GetIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetTemplateForAll<TResponse>(GetIndexTemplateRequestParameters)

GET on /_template

https://opensearch.org/docs/latest

Declaration

public TResponse GetTemplateForAll<TResponse>(GetIndexTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetTemplateForAll<TResponse>(string, GetIndexTemplateRequestParameters)

GET on /_template/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse GetTemplateForAll<TResponse>(string name, GetIndexTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. To return all index templates, omit this parameter or use a value of _all or *.
GetIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetUpgradeAsync<TResponse>(string, GetUpgradeRequestParameters, CancellationToken)

GET on /{index}/_upgrade

https://opensearch.org/docs/latest

Declaration

[Obsolete("Deprecated in version 1.0.0: ")]
public Task<TResponse> GetUpgradeAsync<TResponse>(string index, GetUpgradeRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of indexes; use the special string _all or Indices.All to perform the operation on all indexes.
GetUpgradeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetUpgradeForAllAsync<TResponse>(GetUpgradeRequestParameters, CancellationToken)

GET on /_upgrade

https://opensearch.org/docs/latest

Declaration

[Obsolete("Deprecated in version 1.0.0: ")]
public Task<TResponse> GetUpgradeForAllAsync<TResponse>(GetUpgradeRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetUpgradeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetUpgradeForAll<TResponse>(GetUpgradeRequestParameters)

GET on /_upgrade

https://opensearch.org/docs/latest

Declaration

[Obsolete("Deprecated in version 1.0.0: ")]
public TResponse GetUpgradeForAll<TResponse>(GetUpgradeRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetUpgradeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetUpgrade<TResponse>(string, GetUpgradeRequestParameters)

GET on /{index}/_upgrade

https://opensearch.org/docs/latest

Declaration

[Obsolete("Deprecated in version 1.0.0: ")]
public TResponse GetUpgrade<TResponse>(string index, GetUpgradeRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of indexes; use the special string _all or Indices.All to perform the operation on all indexes.
GetUpgradeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Get<TResponse>(string, GetIndexRequestParameters)

GET on /{index}

https://opensearch.org/docs/latest/api-reference/index-apis/get-index/

Declaration

public TResponse Get<TResponse>(string index, GetIndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported.
GetIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

OpenAsync<TResponse>(string, OpenIndexRequestParameters, CancellationToken)

POST on /{index}/_open

https://opensearch.org/docs/latest/api-reference/index-apis/open-index/

Declaration

public Task<TResponse> OpenAsync<TResponse>(string index, OpenIndexRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). By default, you must explicitly name the indexes you using to limit the request. To limit a request using _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the opensearch.yml file or using the cluster update settings API.
OpenIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Open<TResponse>(string, OpenIndexRequestParameters)

POST on /{index}/_open

https://opensearch.org/docs/latest/api-reference/index-apis/open-index/

Declaration

public TResponse Open<TResponse>(string index, OpenIndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). By default, you must explicitly name the indexes you using to limit the request. To limit a request using _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the opensearch.yml file or using the cluster update settings API.
OpenIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutAliasAsync<TResponse>(string, PostData, PutAliasRequestParameters, CancellationToken)

PUT on /{index}/_alias

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/

Declaration

public Task<TResponse> PutAliasAsync<TResponse>(string index, PostData body, PutAliasRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams or indexes to add. Supports wildcards (*). Wildcard patterns that match both data streams and indexes return an error.
PostData	body	The settings for the alias, such as routing or filter.
PutAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutAliasAsync<TResponse>(string, string, PostData, PutAliasRequestParameters, CancellationToken)

PUT on /{index}/_alias/{name}

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/

Declaration

public Task<TResponse> PutAliasAsync<TResponse>(string index, string name, PostData body, PutAliasRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams or indexes to add. Supports wildcards (*). Wildcard patterns that match both data streams and indexes return an error.
string	name	Alias to update. If the alias doesn't exist, the request creates it. Index alias names support date math.
PostData	body	The settings for the alias, such as routing or filter.
PutAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutAliasForAllAsync<TResponse>(PostData, PutAliasRequestParameters, CancellationToken)

PUT on /_alias

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/

Declaration

public Task<TResponse> PutAliasForAllAsync<TResponse>(PostData body, PutAliasRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The settings for the alias, such as routing or filter.
PutAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutAliasForAllAsync<TResponse>(string, PostData, PutAliasRequestParameters, CancellationToken)

PUT on /_alias/{name}

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/

Declaration

public Task<TResponse> PutAliasForAllAsync<TResponse>(string name, PostData body, PutAliasRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Alias to update. If the alias doesn't exist, the request creates it. Index alias names support date math.
PostData	body	The settings for the alias, such as routing or filter.
PutAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutAliasForAll<TResponse>(PostData, PutAliasRequestParameters)

PUT on /_alias

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/

Declaration

public TResponse PutAliasForAll<TResponse>(PostData body, PutAliasRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The settings for the alias, such as routing or filter.
PutAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutAliasForAll<TResponse>(string, PostData, PutAliasRequestParameters)

PUT on /_alias/{name}

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/

Declaration

public TResponse PutAliasForAll<TResponse>(string name, PostData body, PutAliasRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Alias to update. If the alias doesn't exist, the request creates it. Index alias names support date math.
PostData	body	The settings for the alias, such as routing or filter.
PutAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutAlias<TResponse>(string, PostData, PutAliasRequestParameters)

PUT on /{index}/_alias

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/

Declaration

public TResponse PutAlias<TResponse>(string index, PostData body, PutAliasRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams or indexes to add. Supports wildcards (*). Wildcard patterns that match both data streams and indexes return an error.
PostData	body	The settings for the alias, such as routing or filter.
PutAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutAlias<TResponse>(string, string, PostData, PutAliasRequestParameters)

PUT on /{index}/_alias/{name}

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/

Declaration

public TResponse PutAlias<TResponse>(string index, string name, PostData body, PutAliasRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams or indexes to add. Supports wildcards (*). Wildcard patterns that match both data streams and indexes return an error.
string	name	Alias to update. If the alias doesn't exist, the request creates it. Index alias names support date math.
PostData	body	The settings for the alias, such as routing or filter.
PutAliasRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutComposableTemplateForAllAsync<TResponse>(string, PostData, PutComposableIndexTemplateRequestParameters, CancellationToken)

PUT on /_index_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/

Declaration

public Task<TResponse> PutComposableTemplateForAllAsync<TResponse>(string name, PostData body, PutComposableIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Index or template name.
PostData	body	The template definition.
PutComposableIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutComposableTemplateForAll<TResponse>(string, PostData, PutComposableIndexTemplateRequestParameters)

PUT on /_index_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/

Declaration

public TResponse PutComposableTemplateForAll<TResponse>(string name, PostData body, PutComposableIndexTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Index or template name.
PostData	body	The template definition.
PutComposableIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutMappingAsync<TResponse>(string, PostData, PutMappingRequestParameters, CancellationToken)

PUT on /{index}/_mapping

https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/

Declaration

public Task<TResponse> PutMappingAsync<TResponse>(string index, PostData body, PutMappingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	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 indexes.
PostData	body	The mapping definition.
PutMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutMapping<TResponse>(string, PostData, PutMappingRequestParameters)

PUT on /{index}/_mapping

https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/

Declaration

public TResponse PutMapping<TResponse>(string index, PostData body, PutMappingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	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 indexes.
PostData	body	The mapping definition.
PutMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutTemplateForAllAsync<TResponse>(string, PostData, PutIndexTemplateRequestParameters, CancellationToken)

PUT on /_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/

Declaration

public Task<TResponse> PutTemplateForAllAsync<TResponse>(string name, PostData body, PutIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the template.
PostData	body	The template definition.
PutIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutTemplateForAll<TResponse>(string, PostData, PutIndexTemplateRequestParameters)

PUT on /_template/{name}

https://opensearch.org/docs/latest/im-plugin/index-templates/

Declaration

public TResponse PutTemplateForAll<TResponse>(string name, PostData body, PutIndexTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the template.
PostData	body	The template definition.
PutIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RecoveryStatusAsync<TResponse>(string, RecoveryStatusRequestParameters, CancellationToken)

GET on /{index}/_recovery

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> RecoveryStatusAsync<TResponse>(string index, RecoveryStatusRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
RecoveryStatusRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RecoveryStatusForAllAsync<TResponse>(RecoveryStatusRequestParameters, CancellationToken)

GET on /_recovery

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> RecoveryStatusForAllAsync<TResponse>(RecoveryStatusRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
RecoveryStatusRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RecoveryStatusForAll<TResponse>(RecoveryStatusRequestParameters)

GET on /_recovery

https://opensearch.org/docs/latest

Declaration

public TResponse RecoveryStatusForAll<TResponse>(RecoveryStatusRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
RecoveryStatusRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RecoveryStatus<TResponse>(string, RecoveryStatusRequestParameters)

GET on /{index}/_recovery

https://opensearch.org/docs/latest

Declaration

public TResponse RecoveryStatus<TResponse>(string index, RecoveryStatusRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
RecoveryStatusRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RefreshAsync<TResponse>(string, RefreshRequestParameters, CancellationToken)

POST on /{index}/_refresh

https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability

Declaration

public Task<TResponse> RefreshAsync<TResponse>(string index, RefreshRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
RefreshRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RefreshForAllAsync<TResponse>(RefreshRequestParameters, CancellationToken)

POST on /_refresh

https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability

Declaration

public Task<TResponse> RefreshForAllAsync<TResponse>(RefreshRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
RefreshRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RefreshForAll<TResponse>(RefreshRequestParameters)

POST on /_refresh

https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability

Declaration

public TResponse RefreshForAll<TResponse>(RefreshRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
RefreshRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Refresh<TResponse>(string, RefreshRequestParameters)

POST on /{index}/_refresh

https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability

Declaration

public TResponse Refresh<TResponse>(string index, RefreshRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
RefreshRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ResolveForAllAsync<TResponse>(string, ResolveIndexRequestParameters, CancellationToken)

GET on /_resolve/index/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> ResolveForAllAsync<TResponse>(string name, ResolveIndexRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated name(s) or index pattern(s) of the indexes, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax.
ResolveIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ResolveForAll<TResponse>(string, ResolveIndexRequestParameters)

GET on /_resolve/index/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse ResolveForAll<TResponse>(string name, ResolveIndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Comma-separated name(s) or index pattern(s) of the indexes, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax.
ResolveIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RolloverForAllAsync<TResponse>(string, PostData, RolloverIndexRequestParameters, CancellationToken)

POST on /{alias}/_rollover

https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/

Declaration

public Task<TResponse> RolloverForAllAsync<TResponse>(string alias, PostData body, RolloverIndexRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	alias	Name of the data stream or index alias to roll over.
PostData	body	The conditions that needs to be met for executing rollover.
RolloverIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RolloverForAllAsync<TResponse>(string, string, PostData, RolloverIndexRequestParameters, CancellationToken)

POST on /{alias}/_rollover/{new_index}

https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/

Declaration

public Task<TResponse> RolloverForAllAsync<TResponse>(string alias, string newIndex, PostData body, RolloverIndexRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	alias	Name of the data stream or index alias to roll over.
string	newIndex	Name of the index to create. Supports date math. Data streams do not support this parameter.
PostData	body	The conditions that needs to be met for executing rollover.
RolloverIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

RolloverForAll<TResponse>(string, PostData, RolloverIndexRequestParameters)

POST on /{alias}/_rollover

https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/

Declaration

public TResponse RolloverForAll<TResponse>(string alias, PostData body, RolloverIndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	alias	Name of the data stream or index alias to roll over.
PostData	body	The conditions that needs to be met for executing rollover.
RolloverIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

RolloverForAll<TResponse>(string, string, PostData, RolloverIndexRequestParameters)

POST on /{alias}/_rollover/{new_index}

https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/

Declaration

public TResponse RolloverForAll<TResponse>(string alias, string newIndex, PostData body, RolloverIndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	alias	Name of the data stream or index alias to roll over.
string	newIndex	Name of the index to create. Supports date math. Data streams do not support this parameter.
PostData	body	The conditions that needs to be met for executing rollover.
RolloverIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SegmentsAsync<TResponse>(string, SegmentsRequestParameters, CancellationToken)

GET on /{index}/_segments

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> SegmentsAsync<TResponse>(string index, SegmentsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
SegmentsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SegmentsForAllAsync<TResponse>(SegmentsRequestParameters, CancellationToken)

GET on /_segments

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> SegmentsForAllAsync<TResponse>(SegmentsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
SegmentsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SegmentsForAll<TResponse>(SegmentsRequestParameters)

GET on /_segments

https://opensearch.org/docs/latest

Declaration

public TResponse SegmentsForAll<TResponse>(SegmentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
SegmentsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Segments<TResponse>(string, SegmentsRequestParameters)

GET on /{index}/_segments

https://opensearch.org/docs/latest

Declaration

public TResponse Segments<TResponse>(string index, SegmentsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
SegmentsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ShardStoresAsync<TResponse>(string, IndicesShardStoresRequestParameters, CancellationToken)

GET on /{index}/_shard_stores

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> ShardStoresAsync<TResponse>(string index, IndicesShardStoresRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	List of data streams, indexes, and aliases used to limit the request.
IndicesShardStoresRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ShardStoresForAllAsync<TResponse>(IndicesShardStoresRequestParameters, CancellationToken)

GET on /_shard_stores

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> ShardStoresForAllAsync<TResponse>(IndicesShardStoresRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
IndicesShardStoresRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ShardStoresForAll<TResponse>(IndicesShardStoresRequestParameters)

GET on /_shard_stores

https://opensearch.org/docs/latest

Declaration

public TResponse ShardStoresForAll<TResponse>(IndicesShardStoresRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
IndicesShardStoresRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ShardStores<TResponse>(string, IndicesShardStoresRequestParameters)

GET on /{index}/_shard_stores

https://opensearch.org/docs/latest

Declaration

public TResponse ShardStores<TResponse>(string index, IndicesShardStoresRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	List of data streams, indexes, and aliases used to limit the request.
IndicesShardStoresRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ShrinkAsync<TResponse>(string, string, PostData, ShrinkIndexRequestParameters, CancellationToken)

PUT on /{index}/_shrink/{target}

https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/

Declaration

public Task<TResponse> ShrinkAsync<TResponse>(string index, string target, PostData body, ShrinkIndexRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the source index to shrink.
string	target	Name of the target index to create.
PostData	body	The configuration for the target index (settings and aliases).
ShrinkIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Shrink<TResponse>(string, string, PostData, ShrinkIndexRequestParameters)

PUT on /{index}/_shrink/{target}

https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/

Declaration

public TResponse Shrink<TResponse>(string index, string target, PostData body, ShrinkIndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the source index to shrink.
string	target	Name of the target index to create.
PostData	body	The configuration for the target index (settings and aliases).
ShrinkIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SimulateIndexTemplateForAllAsync<TResponse>(string, PostData, SimulateIndexTemplateRequestParameters, CancellationToken)

POST on /_index_template/_simulate_index/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> SimulateIndexTemplateForAllAsync<TResponse>(string name, PostData body, SimulateIndexTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Index or template name to simulate.
PostData	body	New index template definition, which will be included in the simulation, as if it already exists in the system.
SimulateIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SimulateIndexTemplateForAll<TResponse>(string, PostData, SimulateIndexTemplateRequestParameters)

POST on /_index_template/_simulate_index/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse SimulateIndexTemplateForAll<TResponse>(string name, PostData body, SimulateIndexTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Index or template name to simulate.
PostData	body	New index template definition, which will be included in the simulation, as if it already exists in the system.
SimulateIndexTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SimulateTemplateForAllAsync<TResponse>(PostData, SimulateTemplateRequestParameters, CancellationToken)

POST on /_index_template/_simulate

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> SimulateTemplateForAllAsync<TResponse>(PostData body, SimulateTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	New index template definition to be simulated, if no index template name is specified.
SimulateTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SimulateTemplateForAllAsync<TResponse>(string, PostData, SimulateTemplateRequestParameters, CancellationToken)

POST on /_index_template/_simulate/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> SimulateTemplateForAllAsync<TResponse>(string name, PostData body, SimulateTemplateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.
PostData	body	New index template definition to be simulated, if no index template name is specified.
SimulateTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

SimulateTemplateForAll<TResponse>(PostData, SimulateTemplateRequestParameters)

POST on /_index_template/_simulate

https://opensearch.org/docs/latest

Declaration

public TResponse SimulateTemplateForAll<TResponse>(PostData body, SimulateTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	New index template definition to be simulated, if no index template name is specified.
SimulateTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SimulateTemplateForAll<TResponse>(string, PostData, SimulateTemplateRequestParameters)

POST on /_index_template/_simulate/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse SimulateTemplateForAll<TResponse>(string name, PostData body, SimulateTemplateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.
PostData	body	New index template definition to be simulated, if no index template name is specified.
SimulateTemplateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SplitAsync<TResponse>(string, string, PostData, SplitIndexRequestParameters, CancellationToken)

PUT on /{index}/_split/{target}

https://opensearch.org/docs/latest/api-reference/index-apis/split/

Declaration

public Task<TResponse> SplitAsync<TResponse>(string index, string target, PostData body, SplitIndexRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the source index to split.
string	target	Name of the target index to create.
PostData	body	The configuration for the target index (settings and aliases).
SplitIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Split<TResponse>(string, string, PostData, SplitIndexRequestParameters)

PUT on /{index}/_split/{target}

https://opensearch.org/docs/latest/api-reference/index-apis/split/

Declaration

public TResponse Split<TResponse>(string index, string target, PostData body, SplitIndexRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Name of the source index to split.
string	target	Name of the target index to create.
PostData	body	The configuration for the target index (settings and aliases).
SplitIndexRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

StatsAsync<TResponse>(string, IndicesStatsRequestParameters, CancellationToken)

GET on /{index}/_stats

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> StatsAsync<TResponse>(string index, IndicesStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of index names; use the special string _all or Indices.All to perform the operation on all indexes.
IndicesStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

StatsAsync<TResponse>(string, IndicesStatsMetric?, IndicesStatsRequestParameters, CancellationToken)

GET on /{index}/_stats/{metric}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> StatsAsync<TResponse>(string index, IndicesStatsMetric? metric, IndicesStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of index names; use the special string _all or Indices.All to perform the operation on all indexes.
IndicesStatsMetric?	metric	Limit the information returned the specific metrics.
IndicesStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

StatsForAllAsync<TResponse>(IndicesStatsRequestParameters, CancellationToken)

GET on /_stats

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> StatsForAllAsync<TResponse>(IndicesStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
IndicesStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

StatsForAllAsync<TResponse>(IndicesStatsMetric?, IndicesStatsRequestParameters, CancellationToken)

GET on /_stats/{metric}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> StatsForAllAsync<TResponse>(IndicesStatsMetric? metric, IndicesStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
IndicesStatsMetric?	metric	Limit the information returned the specific metrics.
IndicesStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

StatsForAll<TResponse>(IndicesStatsRequestParameters)

GET on /_stats

https://opensearch.org/docs/latest

Declaration

public TResponse StatsForAll<TResponse>(IndicesStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
IndicesStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

StatsForAll<TResponse>(IndicesStatsMetric?, IndicesStatsRequestParameters)

GET on /_stats/{metric}

https://opensearch.org/docs/latest

Declaration

public TResponse StatsForAll<TResponse>(IndicesStatsMetric? metric, IndicesStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
IndicesStatsMetric?	metric	Limit the information returned the specific metrics.
IndicesStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Stats<TResponse>(string, IndicesStatsRequestParameters)

GET on /{index}/_stats

https://opensearch.org/docs/latest

Declaration

public TResponse Stats<TResponse>(string index, IndicesStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of index names; use the special string _all or Indices.All to perform the operation on all indexes.
IndicesStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Stats<TResponse>(string, IndicesStatsMetric?, IndicesStatsRequestParameters)

GET on /{index}/_stats/{metric}

https://opensearch.org/docs/latest

Declaration

public TResponse Stats<TResponse>(string index, IndicesStatsMetric? metric, IndicesStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of index names; use the special string _all or Indices.All to perform the operation on all indexes.
IndicesStatsMetric?	metric	Limit the information returned the specific metrics.
IndicesStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

TemplateExistsForAllAsync<TResponse>(string, IndexTemplateExistsRequestParameters, CancellationToken)

HEAD on /_template/{name}

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> TemplateExistsForAllAsync<TResponse>(string name, IndexTemplateExistsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The comma separated names of the index templates.
IndexTemplateExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

TemplateExistsForAll<TResponse>(string, IndexTemplateExistsRequestParameters)

HEAD on /_template/{name}

https://opensearch.org/docs/latest

Declaration

public TResponse TemplateExistsForAll<TResponse>(string name, IndexTemplateExistsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The comma separated names of the index templates.
IndexTemplateExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

TypeExistsAsync<TResponse>(string, string, TypeExistsRequestParameters, CancellationToken)

HEAD on /{index}/_mapping/{type}

https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/

Declaration

public Task<TResponse> TypeExistsAsync<TResponse>(string index, string type, TypeExistsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of index names; use _all to check the types across all indices
string	type	A comma-separated list of document types to check
TypeExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Deprecated as of OpenSearch 2.0

TypeExists<TResponse>(string, string, TypeExistsRequestParameters)

HEAD on /{index}/_mapping/{type}

https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/

Declaration

public TResponse TypeExists<TResponse>(string index, string type, TypeExistsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	A comma-separated list of index names; use _all to check the types across all indices
string	type	A comma-separated list of document types to check
TypeExistsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Deprecated as of OpenSearch 2.0

UpdateSettingsAsync<TResponse>(string, PostData, UpdateIndexSettingsRequestParameters, CancellationToken)

PUT on /{index}/_settings

https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/

Declaration

public Task<TResponse> UpdateSettingsAsync<TResponse>(string index, PostData body, UpdateIndexSettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
PostData	body	The index settings to be updated.
UpdateIndexSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

UpdateSettingsForAllAsync<TResponse>(PostData, UpdateIndexSettingsRequestParameters, CancellationToken)

PUT on /_settings

https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/

Declaration

public Task<TResponse> UpdateSettingsForAllAsync<TResponse>(PostData body, UpdateIndexSettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The index settings to be updated.
UpdateIndexSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

UpdateSettingsForAll<TResponse>(PostData, UpdateIndexSettingsRequestParameters)

PUT on /_settings

https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/

Declaration

public TResponse UpdateSettingsForAll<TResponse>(PostData body, UpdateIndexSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The index settings to be updated.
UpdateIndexSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

UpdateSettings<TResponse>(string, PostData, UpdateIndexSettingsRequestParameters)

PUT on /{index}/_settings

https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/

Declaration

public TResponse UpdateSettings<TResponse>(string index, PostData body, UpdateIndexSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
PostData	body	The index settings to be updated.
UpdateIndexSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

UpgradeAsync<TResponse>(string, UpgradeRequestParameters, CancellationToken)

POST on /{index}/_upgrade

https://opensearch.org/docs/latest

Declaration

[Obsolete("Deprecated in version 1.0.0: ")]
public Task<TResponse> UpgradeAsync<TResponse>(string index, UpgradeRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of indexes; use the special string _all or Indices.All to perform the operation on all indexes.
UpgradeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

UpgradeForAllAsync<TResponse>(UpgradeRequestParameters, CancellationToken)

POST on /_upgrade

https://opensearch.org/docs/latest

Declaration

[Obsolete("Deprecated in version 1.0.0: ")]
public Task<TResponse> UpgradeForAllAsync<TResponse>(UpgradeRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
UpgradeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

UpgradeForAll<TResponse>(UpgradeRequestParameters)

POST on /_upgrade

https://opensearch.org/docs/latest

Declaration

[Obsolete("Deprecated in version 1.0.0: ")]
public TResponse UpgradeForAll<TResponse>(UpgradeRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
UpgradeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Upgrade<TResponse>(string, UpgradeRequestParameters)

POST on /{index}/_upgrade

https://opensearch.org/docs/latest

Declaration

[Obsolete("Deprecated in version 1.0.0: ")]
public TResponse Upgrade<TResponse>(string index, UpgradeRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of indexes; use the special string _all or Indices.All to perform the operation on all indexes.
UpgradeRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ValidateQueryAsync<TResponse>(string, PostData, ValidateQueryRequestParameters, CancellationToken)

POST on /{index}/_validate/query

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> ValidateQueryAsync<TResponse>(string index, PostData body, ValidateQueryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). To search all data streams or indexes, omit this parameter or use * or _all.
PostData	body	The query definition specified with the Query DSL.
ValidateQueryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ValidateQueryForAllAsync<TResponse>(PostData, ValidateQueryRequestParameters, CancellationToken)

POST on /_validate/query

https://opensearch.org/docs/latest

Declaration

public Task<TResponse> ValidateQueryForAllAsync<TResponse>(PostData body, ValidateQueryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The query definition specified with the Query DSL.
ValidateQueryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

ValidateQueryForAll<TResponse>(PostData, ValidateQueryRequestParameters)

POST on /_validate/query

https://opensearch.org/docs/latest

Declaration

public TResponse ValidateQueryForAll<TResponse>(PostData body, ValidateQueryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The query definition specified with the Query DSL.
ValidateQueryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

ValidateQuery<TResponse>(string, PostData, ValidateQueryRequestParameters)

POST on /{index}/_validate/query

https://opensearch.org/docs/latest

Declaration

public TResponse ValidateQuery<TResponse>(string index, PostData body, ValidateQueryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	index	Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). To search all data streams or indexes, omit this parameter or use * or _all.
PostData	body	The query definition specified with the Query DSL.
ValidateQueryRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Extension Methods

SuffixExtensions.Suffix(object, string)