Interface IIndicesNamespace

Indices APIs.

Use the Indices property on IOpenSearchClient.

Namespace: OpenSearch.Client.Specification.IndicesApi
Assembly: OpenSearch.Client.dll
Syntax
public interface IIndicesNamespace

Methods

| Edit this page View Source

AddBlock(IAddIndexBlockRequest)

PUT request to the indices.add_block API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
AddIndexBlockResponse AddBlock(IAddIndexBlockRequest request)
Parameters
Type Name Description
IAddIndexBlockRequest request
Returns
Type Description
AddIndexBlockResponse
| Edit this page View Source

AddBlock(Indices, IndexBlock, Func<AddIndexBlockDescriptor, IAddIndexBlockRequest>)

PUT request to the indices.add_block API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
AddIndexBlockResponse AddBlock(Indices index, IndexBlock block, Func<AddIndexBlockDescriptor, IAddIndexBlockRequest> selector = null)
Parameters
Type Name Description
Indices index
IndexBlock block
Func<AddIndexBlockDescriptor, IAddIndexBlockRequest> selector
Returns
Type Description
AddIndexBlockResponse
| Edit this page View Source

AddBlockAsync(IAddIndexBlockRequest, CancellationToken)

PUT request to the indices.add_block API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<AddIndexBlockResponse> AddBlockAsync(IAddIndexBlockRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IAddIndexBlockRequest request
CancellationToken ct
Returns
Type Description
Task<AddIndexBlockResponse>
| Edit this page View Source

AddBlockAsync(Indices, IndexBlock, Func<AddIndexBlockDescriptor, IAddIndexBlockRequest>, CancellationToken)

PUT request to the indices.add_block API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<AddIndexBlockResponse> AddBlockAsync(Indices index, IndexBlock block, Func<AddIndexBlockDescriptor, IAddIndexBlockRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
IndexBlock block
Func<AddIndexBlockDescriptor, IAddIndexBlockRequest> selector
CancellationToken ct
Returns
Type Description
Task<AddIndexBlockResponse>
| Edit this page View Source

AliasExists(IAliasExistsRequest)

HEAD request to the indices.exists_alias API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
ExistsResponse AliasExists(IAliasExistsRequest request)
Parameters
Type Name Description
IAliasExistsRequest request
Returns
Type Description
ExistsResponse
| Edit this page View Source

AliasExists(Names, Func<AliasExistsDescriptor, IAliasExistsRequest>)

HEAD request to the indices.exists_alias API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
ExistsResponse AliasExists(Names name, Func<AliasExistsDescriptor, IAliasExistsRequest> selector = null)
Parameters
Type Name Description
Names name
Func<AliasExistsDescriptor, IAliasExistsRequest> selector
Returns
Type Description
ExistsResponse
| Edit this page View Source

AliasExistsAsync(IAliasExistsRequest, CancellationToken)

HEAD request to the indices.exists_alias API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<ExistsResponse> AliasExistsAsync(IAliasExistsRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IAliasExistsRequest request
CancellationToken ct
Returns
Type Description
Task<ExistsResponse>
| Edit this page View Source

AliasExistsAsync(Names, Func<AliasExistsDescriptor, IAliasExistsRequest>, CancellationToken)

HEAD request to the indices.exists_alias API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<ExistsResponse> AliasExistsAsync(Names name, Func<AliasExistsDescriptor, IAliasExistsRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Names name
Func<AliasExistsDescriptor, IAliasExistsRequest> selector
CancellationToken ct
Returns
Type Description
Task<ExistsResponse>
| Edit this page View Source

Analyze(IAnalyzeRequest)

POST request to the indices.analyze API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/
Declaration
AnalyzeResponse Analyze(IAnalyzeRequest request)
Parameters
Type Name Description
IAnalyzeRequest request
Returns
Type Description
AnalyzeResponse
| Edit this page View Source

Analyze(Func<AnalyzeDescriptor, IAnalyzeRequest>)

POST request to the indices.analyze API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/
Declaration
AnalyzeResponse Analyze(Func<AnalyzeDescriptor, IAnalyzeRequest> selector = null)
Parameters
Type Name Description
Func<AnalyzeDescriptor, IAnalyzeRequest> selector
Returns
Type Description
AnalyzeResponse
| Edit this page View Source

AnalyzeAsync(IAnalyzeRequest, CancellationToken)

POST request to the indices.analyze API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/
Declaration
Task<AnalyzeResponse> AnalyzeAsync(IAnalyzeRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IAnalyzeRequest request
CancellationToken ct
Returns
Type Description
Task<AnalyzeResponse>
| Edit this page View Source

AnalyzeAsync(Func<AnalyzeDescriptor, IAnalyzeRequest>, CancellationToken)

POST request to the indices.analyze API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/
Declaration
Task<AnalyzeResponse> AnalyzeAsync(Func<AnalyzeDescriptor, IAnalyzeRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Func<AnalyzeDescriptor, IAnalyzeRequest> selector
CancellationToken ct
Returns
Type Description
Task<AnalyzeResponse>
| Edit this page View Source

BulkAlias(IBulkAliasRequest)

POST request to the indices.update_aliases API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/alias/
Declaration
BulkAliasResponse BulkAlias(IBulkAliasRequest request)
Parameters
Type Name Description
IBulkAliasRequest request
Returns
Type Description
BulkAliasResponse
| Edit this page View Source

BulkAlias(Func<BulkAliasDescriptor, IBulkAliasRequest>)

POST request to the indices.update_aliases API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/alias/
Declaration
BulkAliasResponse BulkAlias(Func<BulkAliasDescriptor, IBulkAliasRequest> selector)
Parameters
Type Name Description
Func<BulkAliasDescriptor, IBulkAliasRequest> selector
Returns
Type Description
BulkAliasResponse
| Edit this page View Source

BulkAliasAsync(IBulkAliasRequest, CancellationToken)

POST request to the indices.update_aliases API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/alias/
Declaration
Task<BulkAliasResponse> BulkAliasAsync(IBulkAliasRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IBulkAliasRequest request
CancellationToken ct
Returns
Type Description
Task<BulkAliasResponse>
| Edit this page View Source

BulkAliasAsync(Func<BulkAliasDescriptor, IBulkAliasRequest>, CancellationToken)

POST request to the indices.update_aliases API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/alias/
Declaration
Task<BulkAliasResponse> BulkAliasAsync(Func<BulkAliasDescriptor, IBulkAliasRequest> selector, CancellationToken ct = default)
Parameters
Type Name Description
Func<BulkAliasDescriptor, IBulkAliasRequest> selector
CancellationToken ct
Returns
Type Description
Task<BulkAliasResponse>
| Edit this page View Source

ClearCache(IClearCacheRequest)

POST request to the indices.clear_cache API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/
Declaration
ClearCacheResponse ClearCache(IClearCacheRequest request)
Parameters
Type Name Description
IClearCacheRequest request
Returns
Type Description
ClearCacheResponse
| Edit this page View Source

ClearCache(Indices, Func<ClearCacheDescriptor, IClearCacheRequest>)

POST request to the indices.clear_cache API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/
Declaration
ClearCacheResponse ClearCache(Indices index = null, Func<ClearCacheDescriptor, IClearCacheRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<ClearCacheDescriptor, IClearCacheRequest> selector
Returns
Type Description
ClearCacheResponse
| Edit this page View Source

ClearCacheAsync(IClearCacheRequest, CancellationToken)

POST request to the indices.clear_cache API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/
Declaration
Task<ClearCacheResponse> ClearCacheAsync(IClearCacheRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IClearCacheRequest request
CancellationToken ct
Returns
Type Description
Task<ClearCacheResponse>
| Edit this page View Source

ClearCacheAsync(Indices, Func<ClearCacheDescriptor, IClearCacheRequest>, CancellationToken)

POST request to the indices.clear_cache API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/
Declaration
Task<ClearCacheResponse> ClearCacheAsync(Indices index = null, Func<ClearCacheDescriptor, IClearCacheRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<ClearCacheDescriptor, IClearCacheRequest> selector
CancellationToken ct
Returns
Type Description
Task<ClearCacheResponse>
| Edit this page View Source

Clone(ICloneIndexRequest)

PUT request to the indices.clone API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/clone/
Declaration
CloneIndexResponse Clone(ICloneIndexRequest request)
Parameters
Type Name Description
ICloneIndexRequest request
Returns
Type Description
CloneIndexResponse
| Edit this page View Source

Clone(IndexName, IndexName, Func<CloneIndexDescriptor, ICloneIndexRequest>)

PUT request to the indices.clone API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/clone/
Declaration
CloneIndexResponse Clone(IndexName index, IndexName target, Func<CloneIndexDescriptor, ICloneIndexRequest> selector = null)
Parameters
Type Name Description
IndexName index
IndexName target
Func<CloneIndexDescriptor, ICloneIndexRequest> selector
Returns
Type Description
CloneIndexResponse
| Edit this page View Source

CloneAsync(ICloneIndexRequest, CancellationToken)

PUT request to the indices.clone API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/clone/
Declaration
Task<CloneIndexResponse> CloneAsync(ICloneIndexRequest request, CancellationToken ct = default)
Parameters
Type Name Description
ICloneIndexRequest request
CancellationToken ct
Returns
Type Description
Task<CloneIndexResponse>
| Edit this page View Source

CloneAsync(IndexName, IndexName, Func<CloneIndexDescriptor, ICloneIndexRequest>, CancellationToken)

PUT request to the indices.clone API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/clone/
Declaration
Task<CloneIndexResponse> CloneAsync(IndexName index, IndexName target, Func<CloneIndexDescriptor, ICloneIndexRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
IndexName index
IndexName target
Func<CloneIndexDescriptor, ICloneIndexRequest> selector
CancellationToken ct
Returns
Type Description
Task<CloneIndexResponse>
| Edit this page View Source

Close(ICloseIndexRequest)

POST request to the indices.close API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/close-index/
Declaration
CloseIndexResponse Close(ICloseIndexRequest request)
Parameters
Type Name Description
ICloseIndexRequest request
Returns
Type Description
CloseIndexResponse
| Edit this page View Source

Close(Indices, Func<CloseIndexDescriptor, ICloseIndexRequest>)

POST request to the indices.close API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/close-index/
Declaration
CloseIndexResponse Close(Indices index, Func<CloseIndexDescriptor, ICloseIndexRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<CloseIndexDescriptor, ICloseIndexRequest> selector
Returns
Type Description
CloseIndexResponse
| Edit this page View Source

CloseAsync(ICloseIndexRequest, CancellationToken)

POST request to the indices.close API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/close-index/
Declaration
Task<CloseIndexResponse> CloseAsync(ICloseIndexRequest request, CancellationToken ct = default)
Parameters
Type Name Description
ICloseIndexRequest request
CancellationToken ct
Returns
Type Description
Task<CloseIndexResponse>
| Edit this page View Source

CloseAsync(Indices, Func<CloseIndexDescriptor, ICloseIndexRequest>, CancellationToken)

POST request to the indices.close API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/close-index/
Declaration
Task<CloseIndexResponse> CloseAsync(Indices index, Func<CloseIndexDescriptor, ICloseIndexRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<CloseIndexDescriptor, ICloseIndexRequest> selector
CancellationToken ct
Returns
Type Description
Task<CloseIndexResponse>
| Edit this page View Source

ComposableTemplateExists(IComposableIndexTemplateExistsRequest)

HEAD request to the indices.exists_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
ExistsResponse ComposableTemplateExists(IComposableIndexTemplateExistsRequest request)
Parameters
Type Name Description
IComposableIndexTemplateExistsRequest request
Returns
Type Description
ExistsResponse
| Edit this page View Source

ComposableTemplateExists(Name, Func<ComposableIndexTemplateExistsDescriptor, IComposableIndexTemplateExistsRequest>)

HEAD request to the indices.exists_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
ExistsResponse ComposableTemplateExists(Name name, Func<ComposableIndexTemplateExistsDescriptor, IComposableIndexTemplateExistsRequest> selector = null)
Parameters
Type Name Description
Name name
Func<ComposableIndexTemplateExistsDescriptor, IComposableIndexTemplateExistsRequest> selector
Returns
Type Description
ExistsResponse
| Edit this page View Source

ComposableTemplateExistsAsync(IComposableIndexTemplateExistsRequest, CancellationToken)

HEAD request to the indices.exists_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
Task<ExistsResponse> ComposableTemplateExistsAsync(IComposableIndexTemplateExistsRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IComposableIndexTemplateExistsRequest request
CancellationToken ct
Returns
Type Description
Task<ExistsResponse>
| Edit this page View Source

ComposableTemplateExistsAsync(Name, Func<ComposableIndexTemplateExistsDescriptor, IComposableIndexTemplateExistsRequest>, CancellationToken)

HEAD request to the indices.exists_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
Task<ExistsResponse> ComposableTemplateExistsAsync(Name name, Func<ComposableIndexTemplateExistsDescriptor, IComposableIndexTemplateExistsRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Name name
Func<ComposableIndexTemplateExistsDescriptor, IComposableIndexTemplateExistsRequest> selector
CancellationToken ct
Returns
Type Description
Task<ExistsResponse>
| Edit this page View Source

Create(ICreateIndexRequest)

PUT request to the indices.create API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/create-index/
Declaration
CreateIndexResponse Create(ICreateIndexRequest request)
Parameters
Type Name Description
ICreateIndexRequest request
Returns
Type Description
CreateIndexResponse
| Edit this page View Source

Create(IndexName, Func<CreateIndexDescriptor, ICreateIndexRequest>)

PUT request to the indices.create API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/create-index/
Declaration
CreateIndexResponse Create(IndexName index, Func<CreateIndexDescriptor, ICreateIndexRequest> selector = null)
Parameters
Type Name Description
IndexName index
Func<CreateIndexDescriptor, ICreateIndexRequest> selector
Returns
Type Description
CreateIndexResponse
| Edit this page View Source

CreateAsync(ICreateIndexRequest, CancellationToken)

PUT request to the indices.create API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/create-index/
Declaration
Task<CreateIndexResponse> CreateAsync(ICreateIndexRequest request, CancellationToken ct = default)
Parameters
Type Name Description
ICreateIndexRequest request
CancellationToken ct
Returns
Type Description
Task<CreateIndexResponse>
| Edit this page View Source

CreateAsync(IndexName, Func<CreateIndexDescriptor, ICreateIndexRequest>, CancellationToken)

PUT request to the indices.create API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/create-index/
Declaration
Task<CreateIndexResponse> CreateAsync(IndexName index, Func<CreateIndexDescriptor, ICreateIndexRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
IndexName index
Func<CreateIndexDescriptor, ICreateIndexRequest> selector
CancellationToken ct
Returns
Type Description
Task<CreateIndexResponse>
| Edit this page View Source

Delete(IDeleteIndexRequest)

DELETE request to the indices.delete API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/
Declaration
DeleteIndexResponse Delete(IDeleteIndexRequest request)
Parameters
Type Name Description
IDeleteIndexRequest request
Returns
Type Description
DeleteIndexResponse
| Edit this page View Source

Delete(Indices, Func<DeleteIndexDescriptor, IDeleteIndexRequest>)

DELETE request to the indices.delete API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/
Declaration
DeleteIndexResponse Delete(Indices index, Func<DeleteIndexDescriptor, IDeleteIndexRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<DeleteIndexDescriptor, IDeleteIndexRequest> selector
Returns
Type Description
DeleteIndexResponse
| Edit this page View Source

DeleteAlias(IDeleteAliasRequest)

DELETE request to the indices.delete_alias API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases
Declaration
DeleteAliasResponse DeleteAlias(IDeleteAliasRequest request)
Parameters
Type Name Description
IDeleteAliasRequest request
Returns
Type Description
DeleteAliasResponse
| Edit this page View Source

DeleteAlias(Indices, Names, Func<DeleteAliasDescriptor, IDeleteAliasRequest>)

DELETE request to the indices.delete_alias API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases
Declaration
DeleteAliasResponse DeleteAlias(Indices index, Names name, Func<DeleteAliasDescriptor, IDeleteAliasRequest> selector = null)
Parameters
Type Name Description
Indices index
Names name
Func<DeleteAliasDescriptor, IDeleteAliasRequest> selector
Returns
Type Description
DeleteAliasResponse
| Edit this page View Source

DeleteAliasAsync(IDeleteAliasRequest, CancellationToken)

DELETE request to the indices.delete_alias API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases
Declaration
Task<DeleteAliasResponse> DeleteAliasAsync(IDeleteAliasRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IDeleteAliasRequest request
CancellationToken ct
Returns
Type Description
Task<DeleteAliasResponse>
| Edit this page View Source

DeleteAliasAsync(Indices, Names, Func<DeleteAliasDescriptor, IDeleteAliasRequest>, CancellationToken)

DELETE request to the indices.delete_alias API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases
Declaration
Task<DeleteAliasResponse> DeleteAliasAsync(Indices index, Names name, Func<DeleteAliasDescriptor, IDeleteAliasRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Names name
Func<DeleteAliasDescriptor, IDeleteAliasRequest> selector
CancellationToken ct
Returns
Type Description
Task<DeleteAliasResponse>
| Edit this page View Source

DeleteAsync(IDeleteIndexRequest, CancellationToken)

DELETE request to the indices.delete API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/
Declaration
Task<DeleteIndexResponse> DeleteAsync(IDeleteIndexRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IDeleteIndexRequest request
CancellationToken ct
Returns
Type Description
Task<DeleteIndexResponse>
| Edit this page View Source

DeleteAsync(Indices, Func<DeleteIndexDescriptor, IDeleteIndexRequest>, CancellationToken)

DELETE request to the indices.delete API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/
Declaration
Task<DeleteIndexResponse> DeleteAsync(Indices index, Func<DeleteIndexDescriptor, IDeleteIndexRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<DeleteIndexDescriptor, IDeleteIndexRequest> selector
CancellationToken ct
Returns
Type Description
Task<DeleteIndexResponse>
| Edit this page View Source

DeleteComposableTemplate(IDeleteComposableIndexTemplateRequest)

DELETE request to the indices.delete_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template
Declaration
DeleteComposableIndexTemplateResponse DeleteComposableTemplate(IDeleteComposableIndexTemplateRequest request)
Parameters
Type Name Description
IDeleteComposableIndexTemplateRequest request
Returns
Type Description
DeleteComposableIndexTemplateResponse
| Edit this page View Source

DeleteComposableTemplate(Name, Func<DeleteComposableIndexTemplateDescriptor, IDeleteComposableIndexTemplateRequest>)

DELETE request to the indices.delete_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template
Declaration
DeleteComposableIndexTemplateResponse DeleteComposableTemplate(Name name, Func<DeleteComposableIndexTemplateDescriptor, IDeleteComposableIndexTemplateRequest> selector = null)
Parameters
Type Name Description
Name name
Func<DeleteComposableIndexTemplateDescriptor, IDeleteComposableIndexTemplateRequest> selector
Returns
Type Description
DeleteComposableIndexTemplateResponse
| Edit this page View Source

DeleteComposableTemplateAsync(IDeleteComposableIndexTemplateRequest, CancellationToken)

DELETE request to the indices.delete_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template
Declaration
Task<DeleteComposableIndexTemplateResponse> DeleteComposableTemplateAsync(IDeleteComposableIndexTemplateRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IDeleteComposableIndexTemplateRequest request
CancellationToken ct
Returns
Type Description
Task<DeleteComposableIndexTemplateResponse>
| Edit this page View Source

DeleteComposableTemplateAsync(Name, Func<DeleteComposableIndexTemplateDescriptor, IDeleteComposableIndexTemplateRequest>, CancellationToken)

DELETE request to the indices.delete_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template
Declaration
Task<DeleteComposableIndexTemplateResponse> DeleteComposableTemplateAsync(Name name, Func<DeleteComposableIndexTemplateDescriptor, IDeleteComposableIndexTemplateRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Name name
Func<DeleteComposableIndexTemplateDescriptor, IDeleteComposableIndexTemplateRequest> selector
CancellationToken ct
Returns
Type Description
Task<DeleteComposableIndexTemplateResponse>
| Edit this page View Source

DeleteTemplate(IDeleteIndexTemplateRequest)

DELETE request to the indices.delete_template API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
DeleteIndexTemplateResponse DeleteTemplate(IDeleteIndexTemplateRequest request)
Parameters
Type Name Description
IDeleteIndexTemplateRequest request
Returns
Type Description
DeleteIndexTemplateResponse
| Edit this page View Source

DeleteTemplate(Name, Func<DeleteIndexTemplateDescriptor, IDeleteIndexTemplateRequest>)

DELETE request to the indices.delete_template API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
DeleteIndexTemplateResponse DeleteTemplate(Name name, Func<DeleteIndexTemplateDescriptor, IDeleteIndexTemplateRequest> selector = null)
Parameters
Type Name Description
Name name
Func<DeleteIndexTemplateDescriptor, IDeleteIndexTemplateRequest> selector
Returns
Type Description
DeleteIndexTemplateResponse
| Edit this page View Source

DeleteTemplateAsync(IDeleteIndexTemplateRequest, CancellationToken)

DELETE request to the indices.delete_template API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<DeleteIndexTemplateResponse> DeleteTemplateAsync(IDeleteIndexTemplateRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IDeleteIndexTemplateRequest request
CancellationToken ct
Returns
Type Description
Task<DeleteIndexTemplateResponse>
| Edit this page View Source

DeleteTemplateAsync(Name, Func<DeleteIndexTemplateDescriptor, IDeleteIndexTemplateRequest>, CancellationToken)

DELETE request to the indices.delete_template API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<DeleteIndexTemplateResponse> DeleteTemplateAsync(Name name, Func<DeleteIndexTemplateDescriptor, IDeleteIndexTemplateRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Name name
Func<DeleteIndexTemplateDescriptor, IDeleteIndexTemplateRequest> selector
CancellationToken ct
Returns
Type Description
Task<DeleteIndexTemplateResponse>
| Edit this page View Source

Exists(IIndexExistsRequest)

HEAD request to the indices.exists API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/exists/
Declaration
ExistsResponse Exists(IIndexExistsRequest request)
Parameters
Type Name Description
IIndexExistsRequest request
Returns
Type Description
ExistsResponse
| Edit this page View Source

Exists(Indices, Func<IndexExistsDescriptor, IIndexExistsRequest>)

HEAD request to the indices.exists API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/exists/
Declaration
ExistsResponse Exists(Indices index, Func<IndexExistsDescriptor, IIndexExistsRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<IndexExistsDescriptor, IIndexExistsRequest> selector
Returns
Type Description
ExistsResponse
| Edit this page View Source

ExistsAsync(IIndexExistsRequest, CancellationToken)

HEAD request to the indices.exists API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/exists/
Declaration
Task<ExistsResponse> ExistsAsync(IIndexExistsRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IIndexExistsRequest request
CancellationToken ct
Returns
Type Description
Task<ExistsResponse>
| Edit this page View Source

ExistsAsync(Indices, Func<IndexExistsDescriptor, IIndexExistsRequest>, CancellationToken)

HEAD request to the indices.exists API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/exists/
Declaration
Task<ExistsResponse> ExistsAsync(Indices index, Func<IndexExistsDescriptor, IIndexExistsRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<IndexExistsDescriptor, IIndexExistsRequest> selector
CancellationToken ct
Returns
Type Description
Task<ExistsResponse>
| Edit this page View Source

Flush(IFlushRequest)

POST request to the indices.flush API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
FlushResponse Flush(IFlushRequest request)
Parameters
Type Name Description
IFlushRequest request
Returns
Type Description
FlushResponse
| Edit this page View Source

Flush(Indices, Func<FlushDescriptor, IFlushRequest>)

POST request to the indices.flush API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
FlushResponse Flush(Indices index = null, Func<FlushDescriptor, IFlushRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<FlushDescriptor, IFlushRequest> selector
Returns
Type Description
FlushResponse
| Edit this page View Source

FlushAsync(IFlushRequest, CancellationToken)

POST request to the indices.flush API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<FlushResponse> FlushAsync(IFlushRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IFlushRequest request
CancellationToken ct
Returns
Type Description
Task<FlushResponse>
| Edit this page View Source

FlushAsync(Indices, Func<FlushDescriptor, IFlushRequest>, CancellationToken)

POST request to the indices.flush API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<FlushResponse> FlushAsync(Indices index = null, Func<FlushDescriptor, IFlushRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<FlushDescriptor, IFlushRequest> selector
CancellationToken ct
Returns
Type Description
Task<FlushResponse>
| Edit this page View Source

ForceMerge(IForceMergeRequest)

POST request to the indices.forcemerge API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
ForceMergeResponse ForceMerge(IForceMergeRequest request)
Parameters
Type Name Description
IForceMergeRequest request
Returns
Type Description
ForceMergeResponse
| Edit this page View Source

ForceMerge(Indices, Func<ForceMergeDescriptor, IForceMergeRequest>)

POST request to the indices.forcemerge API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
ForceMergeResponse ForceMerge(Indices index = null, Func<ForceMergeDescriptor, IForceMergeRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<ForceMergeDescriptor, IForceMergeRequest> selector
Returns
Type Description
ForceMergeResponse
| Edit this page View Source

ForceMergeAsync(IForceMergeRequest, CancellationToken)

POST request to the indices.forcemerge API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<ForceMergeResponse> ForceMergeAsync(IForceMergeRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IForceMergeRequest request
CancellationToken ct
Returns
Type Description
Task<ForceMergeResponse>
| Edit this page View Source

ForceMergeAsync(Indices, Func<ForceMergeDescriptor, IForceMergeRequest>, CancellationToken)

POST request to the indices.forcemerge API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<ForceMergeResponse> ForceMergeAsync(Indices index = null, Func<ForceMergeDescriptor, IForceMergeRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<ForceMergeDescriptor, IForceMergeRequest> selector
CancellationToken ct
Returns
Type Description
Task<ForceMergeResponse>
| Edit this page View Source

Get(IGetIndexRequest)

GET request to the indices.get API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/get-index/
Declaration
GetIndexResponse Get(IGetIndexRequest request)
Parameters
Type Name Description
IGetIndexRequest request
Returns
Type Description
GetIndexResponse
| Edit this page View Source

Get(Indices, Func<GetIndexDescriptor, IGetIndexRequest>)

GET request to the indices.get API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/get-index/
Declaration
GetIndexResponse Get(Indices index, Func<GetIndexDescriptor, IGetIndexRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<GetIndexDescriptor, IGetIndexRequest> selector
Returns
Type Description
GetIndexResponse
| Edit this page View Source

GetAlias(IGetAliasRequest)

GET request to the indices.get_alias API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-alias/
Declaration
GetAliasResponse GetAlias(IGetAliasRequest request)
Parameters
Type Name Description
IGetAliasRequest request
Returns
Type Description
GetAliasResponse
| Edit this page View Source

GetAlias(Indices, Func<GetAliasDescriptor, IGetAliasRequest>)

GET request to the indices.get_alias API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-alias/
Declaration
GetAliasResponse GetAlias(Indices index = null, Func<GetAliasDescriptor, IGetAliasRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<GetAliasDescriptor, IGetAliasRequest> selector
Returns
Type Description
GetAliasResponse
| Edit this page View Source

GetAliasAsync(IGetAliasRequest, CancellationToken)

GET request to the indices.get_alias API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-alias/
Declaration
Task<GetAliasResponse> GetAliasAsync(IGetAliasRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IGetAliasRequest request
CancellationToken ct
Returns
Type Description
Task<GetAliasResponse>
| Edit this page View Source

GetAliasAsync(Indices, Func<GetAliasDescriptor, IGetAliasRequest>, CancellationToken)

GET request to the indices.get_alias API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-alias/
Declaration
Task<GetAliasResponse> GetAliasAsync(Indices index = null, Func<GetAliasDescriptor, IGetAliasRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<GetAliasDescriptor, IGetAliasRequest> selector
CancellationToken ct
Returns
Type Description
Task<GetAliasResponse>
| Edit this page View Source

GetAsync(IGetIndexRequest, CancellationToken)

GET request to the indices.get API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/get-index/
Declaration
Task<GetIndexResponse> GetAsync(IGetIndexRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IGetIndexRequest request
CancellationToken ct
Returns
Type Description
Task<GetIndexResponse>
| Edit this page View Source

GetAsync(Indices, Func<GetIndexDescriptor, IGetIndexRequest>, CancellationToken)

GET request to the indices.get API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/get-index/
Declaration
Task<GetIndexResponse> GetAsync(Indices index, Func<GetIndexDescriptor, IGetIndexRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<GetIndexDescriptor, IGetIndexRequest> selector
CancellationToken ct
Returns
Type Description
Task<GetIndexResponse>
| Edit this page View Source

GetComposableTemplate(IGetComposableIndexTemplateRequest)

GET request to the indices.get_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
GetComposableIndexTemplateResponse GetComposableTemplate(IGetComposableIndexTemplateRequest request)
Parameters
Type Name Description
IGetComposableIndexTemplateRequest request
Returns
Type Description
GetComposableIndexTemplateResponse
| Edit this page View Source

GetComposableTemplate(Name, Func<GetComposableIndexTemplateDescriptor, IGetComposableIndexTemplateRequest>)

GET request to the indices.get_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
GetComposableIndexTemplateResponse GetComposableTemplate(Name name = null, Func<GetComposableIndexTemplateDescriptor, IGetComposableIndexTemplateRequest> selector = null)
Parameters
Type Name Description
Name name
Func<GetComposableIndexTemplateDescriptor, IGetComposableIndexTemplateRequest> selector
Returns
Type Description
GetComposableIndexTemplateResponse
| Edit this page View Source

GetComposableTemplateAsync(IGetComposableIndexTemplateRequest, CancellationToken)

GET request to the indices.get_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
Task<GetComposableIndexTemplateResponse> GetComposableTemplateAsync(IGetComposableIndexTemplateRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IGetComposableIndexTemplateRequest request
CancellationToken ct
Returns
Type Description
Task<GetComposableIndexTemplateResponse>
| Edit this page View Source

GetComposableTemplateAsync(Name, Func<GetComposableIndexTemplateDescriptor, IGetComposableIndexTemplateRequest>, CancellationToken)

GET request to the indices.get_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
Task<GetComposableIndexTemplateResponse> GetComposableTemplateAsync(Name name = null, Func<GetComposableIndexTemplateDescriptor, IGetComposableIndexTemplateRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Name name
Func<GetComposableIndexTemplateDescriptor, IGetComposableIndexTemplateRequest> selector
CancellationToken ct
Returns
Type Description
Task<GetComposableIndexTemplateResponse>
| Edit this page View Source

GetFieldMapping(IGetFieldMappingRequest)

GET request to the indices.get_field_mapping API, read more about this API online:

https://opensearch.org/docs/latest/field-types/index/
Declaration
GetFieldMappingResponse GetFieldMapping(IGetFieldMappingRequest request)
Parameters
Type Name Description
IGetFieldMappingRequest request
Returns
Type Description
GetFieldMappingResponse
| Edit this page View Source

GetFieldMappingAsync(IGetFieldMappingRequest, CancellationToken)

GET request to the indices.get_field_mapping API, read more about this API online:

https://opensearch.org/docs/latest/field-types/index/
Declaration
Task<GetFieldMappingResponse> GetFieldMappingAsync(IGetFieldMappingRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IGetFieldMappingRequest request
CancellationToken ct
Returns
Type Description
Task<GetFieldMappingResponse>
| Edit this page View Source

GetFieldMappingAsync<TDocument>(Fields, Func<GetFieldMappingDescriptor<TDocument>, IGetFieldMappingRequest>, CancellationToken)

GET request to the indices.get_field_mapping API, read more about this API online:

https://opensearch.org/docs/latest/field-types/index/
Declaration
Task<GetFieldMappingResponse> GetFieldMappingAsync<TDocument>(Fields fields, Func<GetFieldMappingDescriptor<TDocument>, IGetFieldMappingRequest> selector = null, CancellationToken ct = default) where TDocument : class
Parameters
Type Name Description
Fields fields
Func<GetFieldMappingDescriptor<TDocument>, IGetFieldMappingRequest> selector
CancellationToken ct
Returns
Type Description
Task<GetFieldMappingResponse>
Type Parameters
Name Description
TDocument
| Edit this page View Source

GetFieldMapping<TDocument>(Fields, Func<GetFieldMappingDescriptor<TDocument>, IGetFieldMappingRequest>)

GET request to the indices.get_field_mapping API, read more about this API online:

https://opensearch.org/docs/latest/field-types/index/
Declaration
GetFieldMappingResponse GetFieldMapping<TDocument>(Fields fields, Func<GetFieldMappingDescriptor<TDocument>, IGetFieldMappingRequest> selector = null) where TDocument : class
Parameters
Type Name Description
Fields fields
Func<GetFieldMappingDescriptor<TDocument>, IGetFieldMappingRequest> selector
Returns
Type Description
GetFieldMappingResponse
Type Parameters
Name Description
TDocument
| Edit this page View Source

GetMapping(IGetMappingRequest)

GET request to the indices.get_mapping API, read more about this API online:

https://opensearch.org/docs/latest/field-types/index/#get-a-mapping
Declaration
GetMappingResponse GetMapping(IGetMappingRequest request)
Parameters
Type Name Description
IGetMappingRequest request
Returns
Type Description
GetMappingResponse
| Edit this page View Source

GetMappingAsync(IGetMappingRequest, CancellationToken)

GET request to the indices.get_mapping API, read more about this API online:

https://opensearch.org/docs/latest/field-types/index/#get-a-mapping
Declaration
Task<GetMappingResponse> GetMappingAsync(IGetMappingRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IGetMappingRequest request
CancellationToken ct
Returns
Type Description
Task<GetMappingResponse>
| Edit this page View Source

GetMappingAsync<TDocument>(Func<GetMappingDescriptor<TDocument>, IGetMappingRequest>, CancellationToken)

GET request to the indices.get_mapping API, read more about this API online:

https://opensearch.org/docs/latest/field-types/index/#get-a-mapping
Declaration
Task<GetMappingResponse> GetMappingAsync<TDocument>(Func<GetMappingDescriptor<TDocument>, IGetMappingRequest> selector = null, CancellationToken ct = default) where TDocument : class
Parameters
Type Name Description
Func<GetMappingDescriptor<TDocument>, IGetMappingRequest> selector
CancellationToken ct
Returns
Type Description
Task<GetMappingResponse>
Type Parameters
Name Description
TDocument
| Edit this page View Source

GetMapping<TDocument>(Func<GetMappingDescriptor<TDocument>, IGetMappingRequest>)

GET request to the indices.get_mapping API, read more about this API online:

https://opensearch.org/docs/latest/field-types/index/#get-a-mapping
Declaration
GetMappingResponse GetMapping<TDocument>(Func<GetMappingDescriptor<TDocument>, IGetMappingRequest> selector = null) where TDocument : class
Parameters
Type Name Description
Func<GetMappingDescriptor<TDocument>, IGetMappingRequest> selector
Returns
Type Description
GetMappingResponse
Type Parameters
Name Description
TDocument
| Edit this page View Source

GetSettings(IGetIndexSettingsRequest)

GET request to the indices.get_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/
Declaration
GetIndexSettingsResponse GetSettings(IGetIndexSettingsRequest request)
Parameters
Type Name Description
IGetIndexSettingsRequest request
Returns
Type Description
GetIndexSettingsResponse
| Edit this page View Source

GetSettings(Indices, Func<GetIndexSettingsDescriptor, IGetIndexSettingsRequest>)

GET request to the indices.get_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/
Declaration
GetIndexSettingsResponse GetSettings(Indices index = null, Func<GetIndexSettingsDescriptor, IGetIndexSettingsRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<GetIndexSettingsDescriptor, IGetIndexSettingsRequest> selector
Returns
Type Description
GetIndexSettingsResponse
| Edit this page View Source

GetSettingsAsync(IGetIndexSettingsRequest, CancellationToken)

GET request to the indices.get_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/
Declaration
Task<GetIndexSettingsResponse> GetSettingsAsync(IGetIndexSettingsRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IGetIndexSettingsRequest request
CancellationToken ct
Returns
Type Description
Task<GetIndexSettingsResponse>
| Edit this page View Source

GetSettingsAsync(Indices, Func<GetIndexSettingsDescriptor, IGetIndexSettingsRequest>, CancellationToken)

GET request to the indices.get_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/
Declaration
Task<GetIndexSettingsResponse> GetSettingsAsync(Indices index = null, Func<GetIndexSettingsDescriptor, IGetIndexSettingsRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<GetIndexSettingsDescriptor, IGetIndexSettingsRequest> selector
CancellationToken ct
Returns
Type Description
Task<GetIndexSettingsResponse>
| Edit this page View Source

GetTemplate(IGetIndexTemplateRequest)

GET request to the indices.get_template API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
GetIndexTemplateResponse GetTemplate(IGetIndexTemplateRequest request)
Parameters
Type Name Description
IGetIndexTemplateRequest request
Returns
Type Description
GetIndexTemplateResponse
| Edit this page View Source

GetTemplate(Names, Func<GetIndexTemplateDescriptor, IGetIndexTemplateRequest>)

GET request to the indices.get_template API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
GetIndexTemplateResponse GetTemplate(Names name = null, Func<GetIndexTemplateDescriptor, IGetIndexTemplateRequest> selector = null)
Parameters
Type Name Description
Names name
Func<GetIndexTemplateDescriptor, IGetIndexTemplateRequest> selector
Returns
Type Description
GetIndexTemplateResponse
| Edit this page View Source

GetTemplateAsync(IGetIndexTemplateRequest, CancellationToken)

GET request to the indices.get_template API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<GetIndexTemplateResponse> GetTemplateAsync(IGetIndexTemplateRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IGetIndexTemplateRequest request
CancellationToken ct
Returns
Type Description
Task<GetIndexTemplateResponse>
| Edit this page View Source

GetTemplateAsync(Names, Func<GetIndexTemplateDescriptor, IGetIndexTemplateRequest>, CancellationToken)

GET request to the indices.get_template API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<GetIndexTemplateResponse> GetTemplateAsync(Names name = null, Func<GetIndexTemplateDescriptor, IGetIndexTemplateRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Names name
Func<GetIndexTemplateDescriptor, IGetIndexTemplateRequest> selector
CancellationToken ct
Returns
Type Description
Task<GetIndexTemplateResponse>
| Edit this page View Source

Open(IOpenIndexRequest)

POST request to the indices.open API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/open-index/
Declaration
OpenIndexResponse Open(IOpenIndexRequest request)
Parameters
Type Name Description
IOpenIndexRequest request
Returns
Type Description
OpenIndexResponse
| Edit this page View Source

Open(Indices, Func<OpenIndexDescriptor, IOpenIndexRequest>)

POST request to the indices.open API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/open-index/
Declaration
OpenIndexResponse Open(Indices index, Func<OpenIndexDescriptor, IOpenIndexRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<OpenIndexDescriptor, IOpenIndexRequest> selector
Returns
Type Description
OpenIndexResponse
| Edit this page View Source

OpenAsync(IOpenIndexRequest, CancellationToken)

POST request to the indices.open API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/open-index/
Declaration
Task<OpenIndexResponse> OpenAsync(IOpenIndexRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IOpenIndexRequest request
CancellationToken ct
Returns
Type Description
Task<OpenIndexResponse>
| Edit this page View Source

OpenAsync(Indices, Func<OpenIndexDescriptor, IOpenIndexRequest>, CancellationToken)

POST request to the indices.open API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/open-index/
Declaration
Task<OpenIndexResponse> OpenAsync(Indices index, Func<OpenIndexDescriptor, IOpenIndexRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<OpenIndexDescriptor, IOpenIndexRequest> selector
CancellationToken ct
Returns
Type Description
Task<OpenIndexResponse>
| Edit this page View Source

PutAlias(IPutAliasRequest)

PUT request to the indices.put_alias API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/
Declaration
PutAliasResponse PutAlias(IPutAliasRequest request)
Parameters
Type Name Description
IPutAliasRequest request
Returns
Type Description
PutAliasResponse
| Edit this page View Source

PutAlias(Indices, Name, Func<PutAliasDescriptor, IPutAliasRequest>)

PUT request to the indices.put_alias API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/alias/
Declaration
PutAliasResponse PutAlias(Indices index, Name name, Func<PutAliasDescriptor, IPutAliasRequest> selector = null)
Parameters
Type Name Description
Indices index
Name name
Func<PutAliasDescriptor, IPutAliasRequest> selector
Returns
Type Description
PutAliasResponse
| Edit this page View Source

PutAlias(Indices, Func<PutAliasDescriptor, IPutAliasRequest>)

PUT request to the indices.put_alias API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/
Declaration
PutAliasResponse PutAlias(Indices index = null, Func<PutAliasDescriptor, IPutAliasRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<PutAliasDescriptor, IPutAliasRequest> selector
Returns
Type Description
PutAliasResponse
| Edit this page View Source

PutAliasAsync(IPutAliasRequest, CancellationToken)

PUT request to the indices.put_alias API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/
Declaration
Task<PutAliasResponse> PutAliasAsync(IPutAliasRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IPutAliasRequest request
CancellationToken ct
Returns
Type Description
Task<PutAliasResponse>
| Edit this page View Source

PutAliasAsync(Indices, Name, Func<PutAliasDescriptor, IPutAliasRequest>, CancellationToken)

PUT request to the indices.put_alias API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/alias/
Declaration
Task<PutAliasResponse> PutAliasAsync(Indices index, Name name, Func<PutAliasDescriptor, IPutAliasRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Name name
Func<PutAliasDescriptor, IPutAliasRequest> selector
CancellationToken ct
Returns
Type Description
Task<PutAliasResponse>
| Edit this page View Source

PutAliasAsync(Indices, Func<PutAliasDescriptor, IPutAliasRequest>, CancellationToken)

PUT request to the indices.put_alias API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/
Declaration
Task<PutAliasResponse> PutAliasAsync(Indices index = null, Func<PutAliasDescriptor, IPutAliasRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<PutAliasDescriptor, IPutAliasRequest> selector
CancellationToken ct
Returns
Type Description
Task<PutAliasResponse>
| Edit this page View Source

PutComposableTemplate(IPutComposableIndexTemplateRequest)

PUT request to the indices.put_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
PutComposableIndexTemplateResponse PutComposableTemplate(IPutComposableIndexTemplateRequest request)
Parameters
Type Name Description
IPutComposableIndexTemplateRequest request
Returns
Type Description
PutComposableIndexTemplateResponse
| Edit this page View Source

PutComposableTemplate(Name, Func<PutComposableIndexTemplateDescriptor, IPutComposableIndexTemplateRequest>)

PUT request to the indices.put_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
PutComposableIndexTemplateResponse PutComposableTemplate(Name name, Func<PutComposableIndexTemplateDescriptor, IPutComposableIndexTemplateRequest> selector)
Parameters
Type Name Description
Name name
Func<PutComposableIndexTemplateDescriptor, IPutComposableIndexTemplateRequest> selector
Returns
Type Description
PutComposableIndexTemplateResponse
| Edit this page View Source

PutComposableTemplateAsync(IPutComposableIndexTemplateRequest, CancellationToken)

PUT request to the indices.put_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
Task<PutComposableIndexTemplateResponse> PutComposableTemplateAsync(IPutComposableIndexTemplateRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IPutComposableIndexTemplateRequest request
CancellationToken ct
Returns
Type Description
Task<PutComposableIndexTemplateResponse>
| Edit this page View Source

PutComposableTemplateAsync(Name, Func<PutComposableIndexTemplateDescriptor, IPutComposableIndexTemplateRequest>, CancellationToken)

PUT request to the indices.put_index_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
Task<PutComposableIndexTemplateResponse> PutComposableTemplateAsync(Name name, Func<PutComposableIndexTemplateDescriptor, IPutComposableIndexTemplateRequest> selector, CancellationToken ct = default)
Parameters
Type Name Description
Name name
Func<PutComposableIndexTemplateDescriptor, IPutComposableIndexTemplateRequest> selector
CancellationToken ct
Returns
Type Description
Task<PutComposableIndexTemplateResponse>
| Edit this page View Source

PutMapping(IPutMappingRequest)

PUT request to the indices.put_mapping API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/
Declaration
PutMappingResponse PutMapping(IPutMappingRequest request)
Parameters
Type Name Description
IPutMappingRequest request
Returns
Type Description
PutMappingResponse
| Edit this page View Source

PutMappingAsync(IPutMappingRequest, CancellationToken)

PUT request to the indices.put_mapping API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/
Declaration
Task<PutMappingResponse> PutMappingAsync(IPutMappingRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IPutMappingRequest request
CancellationToken ct
Returns
Type Description
Task<PutMappingResponse>
| Edit this page View Source

PutMappingAsync<TDocument>(Func<PutMappingDescriptor<TDocument>, IPutMappingRequest>, CancellationToken)

PUT request to the indices.put_mapping API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/
Declaration
Task<PutMappingResponse> PutMappingAsync<TDocument>(Func<PutMappingDescriptor<TDocument>, IPutMappingRequest> selector, CancellationToken ct = default) where TDocument : class
Parameters
Type Name Description
Func<PutMappingDescriptor<TDocument>, IPutMappingRequest> selector
CancellationToken ct
Returns
Type Description
Task<PutMappingResponse>
Type Parameters
Name Description
TDocument
| Edit this page View Source

PutMapping<TDocument>(Func<PutMappingDescriptor<TDocument>, IPutMappingRequest>)

PUT request to the indices.put_mapping API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/
Declaration
PutMappingResponse PutMapping<TDocument>(Func<PutMappingDescriptor<TDocument>, IPutMappingRequest> selector) where TDocument : class
Parameters
Type Name Description
Func<PutMappingDescriptor<TDocument>, IPutMappingRequest> selector
Returns
Type Description
PutMappingResponse
Type Parameters
Name Description
TDocument
| Edit this page View Source

PutTemplate(IPutIndexTemplateRequest)

PUT request to the indices.put_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
PutIndexTemplateResponse PutTemplate(IPutIndexTemplateRequest request)
Parameters
Type Name Description
IPutIndexTemplateRequest request
Returns
Type Description
PutIndexTemplateResponse
| Edit this page View Source

PutTemplate(Name, Func<PutIndexTemplateDescriptor, IPutIndexTemplateRequest>)

PUT request to the indices.put_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
PutIndexTemplateResponse PutTemplate(Name name, Func<PutIndexTemplateDescriptor, IPutIndexTemplateRequest> selector)
Parameters
Type Name Description
Name name
Func<PutIndexTemplateDescriptor, IPutIndexTemplateRequest> selector
Returns
Type Description
PutIndexTemplateResponse
| Edit this page View Source

PutTemplateAsync(IPutIndexTemplateRequest, CancellationToken)

PUT request to the indices.put_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
Task<PutIndexTemplateResponse> PutTemplateAsync(IPutIndexTemplateRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IPutIndexTemplateRequest request
CancellationToken ct
Returns
Type Description
Task<PutIndexTemplateResponse>
| Edit this page View Source

PutTemplateAsync(Name, Func<PutIndexTemplateDescriptor, IPutIndexTemplateRequest>, CancellationToken)

PUT request to the indices.put_template API, read more about this API online:

https://opensearch.org/docs/latest/im-plugin/index-templates/
Declaration
Task<PutIndexTemplateResponse> PutTemplateAsync(Name name, Func<PutIndexTemplateDescriptor, IPutIndexTemplateRequest> selector, CancellationToken ct = default)
Parameters
Type Name Description
Name name
Func<PutIndexTemplateDescriptor, IPutIndexTemplateRequest> selector
CancellationToken ct
Returns
Type Description
Task<PutIndexTemplateResponse>
| Edit this page View Source

Refresh(IRefreshRequest)

POST request to the indices.refresh API, read more about this API online:

https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability
Declaration
RefreshResponse Refresh(IRefreshRequest request)
Parameters
Type Name Description
IRefreshRequest request
Returns
Type Description
RefreshResponse
| Edit this page View Source

Refresh(Indices, Func<RefreshDescriptor, IRefreshRequest>)

POST request to the indices.refresh API, read more about this API online:

https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability
Declaration
RefreshResponse Refresh(Indices index = null, Func<RefreshDescriptor, IRefreshRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<RefreshDescriptor, IRefreshRequest> selector
Returns
Type Description
RefreshResponse
| Edit this page View Source

RefreshAsync(IRefreshRequest, CancellationToken)

POST request to the indices.refresh API, read more about this API online:

https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability
Declaration
Task<RefreshResponse> RefreshAsync(IRefreshRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IRefreshRequest request
CancellationToken ct
Returns
Type Description
Task<RefreshResponse>
| Edit this page View Source

RefreshAsync(Indices, Func<RefreshDescriptor, IRefreshRequest>, CancellationToken)

POST request to the indices.refresh API, read more about this API online:

https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability
Declaration
Task<RefreshResponse> RefreshAsync(Indices index = null, Func<RefreshDescriptor, IRefreshRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<RefreshDescriptor, IRefreshRequest> selector
CancellationToken ct
Returns
Type Description
Task<RefreshResponse>
| Edit this page View Source

Resolve(IResolveIndexRequest)

GET request to the indices.resolve_index API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
ResolveIndexResponse Resolve(IResolveIndexRequest request)
Parameters
Type Name Description
IResolveIndexRequest request
Returns
Type Description
ResolveIndexResponse
| Edit this page View Source

Resolve(Names, Func<ResolveIndexDescriptor, IResolveIndexRequest>)

GET request to the indices.resolve_index API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
ResolveIndexResponse Resolve(Names name, Func<ResolveIndexDescriptor, IResolveIndexRequest> selector = null)
Parameters
Type Name Description
Names name
Func<ResolveIndexDescriptor, IResolveIndexRequest> selector
Returns
Type Description
ResolveIndexResponse
| Edit this page View Source

ResolveAsync(IResolveIndexRequest, CancellationToken)

GET request to the indices.resolve_index API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<ResolveIndexResponse> ResolveAsync(IResolveIndexRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IResolveIndexRequest request
CancellationToken ct
Returns
Type Description
Task<ResolveIndexResponse>
| Edit this page View Source

ResolveAsync(Names, Func<ResolveIndexDescriptor, IResolveIndexRequest>, CancellationToken)

GET request to the indices.resolve_index API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<ResolveIndexResponse> ResolveAsync(Names name, Func<ResolveIndexDescriptor, IResolveIndexRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Names name
Func<ResolveIndexDescriptor, IResolveIndexRequest> selector
CancellationToken ct
Returns
Type Description
Task<ResolveIndexResponse>
| Edit this page View Source

Rollover(IRolloverIndexRequest)

POST request to the indices.rollover API, read more about this API online:

https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/
Declaration
RolloverIndexResponse Rollover(IRolloverIndexRequest request)
Parameters
Type Name Description
IRolloverIndexRequest request
Returns
Type Description
RolloverIndexResponse
| Edit this page View Source

Rollover(Name, Func<RolloverIndexDescriptor, IRolloverIndexRequest>)

POST request to the indices.rollover API, read more about this API online:

https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/
Declaration
RolloverIndexResponse Rollover(Name alias, Func<RolloverIndexDescriptor, IRolloverIndexRequest> selector = null)
Parameters
Type Name Description
Name alias
Func<RolloverIndexDescriptor, IRolloverIndexRequest> selector
Returns
Type Description
RolloverIndexResponse
| Edit this page View Source

RolloverAsync(IRolloverIndexRequest, CancellationToken)

POST request to the indices.rollover API, read more about this API online:

https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/
Declaration
Task<RolloverIndexResponse> RolloverAsync(IRolloverIndexRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IRolloverIndexRequest request
CancellationToken ct
Returns
Type Description
Task<RolloverIndexResponse>
| Edit this page View Source

RolloverAsync(Name, Func<RolloverIndexDescriptor, IRolloverIndexRequest>, CancellationToken)

POST request to the indices.rollover API, read more about this API online:

https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/
Declaration
Task<RolloverIndexResponse> RolloverAsync(Name alias, Func<RolloverIndexDescriptor, IRolloverIndexRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Name alias
Func<RolloverIndexDescriptor, IRolloverIndexRequest> selector
CancellationToken ct
Returns
Type Description
Task<RolloverIndexResponse>
| Edit this page View Source

Shrink(IShrinkIndexRequest)

PUT request to the indices.shrink API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/
Declaration
ShrinkIndexResponse Shrink(IShrinkIndexRequest request)
Parameters
Type Name Description
IShrinkIndexRequest request
Returns
Type Description
ShrinkIndexResponse
| Edit this page View Source

Shrink(IndexName, IndexName, Func<ShrinkIndexDescriptor, IShrinkIndexRequest>)

PUT request to the indices.shrink API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/
Declaration
ShrinkIndexResponse Shrink(IndexName index, IndexName target, Func<ShrinkIndexDescriptor, IShrinkIndexRequest> selector = null)
Parameters
Type Name Description
IndexName index
IndexName target
Func<ShrinkIndexDescriptor, IShrinkIndexRequest> selector
Returns
Type Description
ShrinkIndexResponse
| Edit this page View Source

ShrinkAsync(IShrinkIndexRequest, CancellationToken)

PUT request to the indices.shrink API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/
Declaration
Task<ShrinkIndexResponse> ShrinkAsync(IShrinkIndexRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IShrinkIndexRequest request
CancellationToken ct
Returns
Type Description
Task<ShrinkIndexResponse>
| Edit this page View Source

ShrinkAsync(IndexName, IndexName, Func<ShrinkIndexDescriptor, IShrinkIndexRequest>, CancellationToken)

PUT request to the indices.shrink API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/
Declaration
Task<ShrinkIndexResponse> ShrinkAsync(IndexName index, IndexName target, Func<ShrinkIndexDescriptor, IShrinkIndexRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
IndexName index
IndexName target
Func<ShrinkIndexDescriptor, IShrinkIndexRequest> selector
CancellationToken ct
Returns
Type Description
Task<ShrinkIndexResponse>
| Edit this page View Source

Split(ISplitIndexRequest)

PUT request to the indices.split API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/split/
Declaration
SplitIndexResponse Split(ISplitIndexRequest request)
Parameters
Type Name Description
ISplitIndexRequest request
Returns
Type Description
SplitIndexResponse
| Edit this page View Source

Split(IndexName, IndexName, Func<SplitIndexDescriptor, ISplitIndexRequest>)

PUT request to the indices.split API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/split/
Declaration
SplitIndexResponse Split(IndexName index, IndexName target, Func<SplitIndexDescriptor, ISplitIndexRequest> selector = null)
Parameters
Type Name Description
IndexName index
IndexName target
Func<SplitIndexDescriptor, ISplitIndexRequest> selector
Returns
Type Description
SplitIndexResponse
| Edit this page View Source

SplitAsync(ISplitIndexRequest, CancellationToken)

PUT request to the indices.split API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/split/
Declaration
Task<SplitIndexResponse> SplitAsync(ISplitIndexRequest request, CancellationToken ct = default)
Parameters
Type Name Description
ISplitIndexRequest request
CancellationToken ct
Returns
Type Description
Task<SplitIndexResponse>
| Edit this page View Source

SplitAsync(IndexName, IndexName, Func<SplitIndexDescriptor, ISplitIndexRequest>, CancellationToken)

PUT request to the indices.split API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/split/
Declaration
Task<SplitIndexResponse> SplitAsync(IndexName index, IndexName target, Func<SplitIndexDescriptor, ISplitIndexRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
IndexName index
IndexName target
Func<SplitIndexDescriptor, ISplitIndexRequest> selector
CancellationToken ct
Returns
Type Description
Task<SplitIndexResponse>
| Edit this page View Source

Stats(IIndicesStatsRequest)

GET request to the indices.stats API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
IndicesStatsResponse Stats(IIndicesStatsRequest request)
Parameters
Type Name Description
IIndicesStatsRequest request
Returns
Type Description
IndicesStatsResponse
| Edit this page View Source

Stats(Indices, Func<IndicesStatsDescriptor, IIndicesStatsRequest>)

GET request to the indices.stats API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
IndicesStatsResponse Stats(Indices index = null, Func<IndicesStatsDescriptor, IIndicesStatsRequest> selector = null)
Parameters
Type Name Description
Indices index
Func<IndicesStatsDescriptor, IIndicesStatsRequest> selector
Returns
Type Description
IndicesStatsResponse
| Edit this page View Source

StatsAsync(IIndicesStatsRequest, CancellationToken)

GET request to the indices.stats API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<IndicesStatsResponse> StatsAsync(IIndicesStatsRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IIndicesStatsRequest request
CancellationToken ct
Returns
Type Description
Task<IndicesStatsResponse>
| Edit this page View Source

StatsAsync(Indices, Func<IndicesStatsDescriptor, IIndicesStatsRequest>, CancellationToken)

GET request to the indices.stats API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<IndicesStatsResponse> StatsAsync(Indices index = null, Func<IndicesStatsDescriptor, IIndicesStatsRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<IndicesStatsDescriptor, IIndicesStatsRequest> selector
CancellationToken ct
Returns
Type Description
Task<IndicesStatsResponse>
| Edit this page View Source

TemplateExists(IIndexTemplateExistsRequest)

HEAD request to the indices.exists_template API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
ExistsResponse TemplateExists(IIndexTemplateExistsRequest request)
Parameters
Type Name Description
IIndexTemplateExistsRequest request
Returns
Type Description
ExistsResponse
| Edit this page View Source

TemplateExists(Names, Func<IndexTemplateExistsDescriptor, IIndexTemplateExistsRequest>)

HEAD request to the indices.exists_template API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
ExistsResponse TemplateExists(Names name, Func<IndexTemplateExistsDescriptor, IIndexTemplateExistsRequest> selector = null)
Parameters
Type Name Description
Names name
Func<IndexTemplateExistsDescriptor, IIndexTemplateExistsRequest> selector
Returns
Type Description
ExistsResponse
| Edit this page View Source

TemplateExistsAsync(IIndexTemplateExistsRequest, CancellationToken)

HEAD request to the indices.exists_template API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<ExistsResponse> TemplateExistsAsync(IIndexTemplateExistsRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IIndexTemplateExistsRequest request
CancellationToken ct
Returns
Type Description
Task<ExistsResponse>
| Edit this page View Source

TemplateExistsAsync(Names, Func<IndexTemplateExistsDescriptor, IIndexTemplateExistsRequest>, CancellationToken)

HEAD request to the indices.exists_template API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<ExistsResponse> TemplateExistsAsync(Names name, Func<IndexTemplateExistsDescriptor, IIndexTemplateExistsRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Names name
Func<IndexTemplateExistsDescriptor, IIndexTemplateExistsRequest> selector
CancellationToken ct
Returns
Type Description
Task<ExistsResponse>
| Edit this page View Source

TypeExists(ITypeExistsRequest)

HEAD request to the indices.exists_type API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/
Declaration
ExistsResponse TypeExists(ITypeExistsRequest request)
Parameters
Type Name Description
ITypeExistsRequest request
Returns
Type Description
ExistsResponse
Remarks

Deprecated as of OpenSearch 2.0

| Edit this page View Source

TypeExists(Indices, Names, Func<TypeExistsDescriptor, ITypeExistsRequest>)

HEAD request to the indices.exists_type API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/
Declaration
ExistsResponse TypeExists(Indices index, Names type, Func<TypeExistsDescriptor, ITypeExistsRequest> selector = null)
Parameters
Type Name Description
Indices index
Names type
Func<TypeExistsDescriptor, ITypeExistsRequest> selector
Returns
Type Description
ExistsResponse
Remarks

Deprecated as of OpenSearch 2.0

| Edit this page View Source

TypeExistsAsync(ITypeExistsRequest, CancellationToken)

HEAD request to the indices.exists_type API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/
Declaration
Task<ExistsResponse> TypeExistsAsync(ITypeExistsRequest request, CancellationToken ct = default)
Parameters
Type Name Description
ITypeExistsRequest request
CancellationToken ct
Returns
Type Description
Task<ExistsResponse>
Remarks

Deprecated as of OpenSearch 2.0

| Edit this page View Source

TypeExistsAsync(Indices, Names, Func<TypeExistsDescriptor, ITypeExistsRequest>, CancellationToken)

HEAD request to the indices.exists_type API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/exists/
Declaration
Task<ExistsResponse> TypeExistsAsync(Indices index, Names type, Func<TypeExistsDescriptor, ITypeExistsRequest> selector = null, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Names type
Func<TypeExistsDescriptor, ITypeExistsRequest> selector
CancellationToken ct
Returns
Type Description
Task<ExistsResponse>
Remarks

Deprecated as of OpenSearch 2.0

| Edit this page View Source

UpdateSettings(IUpdateIndexSettingsRequest)

PUT request to the indices.put_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/
Declaration
UpdateIndexSettingsResponse UpdateSettings(IUpdateIndexSettingsRequest request)
Parameters
Type Name Description
IUpdateIndexSettingsRequest request
Returns
Type Description
UpdateIndexSettingsResponse
| Edit this page View Source

UpdateSettings(Indices, Func<UpdateIndexSettingsDescriptor, IUpdateIndexSettingsRequest>)

PUT request to the indices.put_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/
Declaration
UpdateIndexSettingsResponse UpdateSettings(Indices index, Func<UpdateIndexSettingsDescriptor, IUpdateIndexSettingsRequest> selector)
Parameters
Type Name Description
Indices index
Func<UpdateIndexSettingsDescriptor, IUpdateIndexSettingsRequest> selector
Returns
Type Description
UpdateIndexSettingsResponse
| Edit this page View Source

UpdateSettingsAsync(IUpdateIndexSettingsRequest, CancellationToken)

PUT request to the indices.put_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/
Declaration
Task<UpdateIndexSettingsResponse> UpdateSettingsAsync(IUpdateIndexSettingsRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IUpdateIndexSettingsRequest request
CancellationToken ct
Returns
Type Description
Task<UpdateIndexSettingsResponse>
| Edit this page View Source

UpdateSettingsAsync(Indices, Func<UpdateIndexSettingsDescriptor, IUpdateIndexSettingsRequest>, CancellationToken)

PUT request to the indices.put_settings API, read more about this API online:

https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/
Declaration
Task<UpdateIndexSettingsResponse> UpdateSettingsAsync(Indices index, Func<UpdateIndexSettingsDescriptor, IUpdateIndexSettingsRequest> selector, CancellationToken ct = default)
Parameters
Type Name Description
Indices index
Func<UpdateIndexSettingsDescriptor, IUpdateIndexSettingsRequest> selector
CancellationToken ct
Returns
Type Description
Task<UpdateIndexSettingsResponse>
| Edit this page View Source

ValidateQuery(IValidateQueryRequest)

POST request to the indices.validate_query API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
ValidateQueryResponse ValidateQuery(IValidateQueryRequest request)
Parameters
Type Name Description
IValidateQueryRequest request
Returns
Type Description
ValidateQueryResponse
| Edit this page View Source

ValidateQueryAsync(IValidateQueryRequest, CancellationToken)

POST request to the indices.validate_query API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<ValidateQueryResponse> ValidateQueryAsync(IValidateQueryRequest request, CancellationToken ct = default)
Parameters
Type Name Description
IValidateQueryRequest request
CancellationToken ct
Returns
Type Description
Task<ValidateQueryResponse>
| Edit this page View Source

ValidateQueryAsync<TDocument>(Func<ValidateQueryDescriptor<TDocument>, IValidateQueryRequest>, CancellationToken)

POST request to the indices.validate_query API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
Task<ValidateQueryResponse> ValidateQueryAsync<TDocument>(Func<ValidateQueryDescriptor<TDocument>, IValidateQueryRequest> selector = null, CancellationToken ct = default) where TDocument : class
Parameters
Type Name Description
Func<ValidateQueryDescriptor<TDocument>, IValidateQueryRequest> selector
CancellationToken ct
Returns
Type Description
Task<ValidateQueryResponse>
Type Parameters
Name Description
TDocument
| Edit this page View Source

ValidateQuery<TDocument>(Func<ValidateQueryDescriptor<TDocument>, IValidateQueryRequest>)

POST request to the indices.validate_query API, read more about this API online:

https://opensearch.org/docs/latest
Declaration
ValidateQueryResponse ValidateQuery<TDocument>(Func<ValidateQueryDescriptor<TDocument>, IValidateQueryRequest> selector = null) where TDocument : class
Parameters
Type Name Description
Func<ValidateQueryDescriptor<TDocument>, IValidateQueryRequest> selector
Returns
Type Description
ValidateQueryResponse
Type Parameters
Name Description
TDocument

Extension Methods