OpenSearch.Client by OpenSearch and contributors

<PackageReference Include="OpenSearch.Client" Version="1.6.0" />

.NET API 3,588,216 bytes

 OpenSearchClient

public class OpenSearchClient : IOpenSearchClient
OpenSearchClient is a strongly typed client which exposes fully mapped OpenSearch endpoints
public CatNamespace Cat { get; }

Cat APIs

public ClusterNamespace Cluster { get; }

Cluster APIs

public IConnectionSettingsValues ConnectionSettings { get; }

public DanglingIndicesNamespace DanglingIndices { get; }

Dangling Indices APIs

public HttpNamespace Http { get; }

Http APIs

public IndicesNamespace Indices { get; }

Indices APIs

public Inferrer Infer { get; }

public IngestNamespace Ingest { get; }

Ingest APIs

public IOpenSearchLowLevelClient LowLevel { get; }

public NodesNamespace Nodes { get; }

Nodes APIs

public IOpenSearchSerializer RequestResponseSerializer { get; }

public SnapshotNamespace Snapshot { get; }

Snapshot APIs

public IOpenSearchSerializer SourceSerializer { get; }

public TasksNamespace Tasks { get; }

Tasks APIs

public OpenSearchClient()

public OpenSearchClient(Uri uri)

public OpenSearchClient(string cloudId, BasicAuthenticationCredentials credentials)

Sets up the client to communicate to OpenSearch Cloud using cloudId,

CloudConnectionPool documentation for more information on how to obtain your Cloud Id

If you want more control use the #ctor constructor and pass an instance of ConnectionSettings that takes cloudId in its constructor as well

public OpenSearchClient(string cloudId, ApiKeyAuthenticationCredentials credentials)

Sets up the client to communicate to OpenSearch Cloud using cloudId,

CloudConnectionPool documentation for more information on how to obtain your Cloud Id

If you want more control use the #ctor constructor and pass an instance of ConnectionSettings that takes cloudId in its constructor as well

public OpenSearchClient(IConnectionSettingsValues connectionSettings)

public OpenSearchClient(ITransport<IConnectionSettingsValues> transport)

public BulkResponse Bulk(Func<BulkDescriptor, IBulkRequest> selector)

POST request to the bulk API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/

public BulkResponse Bulk(IBulkRequest request)

POST request to the bulk API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/

public BulkAllObservable<T> BulkAll<T>(IEnumerable<T> documents, Func<BulkAllDescriptor<T>, IBulkAllRequest<T>> selector, CancellationToken cancellationToken = default)

public BulkAllObservable<T> BulkAll<T>(IBulkAllRequest<T> request, CancellationToken cancellationToken = default)

public Task<BulkResponse> BulkAsync(Func<BulkDescriptor, IBulkRequest> selector, CancellationToken ct = default)

POST request to the bulk API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/

public Task<BulkResponse> BulkAsync(IBulkRequest request, CancellationToken ct = default)

POST request to the bulk API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/

public ClearScrollResponse ClearScroll(Func<ClearScrollDescriptor, IClearScrollRequest> selector = null)

DELETE request to the clear_scroll API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/scroll/

public ClearScrollResponse ClearScroll(IClearScrollRequest request)

DELETE request to the clear_scroll API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/scroll/

public Task<ClearScrollResponse> ClearScrollAsync(Func<ClearScrollDescriptor, IClearScrollRequest> selector = null, CancellationToken ct = default)

DELETE request to the clear_scroll API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/scroll/

public Task<ClearScrollResponse> ClearScrollAsync(IClearScrollRequest request, CancellationToken ct = default)

DELETE request to the clear_scroll API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/scroll/

public CountResponse Count<TDocument>(Func<CountDescriptor<TDocument>, ICountRequest> selector = null)

POST request to the count API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/count/

public CountResponse Count(ICountRequest request)

POST request to the count API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/count/

public Task<CountResponse> CountAsync<TDocument>(Func<CountDescriptor<TDocument>, ICountRequest> selector = null, CancellationToken ct = default)

POST request to the count API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/count/

public Task<CountResponse> CountAsync(ICountRequest request, CancellationToken ct = default)

POST request to the count API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/count/

public CreateResponse Create<TDocument>(TDocument document, Func<CreateDescriptor<TDocument>, ICreateRequest<TDocument>> selector)

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

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

public CreateResponse Create<TDocument>(ICreateRequest<TDocument> request)

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

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

public Task<CreateResponse> CreateAsync<TDocument>(TDocument document, Func<CreateDescriptor<TDocument>, ICreateRequest<TDocument>> selector, CancellationToken ct = default)

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

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

public Task<CreateResponse> CreateAsync<TDocument>(ICreateRequest<TDocument> request, CancellationToken ct = default)

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

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

public CreateResponse CreateDocument<TDocument>(TDocument document)

public Task<CreateResponse> CreateDocumentAsync<TDocument>(TDocument document, CancellationToken cancellationToken = default)

public CreatePitResponse CreatePit(Indices index, Func<CreatePitDescriptor, ICreatePitRequest> selector = null)

POST request to the create_pit API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit

public CreatePitResponse CreatePit(ICreatePitRequest request)

POST request to the create_pit API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit

public Task<CreatePitResponse> CreatePitAsync(Indices index, Func<CreatePitDescriptor, ICreatePitRequest> selector = null, CancellationToken ct = default)

POST request to the create_pit API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit

public Task<CreatePitResponse> CreatePitAsync(ICreatePitRequest request, CancellationToken ct = default)

POST request to the create_pit API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit

public DeleteResponse Delete<TDocument>(DocumentPath<TDocument> id, Func<DeleteDescriptor<TDocument>, IDeleteRequest> selector = null)

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

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-document/

public DeleteResponse Delete(IDeleteRequest request)

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

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-document/

public DeleteAllPitsResponse DeleteAllPits(Func<DeleteAllPitsDescriptor, IDeleteAllPitsRequest> selector = null)

DELETE request to the delete_all_pits API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits

public DeleteAllPitsResponse DeleteAllPits(IDeleteAllPitsRequest request)

DELETE request to the delete_all_pits API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits

public Task<DeleteAllPitsResponse> DeleteAllPitsAsync(Func<DeleteAllPitsDescriptor, IDeleteAllPitsRequest> selector = null, CancellationToken ct = default)

DELETE request to the delete_all_pits API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits

public Task<DeleteAllPitsResponse> DeleteAllPitsAsync(IDeleteAllPitsRequest request, CancellationToken ct = default)

DELETE request to the delete_all_pits API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits

public Task<DeleteResponse> DeleteAsync<TDocument>(DocumentPath<TDocument> id, Func<DeleteDescriptor<TDocument>, IDeleteRequest> selector = null, CancellationToken ct = default)

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

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-document/

public Task<DeleteResponse> DeleteAsync(IDeleteRequest request, CancellationToken ct = default)

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

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-document/

public DeleteByQueryResponse DeleteByQuery<TDocument>(Func<DeleteByQueryDescriptor<TDocument>, IDeleteByQueryRequest> selector)

POST request to the delete_by_query API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/

public DeleteByQueryResponse DeleteByQuery(IDeleteByQueryRequest request)

POST request to the delete_by_query API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/

public Task<DeleteByQueryResponse> DeleteByQueryAsync<TDocument>(Func<DeleteByQueryDescriptor<TDocument>, IDeleteByQueryRequest> selector, CancellationToken ct = default)

POST request to the delete_by_query API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/

public Task<DeleteByQueryResponse> DeleteByQueryAsync(IDeleteByQueryRequest request, CancellationToken ct = default)

POST request to the delete_by_query API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/

public ListTasksResponse DeleteByQueryRethrottle(TaskId taskId, Func<DeleteByQueryRethrottleDescriptor, IDeleteByQueryRethrottleRequest> selector = null)

POST request to the delete_by_query_rethrottle API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/

public ListTasksResponse DeleteByQueryRethrottle(IDeleteByQueryRethrottleRequest request)

POST request to the delete_by_query_rethrottle API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/

public Task<ListTasksResponse> DeleteByQueryRethrottleAsync(TaskId taskId, Func<DeleteByQueryRethrottleDescriptor, IDeleteByQueryRethrottleRequest> selector = null, CancellationToken ct = default)

POST request to the delete_by_query_rethrottle API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/

public Task<ListTasksResponse> DeleteByQueryRethrottleAsync(IDeleteByQueryRethrottleRequest request, CancellationToken ct = default)

POST request to the delete_by_query_rethrottle API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/

public DeletePitResponse DeletePit(Func<DeletePitDescriptor, IDeletePitRequest> selector = null)

DELETE request to the delete_pit API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits

public DeletePitResponse DeletePit(IDeletePitRequest request)

DELETE request to the delete_pit API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits

public Task<DeletePitResponse> DeletePitAsync(Func<DeletePitDescriptor, IDeletePitRequest> selector = null, CancellationToken ct = default)

DELETE request to the delete_pit API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits

public Task<DeletePitResponse> DeletePitAsync(IDeletePitRequest request, CancellationToken ct = default)

DELETE request to the delete_pit API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits

public DeleteScriptResponse DeleteScript(Id id, Func<DeleteScriptDescriptor, IDeleteScriptRequest> selector = null)

DELETE request to the delete_script API, read more about this API online:

public DeleteScriptResponse DeleteScript(IDeleteScriptRequest request)

DELETE request to the delete_script API, read more about this API online:

public Task<DeleteScriptResponse> DeleteScriptAsync(Id id, Func<DeleteScriptDescriptor, IDeleteScriptRequest> selector = null, CancellationToken ct = default)

DELETE request to the delete_script API, read more about this API online:

public Task<DeleteScriptResponse> DeleteScriptAsync(IDeleteScriptRequest request, CancellationToken ct = default)

DELETE request to the delete_script API, read more about this API online:

public ExistsResponse DocumentExists<TDocument>(DocumentPath<TDocument> id, Func<DocumentExistsDescriptor<TDocument>, IDocumentExistsRequest> selector = null)

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

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public ExistsResponse DocumentExists(IDocumentExistsRequest request)

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

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public Task<ExistsResponse> DocumentExistsAsync<TDocument>(DocumentPath<TDocument> id, Func<DocumentExistsDescriptor<TDocument>, IDocumentExistsRequest> selector = null, CancellationToken ct = default)

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

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public Task<ExistsResponse> DocumentExistsAsync(IDocumentExistsRequest request, CancellationToken ct = default)

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

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public ExecutePainlessScriptResponse<TResult> ExecutePainlessScript<TResult>(Func<ExecutePainlessScriptDescriptor, IExecutePainlessScriptRequest> selector = null)

POST request to the scripts_painless_execute API, read more about this API online:

public ExecutePainlessScriptResponse<TResult> ExecutePainlessScript<TResult>(IExecutePainlessScriptRequest request)

POST request to the scripts_painless_execute API, read more about this API online:

public Task<ExecutePainlessScriptResponse<TResult>> ExecutePainlessScriptAsync<TResult>(Func<ExecutePainlessScriptDescriptor, IExecutePainlessScriptRequest> selector = null, CancellationToken ct = default)

POST request to the scripts_painless_execute API, read more about this API online:

public Task<ExecutePainlessScriptResponse<TResult>> ExecutePainlessScriptAsync<TResult>(IExecutePainlessScriptRequest request, CancellationToken ct = default)

POST request to the scripts_painless_execute API, read more about this API online:

public ExplainResponse<TDocument> Explain<TDocument>(DocumentPath<TDocument> id, Func<ExplainDescriptor<TDocument>, IExplainRequest> selector = null)

POST request to the explain API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/explain/

public ExplainResponse<TDocument> Explain<TDocument>(IExplainRequest request)

POST request to the explain API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/explain/

public Task<ExplainResponse<TDocument>> ExplainAsync<TDocument>(DocumentPath<TDocument> id, Func<ExplainDescriptor<TDocument>, IExplainRequest> selector = null, CancellationToken ct = default)

POST request to the explain API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/explain/

public Task<ExplainResponse<TDocument>> ExplainAsync<TDocument>(IExplainRequest request, CancellationToken ct = default)

POST request to the explain API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/explain/

public FieldCapabilitiesResponse FieldCapabilities(Indices index = null, Func<FieldCapabilitiesDescriptor, IFieldCapabilitiesRequest> selector = null)

POST request to the field_caps API, read more about this API online:

public FieldCapabilitiesResponse FieldCapabilities(IFieldCapabilitiesRequest request)

POST request to the field_caps API, read more about this API online:

public Task<FieldCapabilitiesResponse> FieldCapabilitiesAsync(Indices index = null, Func<FieldCapabilitiesDescriptor, IFieldCapabilitiesRequest> selector = null, CancellationToken ct = default)

POST request to the field_caps API, read more about this API online:

public Task<FieldCapabilitiesResponse> FieldCapabilitiesAsync(IFieldCapabilitiesRequest request, CancellationToken ct = default)

POST request to the field_caps API, read more about this API online:

public GetResponse<TDocument> Get<TDocument>(DocumentPath<TDocument> id, Func<GetDescriptor<TDocument>, IGetRequest> selector = null)

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

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public GetResponse<TDocument> Get<TDocument>(IGetRequest request)

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

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public GetAllPitsResponse GetAllPits(Func<GetAllPitsDescriptor, IGetAllPitsRequest> selector = null)

GET request to the get_all_pits API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits

public GetAllPitsResponse GetAllPits(IGetAllPitsRequest request)

GET request to the get_all_pits API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits

public Task<GetAllPitsResponse> GetAllPitsAsync(Func<GetAllPitsDescriptor, IGetAllPitsRequest> selector = null, CancellationToken ct = default)

GET request to the get_all_pits API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits

public Task<GetAllPitsResponse> GetAllPitsAsync(IGetAllPitsRequest request, CancellationToken ct = default)

GET request to the get_all_pits API, read more about this API online:

https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits

public Task<GetResponse<TDocument>> GetAsync<TDocument>(DocumentPath<TDocument> id, Func<GetDescriptor<TDocument>, IGetRequest> selector = null, CancellationToken ct = default)

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

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public Task<GetResponse<TDocument>> GetAsync<TDocument>(IGetRequest request, CancellationToken ct = default)

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

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public GetScriptResponse GetScript(Id id, Func<GetScriptDescriptor, IGetScriptRequest> selector = null)

GET request to the get_script API, read more about this API online:

public GetScriptResponse GetScript(IGetScriptRequest request)

GET request to the get_script API, read more about this API online:

public Task<GetScriptResponse> GetScriptAsync(Id id, Func<GetScriptDescriptor, IGetScriptRequest> selector = null, CancellationToken ct = default)

GET request to the get_script API, read more about this API online:

public Task<GetScriptResponse> GetScriptAsync(IGetScriptRequest request, CancellationToken ct = default)

GET request to the get_script API, read more about this API online:

public IndexResponse Index<TDocument>(TDocument document, Func<IndexDescriptor<TDocument>, IIndexRequest<TDocument>> selector)

PUT request to the index API, read more about this API online:

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

public IndexResponse Index<TDocument>(IIndexRequest<TDocument> request)

PUT request to the index API, read more about this API online:

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

public Task<IndexResponse> IndexAsync<TDocument>(TDocument document, Func<IndexDescriptor<TDocument>, IIndexRequest<TDocument>> selector, CancellationToken ct = default)

PUT request to the index API, read more about this API online:

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

public Task<IndexResponse> IndexAsync<TDocument>(IIndexRequest<TDocument> request, CancellationToken ct = default)

PUT request to the index API, read more about this API online:

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

public IndexResponse IndexDocument<TDocument>(TDocument document)

public Task<IndexResponse> IndexDocumentAsync<TDocument>(TDocument document, CancellationToken ct = default)

public PutMappingResponse Map<T>(Func<PutMappingDescriptor<T>, IPutMappingRequest> selector)

public PutMappingResponse Map(IPutMappingRequest request)

public Task<PutMappingResponse> MapAsync<T>(Func<PutMappingDescriptor<T>, IPutMappingRequest> selector, CancellationToken ct = default)

public Task<PutMappingResponse> MapAsync(IPutMappingRequest request, CancellationToken ct = default)

public MultiGetResponse MultiGet(Func<MultiGetDescriptor, IMultiGetRequest> selector = null)

POST request to the mget API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/multi-get/

public MultiGetResponse MultiGet(IMultiGetRequest request)

POST request to the mget API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/multi-get/

public Task<MultiGetResponse> MultiGetAsync(Func<MultiGetDescriptor, IMultiGetRequest> selector = null, CancellationToken ct = default)

POST request to the mget API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/multi-get/

public Task<MultiGetResponse> MultiGetAsync(IMultiGetRequest request, CancellationToken ct = default)

POST request to the mget API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/multi-get/

public MultiSearchResponse MultiSearch(Indices index = null, Func<MultiSearchDescriptor, IMultiSearchRequest> selector = null)

POST request to the msearch API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/

public MultiSearchResponse MultiSearch(IMultiSearchRequest request)

POST request to the msearch API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/

public Task<MultiSearchResponse> MultiSearchAsync(Indices index = null, Func<MultiSearchDescriptor, IMultiSearchRequest> selector = null, CancellationToken ct = default)

POST request to the msearch API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/

public Task<MultiSearchResponse> MultiSearchAsync(IMultiSearchRequest request, CancellationToken ct = default)

POST request to the msearch API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/

public MultiSearchResponse MultiSearchTemplate(Indices index = null, Func<MultiSearchTemplateDescriptor, IMultiSearchTemplateRequest> selector = null)

POST request to the msearch_template API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/

public MultiSearchResponse MultiSearchTemplate(IMultiSearchTemplateRequest request)

POST request to the msearch_template API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/

public Task<MultiSearchResponse> MultiSearchTemplateAsync(Indices index = null, Func<MultiSearchTemplateDescriptor, IMultiSearchTemplateRequest> selector = null, CancellationToken ct = default)

POST request to the msearch_template API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/

public Task<MultiSearchResponse> MultiSearchTemplateAsync(IMultiSearchTemplateRequest request, CancellationToken ct = default)

POST request to the msearch_template API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/

public MultiTermVectorsResponse MultiTermVectors(Func<MultiTermVectorsDescriptor, IMultiTermVectorsRequest> selector = null)

POST request to the mtermvectors API, read more about this API online:

public MultiTermVectorsResponse MultiTermVectors(IMultiTermVectorsRequest request)

POST request to the mtermvectors API, read more about this API online:

public Task<MultiTermVectorsResponse> MultiTermVectorsAsync(Func<MultiTermVectorsDescriptor, IMultiTermVectorsRequest> selector = null, CancellationToken ct = default)

POST request to the mtermvectors API, read more about this API online:

public Task<MultiTermVectorsResponse> MultiTermVectorsAsync(IMultiTermVectorsRequest request, CancellationToken ct = default)

POST request to the mtermvectors API, read more about this API online:

public PingResponse Ping(Func<PingDescriptor, IPingRequest> selector = null)

HEAD request to the ping API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/index/

public PingResponse Ping(IPingRequest request)

HEAD request to the ping API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/index/

public Task<PingResponse> PingAsync(Func<PingDescriptor, IPingRequest> selector = null, CancellationToken ct = default)

HEAD request to the ping API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/index/

public Task<PingResponse> PingAsync(IPingRequest request, CancellationToken ct = default)

HEAD request to the ping API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/index/

public PutScriptResponse PutScript(Id id, Func<PutScriptDescriptor, IPutScriptRequest> selector)

PUT request to the put_script API, read more about this API online:

public PutScriptResponse PutScript(IPutScriptRequest request)

PUT request to the put_script API, read more about this API online:

public Task<PutScriptResponse> PutScriptAsync(Id id, Func<PutScriptDescriptor, IPutScriptRequest> selector, CancellationToken ct = default)

PUT request to the put_script API, read more about this API online:

public Task<PutScriptResponse> PutScriptAsync(IPutScriptRequest request, CancellationToken ct = default)

PUT request to the put_script API, read more about this API online:

public IObservable<BulkAllResponse> Reindex<TSource>(Func<ReindexDescriptor<TSource, TSource>, IReindexRequest<TSource, TSource>> selector, CancellationToken cancellationToken = default)

public IObservable<BulkAllResponse> Reindex<TSource, TTarget>(Func<TSource, TTarget> mapper, Func<ReindexDescriptor<TSource, TTarget>, IReindexRequest<TSource, TTarget>> selector, CancellationToken cancellationToken = default)

public IObservable<BulkAllResponse> Reindex<TSource>(IReindexRequest<TSource> request, CancellationToken cancellationToken = default)

public IObservable<BulkAllResponse> Reindex<TSource, TTarget>(IReindexRequest<TSource, TTarget> request, CancellationToken cancellationToken = default)

public IObservable<BulkAllResponse> Reindex<TSource, TTarget>(IndexName fromIndex, IndexName toIndex, Func<TSource, TTarget> mapper, Func<QueryContainerDescriptor<TSource>, QueryContainer> selector = null, CancellationToken cancellationToken = default)

public IObservable<BulkAllResponse> Reindex<TSource>(IndexName fromIndex, IndexName toIndex, Func<QueryContainerDescriptor<TSource>, QueryContainer> selector = null, CancellationToken cancellationToken = default)

public ReindexOnServerResponse ReindexOnServer(Func<ReindexOnServerDescriptor, IReindexOnServerRequest> selector)

POST request to the reindex API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/

public ReindexOnServerResponse ReindexOnServer(IReindexOnServerRequest request)

POST request to the reindex API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/

public Task<ReindexOnServerResponse> ReindexOnServerAsync(Func<ReindexOnServerDescriptor, IReindexOnServerRequest> selector, CancellationToken ct = default)

POST request to the reindex API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/

public Task<ReindexOnServerResponse> ReindexOnServerAsync(IReindexOnServerRequest request, CancellationToken ct = default)

POST request to the reindex API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/

public ReindexRethrottleResponse ReindexRethrottle(TaskId taskId, Func<ReindexRethrottleDescriptor, IReindexRethrottleRequest> selector = null)

POST request to the reindex_rethrottle API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/

public ReindexRethrottleResponse ReindexRethrottle(IReindexRethrottleRequest request)

POST request to the reindex_rethrottle API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/

public Task<ReindexRethrottleResponse> ReindexRethrottleAsync(TaskId taskId, Func<ReindexRethrottleDescriptor, IReindexRethrottleRequest> selector = null, CancellationToken ct = default)

POST request to the reindex_rethrottle API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/

public Task<ReindexRethrottleResponse> ReindexRethrottleAsync(IReindexRethrottleRequest request, CancellationToken ct = default)

POST request to the reindex_rethrottle API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/

public RenderSearchTemplateResponse RenderSearchTemplate(Func<RenderSearchTemplateDescriptor, IRenderSearchTemplateRequest> selector = null)

POST request to the render_search_template API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/search-template/

public RenderSearchTemplateResponse RenderSearchTemplate(IRenderSearchTemplateRequest request)

POST request to the render_search_template API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/search-template/

public Task<RenderSearchTemplateResponse> RenderSearchTemplateAsync(Func<RenderSearchTemplateDescriptor, IRenderSearchTemplateRequest> selector = null, CancellationToken ct = default)

POST request to the render_search_template API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/search-template/

public Task<RenderSearchTemplateResponse> RenderSearchTemplateAsync(IRenderSearchTemplateRequest request, CancellationToken ct = default)

POST request to the render_search_template API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/search-template/

public RootNodeInfoResponse RootNodeInfo(Func<RootNodeInfoDescriptor, IRootNodeInfoRequest> selector = null)

GET request to the info API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/index/

public RootNodeInfoResponse RootNodeInfo(IRootNodeInfoRequest request)

GET request to the info API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/index/

public Task<RootNodeInfoResponse> RootNodeInfoAsync(Func<RootNodeInfoDescriptor, IRootNodeInfoRequest> selector = null, CancellationToken ct = default)

GET request to the info API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/index/

public Task<RootNodeInfoResponse> RootNodeInfoAsync(IRootNodeInfoRequest request, CancellationToken ct = default)

GET request to the info API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/index/

public ISearchResponse<TDocument> Scroll<TInferDocument, TDocument>(Time scroll, string scrollId, Func<ScrollDescriptor<TInferDocument>, IScrollRequest> selector = null)

POST request to the scroll API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/search/#request-body

public ISearchResponse<TDocument> Scroll<TDocument>(Time scroll, string scrollId, Func<ScrollDescriptor<TDocument>, IScrollRequest> selector = null)

POST request to the scroll API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/search/#request-body

public ISearchResponse<TDocument> Scroll<TDocument>(IScrollRequest request)

POST request to the scroll API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/search/#request-body

public IObservable<ScrollAllResponse<T>> ScrollAll<T>(Time scrollTime, int numberOfSlices, Func<ScrollAllDescriptor<T>, IScrollAllRequest> selector = null, CancellationToken cancellationToken = default)

public IObservable<ScrollAllResponse<T>> ScrollAll<T>(IScrollAllRequest request, CancellationToken cancellationToken = default)

public Task<ISearchResponse<TDocument>> ScrollAsync<TInferDocument, TDocument>(Time scroll, string scrollId, Func<ScrollDescriptor<TInferDocument>, IScrollRequest> selector = null, CancellationToken ct = default)

POST request to the scroll API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/search/#request-body

public Task<ISearchResponse<TDocument>> ScrollAsync<TDocument>(Time scroll, string scrollId, Func<ScrollDescriptor<TDocument>, IScrollRequest> selector = null, CancellationToken ct = default)

POST request to the scroll API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/search/#request-body

public Task<ISearchResponse<TDocument>> ScrollAsync<TDocument>(IScrollRequest request, CancellationToken ct = default)

POST request to the scroll API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/search/#request-body

public ISearchResponse<TDocument> Search<TInferDocument, TDocument>(Func<SearchDescriptor<TInferDocument>, ISearchRequest> selector = null)

POST request to the search API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/search/

public ISearchResponse<TDocument> Search<TDocument>(Func<SearchDescriptor<TDocument>, ISearchRequest> selector = null)

POST request to the search API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/search/

public ISearchResponse<TDocument> Search<TDocument>(ISearchRequest request)

POST request to the search API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/search/

public Task<ISearchResponse<TDocument>> SearchAsync<TInferDocument, TDocument>(Func<SearchDescriptor<TInferDocument>, ISearchRequest> selector = null, CancellationToken ct = default)

POST request to the search API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/search/

public Task<ISearchResponse<TDocument>> SearchAsync<TDocument>(Func<SearchDescriptor<TDocument>, ISearchRequest> selector = null, CancellationToken ct = default)

POST request to the search API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/search/

public Task<ISearchResponse<TDocument>> SearchAsync<TDocument>(ISearchRequest request, CancellationToken ct = default)

POST request to the search API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/search/

public SearchShardsResponse SearchShards<TDocument>(Func<SearchShardsDescriptor<TDocument>, ISearchShardsRequest> selector = null)

POST request to the search_shards API, read more about this API online:

https://opensearch.org/docs/latest/security-plugin/access-control/cross-cluster-search/

public SearchShardsResponse SearchShards(ISearchShardsRequest request)

POST request to the search_shards API, read more about this API online:

https://opensearch.org/docs/latest/security-plugin/access-control/cross-cluster-search/

public Task<SearchShardsResponse> SearchShardsAsync<TDocument>(Func<SearchShardsDescriptor<TDocument>, ISearchShardsRequest> selector = null, CancellationToken ct = default)

POST request to the search_shards API, read more about this API online:

https://opensearch.org/docs/latest/security-plugin/access-control/cross-cluster-search/

public Task<SearchShardsResponse> SearchShardsAsync(ISearchShardsRequest request, CancellationToken ct = default)

POST request to the search_shards API, read more about this API online:

https://opensearch.org/docs/latest/security-plugin/access-control/cross-cluster-search/

public ISearchResponse<TDocument> SearchTemplate<TDocument>(Func<SearchTemplateDescriptor<TDocument>, ISearchTemplateRequest> selector = null)

POST request to the search_template API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/search-template/

public ISearchResponse<TDocument> SearchTemplate<TDocument>(ISearchTemplateRequest request)

POST request to the search_template API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/search-template/

public Task<ISearchResponse<TDocument>> SearchTemplateAsync<TDocument>(Func<SearchTemplateDescriptor<TDocument>, ISearchTemplateRequest> selector = null, CancellationToken ct = default)

POST request to the search_template API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/search-template/

public Task<ISearchResponse<TDocument>> SearchTemplateAsync<TDocument>(ISearchTemplateRequest request, CancellationToken ct = default)

POST request to the search_template API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/search-template/

public SourceResponse<TDocument> Source<TDocument>(DocumentPath<TDocument> id, Func<SourceDescriptor<TDocument>, ISourceRequest> selector = null)

GET request to the get_source API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public SourceResponse<TDocument> Source<TDocument>(ISourceRequest request)

GET request to the get_source API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public Task<SourceResponse<TDocument>> SourceAsync<TDocument>(DocumentPath<TDocument> id, Func<SourceDescriptor<TDocument>, ISourceRequest> selector = null, CancellationToken ct = default)

GET request to the get_source API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public Task<SourceResponse<TDocument>> SourceAsync<TDocument>(ISourceRequest request, CancellationToken ct = default)

GET request to the get_source API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public ExistsResponse SourceExists<TDocument>(DocumentPath<TDocument> id, Func<SourceExistsDescriptor<TDocument>, ISourceExistsRequest> selector = null)

HEAD request to the exists_source API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public ExistsResponse SourceExists(ISourceExistsRequest request)

HEAD request to the exists_source API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public Task<ExistsResponse> SourceExistsAsync<TDocument>(DocumentPath<TDocument> id, Func<SourceExistsDescriptor<TDocument>, ISourceExistsRequest> selector = null, CancellationToken ct = default)

HEAD request to the exists_source API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public Task<ExistsResponse> SourceExistsAsync(ISourceExistsRequest request, CancellationToken ct = default)

HEAD request to the exists_source API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/

public TermVectorsResponse TermVectors<TDocument>(Func<TermVectorsDescriptor<TDocument>, ITermVectorsRequest<TDocument>> selector = null)

POST request to the termvectors API, read more about this API online:

public TermVectorsResponse TermVectors<TDocument>(ITermVectorsRequest<TDocument> request)

POST request to the termvectors API, read more about this API online:

public Task<TermVectorsResponse> TermVectorsAsync<TDocument>(Func<TermVectorsDescriptor<TDocument>, ITermVectorsRequest<TDocument>> selector = null, CancellationToken ct = default)

POST request to the termvectors API, read more about this API online:

public Task<TermVectorsResponse> TermVectorsAsync<TDocument>(ITermVectorsRequest<TDocument> request, CancellationToken ct = default)

POST request to the termvectors API, read more about this API online:

public UpdateResponse<TDocument> Update<TDocument, TPartialDocument>(DocumentPath<TDocument> id, Func<UpdateDescriptor<TDocument, TPartialDocument>, IUpdateRequest<TDocument, TPartialDocument>> selector)

POST request to the update API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-document/

public UpdateResponse<TDocument> Update<TDocument>(DocumentPath<TDocument> id, Func<UpdateDescriptor<TDocument, TDocument>, IUpdateRequest<TDocument, TDocument>> selector)

POST request to the update API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-document/

public UpdateResponse<TDocument> Update<TDocument, TPartialDocument>(IUpdateRequest<TDocument, TPartialDocument> request)

POST request to the update API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-document/

public Task<UpdateResponse<TDocument>> UpdateAsync<TDocument, TPartialDocument>(DocumentPath<TDocument> id, Func<UpdateDescriptor<TDocument, TPartialDocument>, IUpdateRequest<TDocument, TPartialDocument>> selector, CancellationToken ct = default)

POST request to the update API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-document/

public Task<UpdateResponse<TDocument>> UpdateAsync<TDocument>(DocumentPath<TDocument> id, Func<UpdateDescriptor<TDocument, TDocument>, IUpdateRequest<TDocument, TDocument>> selector, CancellationToken ct = default)

POST request to the update API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-document/

public Task<UpdateResponse<TDocument>> UpdateAsync<TDocument, TPartialDocument>(IUpdateRequest<TDocument, TPartialDocument> request, CancellationToken ct = default)

POST request to the update API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-document/

public UpdateByQueryResponse UpdateByQuery<TDocument>(Func<UpdateByQueryDescriptor<TDocument>, IUpdateByQueryRequest> selector = null)

POST request to the update_by_query API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/

public UpdateByQueryResponse UpdateByQuery(IUpdateByQueryRequest request)

POST request to the update_by_query API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/

public Task<UpdateByQueryResponse> UpdateByQueryAsync<TDocument>(Func<UpdateByQueryDescriptor<TDocument>, IUpdateByQueryRequest> selector = null, CancellationToken ct = default)

POST request to the update_by_query API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/

public Task<UpdateByQueryResponse> UpdateByQueryAsync(IUpdateByQueryRequest request, CancellationToken ct = default)

POST request to the update_by_query API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/

public ListTasksResponse UpdateByQueryRethrottle(TaskId taskId, Func<UpdateByQueryRethrottleDescriptor, IUpdateByQueryRethrottleRequest> selector = null)

POST request to the update_by_query_rethrottle API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/

public ListTasksResponse UpdateByQueryRethrottle(IUpdateByQueryRethrottleRequest request)

POST request to the update_by_query_rethrottle API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/

public Task<ListTasksResponse> UpdateByQueryRethrottleAsync(TaskId taskId, Func<UpdateByQueryRethrottleDescriptor, IUpdateByQueryRethrottleRequest> selector = null, CancellationToken ct = default)

POST request to the update_by_query_rethrottle API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/

public Task<ListTasksResponse> UpdateByQueryRethrottleAsync(IUpdateByQueryRethrottleRequest request, CancellationToken ct = default)

POST request to the update_by_query_rethrottle API, read more about this API online:

https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/