Interface IOpenSearchClient

OpenSearch high level client

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public interface IOpenSearchClient

Properties

Cat

Cat APIs

Declaration

ICatNamespace Cat { get; }

Property Value

Type	Description
ICatNamespace

Cluster

Cluster APIs

Declaration

IClusterNamespace Cluster { get; }

Property Value

Type	Description
IClusterNamespace

ConnectionSettings

The configured connection settings for the client

Declaration

IConnectionSettingsValues ConnectionSettings { get; }

Property Value

Type	Description
IConnectionSettingsValues

DanglingIndices

Dangling Indices APIs

Declaration

IDanglingIndicesNamespace DanglingIndices { get; }

Property Value

Type	Description
IDanglingIndicesNamespace

Http

Http APIs

Declaration

IHttpNamespace Http { get; }

Property Value

Type	Description
IHttpNamespace

Indices

Indices APIs

Declaration

IIndicesNamespace Indices { get; }

Property Value

Type	Description
IIndicesNamespace

Infer

Access to the Inferrer that this instance of the client uses to resolve types to e.g indices, property, field names

Declaration

Inferrer Infer { get; }

Property Value

Type	Description
Inferrer

Ingest

Ingest APIs

Declaration

IIngestNamespace Ingest { get; }

Property Value

Type	Description
IIngestNamespace

LowLevel

An instance of the low level client that uses the serializers from the highlevel client.

Declaration

IOpenSearchLowLevelClient LowLevel { get; }

Property Value

Type	Description
IOpenSearchLowLevelClient

Nodes

Nodes APIs

Declaration

INodesNamespace Nodes { get; }

Property Value

Type	Description
INodesNamespace

RequestResponseSerializer

Access the configured RequestResponseSerializer Out of the box SourceSerializer and this point to the same instance

Declaration

IOpenSearchSerializer RequestResponseSerializer { get; }

Property Value

Type	Description
IOpenSearchSerializer

Snapshot

Snapshot APIs

Declaration

ISnapshotNamespace Snapshot { get; }

Property Value

Type	Description
ISnapshotNamespace

SourceSerializer

Access the configured SourceSerializer Out of the box RequestResponseSerializer and this point to the same instance

Declaration

IOpenSearchSerializer SourceSerializer { get; }

Property Value

Type	Description
IOpenSearchSerializer

Tasks

Tasks APIs

Declaration

ITasksNamespace Tasks { get; }

Property Value

Type	Description
ITasksNamespace

Methods

Bulk(IBulkRequest)

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

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

Declaration

BulkResponse Bulk(IBulkRequest request)

Parameters

Type	Name	Description
IBulkRequest	request

Returns

Type	Description
BulkResponse

Bulk(Func<BulkDescriptor, IBulkRequest>)

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

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

Declaration

BulkResponse Bulk(Func<BulkDescriptor, IBulkRequest> selector)

Parameters

Type	Name	Description
Func<BulkDescriptor, IBulkRequest>	selector

Returns

Type	Description
BulkResponse

BulkAll<T>(IBulkAllRequest<T>, CancellationToken)

BulkAll is a generic helper that will partition any lazy stream of documents and send them to OpenSearch as concurrent bulk requests

The index to target will be inferred from T. If no default index has been mapped for T using DefaultMappingFor<TDocument>(Func<ClrTypeMappingDescriptor<TDocument>, IClrTypeMapping<TDocument>>) on ConnectionSettings, an exception will be thrown. Inference can be overridden using Index, and in addition, an index can be specified for each document using BufferToBulk.

Declaration

BulkAllObservable<T> BulkAll<T>(IBulkAllRequest<T> request, CancellationToken cancellationToken = default) where T : class

Parameters

Type	Name	Description
IBulkAllRequest<T>	request
CancellationToken	cancellationToken

Returns

Type	Description
BulkAllObservable<T>

Type Parameters

Name	Description
T

BulkAll<T>(IEnumerable<T>, Func<BulkAllDescriptor<T>, IBulkAllRequest<T>>, CancellationToken)

BulkAll is a generic helper that will partition any lazy stream of documents and send them to OpenSearch as concurrent bulk requests.

The index to target will be inferred from T. If no default index has been mapped for T using DefaultMappingFor<TDocument>(Func<ClrTypeMappingDescriptor<TDocument>, IClrTypeMapping<TDocument>>) on ConnectionSettings, an exception will be thrown. Inference can be overridden using Index(IndexName), and in addition, an index can be specified for each document using BufferToBulk(Action<BulkDescriptor, IList<T>>).

Declaration

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

Parameters

Type	Name	Description
IEnumerable<T>	documents	The lazy stream of documents
Func<BulkAllDescriptor<T>, IBulkAllRequest<T>>	selector
CancellationToken	cancellationToken

Returns

Type	Description
BulkAllObservable<T>

Type Parameters

Name	Description
T

BulkAsync(IBulkRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IBulkRequest	request
CancellationToken	ct

Returns

Type	Description
Task<BulkResponse>

BulkAsync(Func<BulkDescriptor, IBulkRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<BulkDescriptor, IBulkRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<BulkResponse>

ClearScroll(IClearScrollRequest)

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

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

Declaration

ClearScrollResponse ClearScroll(IClearScrollRequest request)

Parameters

Type	Name	Description
IClearScrollRequest	request

Returns

Type	Description
ClearScrollResponse

ClearScroll(Func<ClearScrollDescriptor, IClearScrollRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<ClearScrollDescriptor, IClearScrollRequest>	selector

Returns

Type	Description
ClearScrollResponse

ClearScrollAsync(IClearScrollRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IClearScrollRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ClearScrollResponse>

ClearScrollAsync(Func<ClearScrollDescriptor, IClearScrollRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<ClearScrollDescriptor, IClearScrollRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ClearScrollResponse>

Count(ICountRequest)

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

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

Declaration

CountResponse Count(ICountRequest request)

Parameters

Type	Name	Description
ICountRequest	request

Returns

Type	Description
CountResponse

CountAsync(ICountRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
ICountRequest	request
CancellationToken	ct

Returns

Type	Description
Task<CountResponse>

CountAsync<TDocument>(Func<CountDescriptor<TDocument>, ICountRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<CountDescriptor<TDocument>, ICountRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<CountResponse>

Type Parameters

Name	Description
TDocument

Count<TDocument>(Func<CountDescriptor<TDocument>, ICountRequest>)

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

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

Declaration

CountResponse Count<TDocument>(Func<CountDescriptor<TDocument>, ICountRequest> selector = null) where TDocument : class

Parameters

Type	Name	Description
Func<CountDescriptor<TDocument>, ICountRequest>	selector

Returns

Type	Description
CountResponse

Type Parameters

Name	Description
TDocument

CreateAsync<TDocument>(ICreateRequest<TDocument>, CancellationToken)

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

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

Declaration

Task<CreateResponse> CreateAsync<TDocument>(ICreateRequest<TDocument> request, CancellationToken ct = default) where TDocument : class

Parameters

Type	Name	Description
ICreateRequest<TDocument>	request
CancellationToken	ct

Returns

Type	Description
Task<CreateResponse>

Type Parameters

Name	Description
TDocument

CreateAsync<TDocument>(TDocument, Func<CreateDescriptor<TDocument>, ICreateRequest<TDocument>>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
TDocument	document
Func<CreateDescriptor<TDocument>, ICreateRequest<TDocument>>	selector
CancellationToken	ct

Returns

Type	Description
Task<CreateResponse>

Type Parameters

Name	Description
TDocument

CreateDocumentAsync<TDocument>(TDocument, CancellationToken)

Creates a new typed document in a specific index. If a document with the same index, type and id already exists, A 409 Conflict HTTP response status code and error will be returned.

Declaration

Task<CreateResponse> CreateDocumentAsync<TDocument>(TDocument document, CancellationToken cancellationToken = default) where TDocument : class

Parameters

Type	Name	Description
TDocument	document	The document to be created. Id will be inferred from (in order): 1. Id property set up on ConnectionSettings for TDocument 2. IdProperty property on OpenSearchTypeAttribute applied to TDocument 3. A property named Id on TDocument
CancellationToken	cancellationToken

Returns

Type	Description
Task<CreateResponse>

Type Parameters

Name	Description
TDocument	The document type used to infer the default index, type and id

CreateDocument<TDocument>(TDocument)

Creates a new typed document in a specific index. If a document with the same index, type and id already exists, A 409 Conflict HTTP response status code and error will be returned.

Declaration

CreateResponse CreateDocument<TDocument>(TDocument document) where TDocument : class

Parameters

Type	Name	Description
TDocument	document	The document to be created. Id will be inferred from (in order): 1. Id property set up on ConnectionSettings for TDocument 2. IdProperty property on OpenSearchTypeAttribute applied to TDocument 3. A property named Id on TDocument

Returns

Type	Description
CreateResponse

Type Parameters

Name	Description
TDocument	The document type used to infer the default index, type and id

CreatePit(ICreatePitRequest)

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

Declaration

CreatePitResponse CreatePit(ICreatePitRequest request)

Parameters

Type	Name	Description
ICreatePitRequest	request

Returns

Type	Description
CreatePitResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

CreatePit(Indices, Func<CreatePitDescriptor, ICreatePitRequest>)

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

Declaration

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

Parameters

Type	Name	Description
Indices	index
Func<CreatePitDescriptor, ICreatePitRequest>	selector

Returns

Type	Description
CreatePitResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

CreatePitAsync(ICreatePitRequest, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
ICreatePitRequest	request
CancellationToken	ct

Returns

Type	Description
Task<CreatePitResponse>

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

CreatePitAsync(Indices, Func<CreatePitDescriptor, ICreatePitRequest>, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
Indices	index
Func<CreatePitDescriptor, ICreatePitRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<CreatePitResponse>

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

Create<TDocument>(ICreateRequest<TDocument>)

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

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

Declaration

CreateResponse Create<TDocument>(ICreateRequest<TDocument> request) where TDocument : class

Parameters

Type	Name	Description
ICreateRequest<TDocument>	request

Returns

Type	Description
CreateResponse

Type Parameters

Name	Description
TDocument

Create<TDocument>(TDocument, Func<CreateDescriptor<TDocument>, ICreateRequest<TDocument>>)

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

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

Declaration

CreateResponse Create<TDocument>(TDocument document, Func<CreateDescriptor<TDocument>, ICreateRequest<TDocument>> selector) where TDocument : class

Parameters

Type	Name	Description
TDocument	document
Func<CreateDescriptor<TDocument>, ICreateRequest<TDocument>>	selector

Returns

Type	Description
CreateResponse

Type Parameters

Name	Description
TDocument

Delete(IDeleteRequest)

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

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

Declaration

DeleteResponse Delete(IDeleteRequest request)

Parameters

Type	Name	Description
IDeleteRequest	request

Returns

Type	Description
DeleteResponse

DeleteAllPits(IDeleteAllPitsRequest)

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

Declaration

DeleteAllPitsResponse DeleteAllPits(IDeleteAllPitsRequest request)

Parameters

Type	Name	Description
IDeleteAllPitsRequest	request

Returns

Type	Description
DeleteAllPitsResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

DeleteAllPits(Func<DeleteAllPitsDescriptor, IDeleteAllPitsRequest>)

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

Declaration

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

Parameters

Type	Name	Description
Func<DeleteAllPitsDescriptor, IDeleteAllPitsRequest>	selector

Returns

Type	Description
DeleteAllPitsResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

DeleteAllPitsAsync(IDeleteAllPitsRequest, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
IDeleteAllPitsRequest	request
CancellationToken	ct

Returns

Type	Description
Task<DeleteAllPitsResponse>

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

DeleteAllPitsAsync(Func<DeleteAllPitsDescriptor, IDeleteAllPitsRequest>, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
Func<DeleteAllPitsDescriptor, IDeleteAllPitsRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<DeleteAllPitsResponse>

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

DeleteAsync(IDeleteRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IDeleteRequest	request
CancellationToken	ct

Returns

Type	Description
Task<DeleteResponse>

DeleteAsync<TDocument>(DocumentPath<TDocument>, Func<DeleteDescriptor<TDocument>, IDeleteRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<DeleteDescriptor<TDocument>, IDeleteRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<DeleteResponse>

Type Parameters

Name	Description
TDocument

DeleteByQuery(IDeleteByQueryRequest)

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

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

Declaration

DeleteByQueryResponse DeleteByQuery(IDeleteByQueryRequest request)

Parameters

Type	Name	Description
IDeleteByQueryRequest	request

Returns

Type	Description
DeleteByQueryResponse

DeleteByQueryAsync(IDeleteByQueryRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IDeleteByQueryRequest	request
CancellationToken	ct

Returns

Type	Description
Task<DeleteByQueryResponse>

DeleteByQueryAsync<TDocument>(Func<DeleteByQueryDescriptor<TDocument>, IDeleteByQueryRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<DeleteByQueryDescriptor<TDocument>, IDeleteByQueryRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<DeleteByQueryResponse>

Type Parameters

Name	Description
TDocument

DeleteByQueryRethrottle(IDeleteByQueryRethrottleRequest)

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

https://opensearch.org/docs/latest

Declaration

ListTasksResponse DeleteByQueryRethrottle(IDeleteByQueryRethrottleRequest request)

Parameters

Type	Name	Description
IDeleteByQueryRethrottleRequest	request

Returns

Type	Description
ListTasksResponse

DeleteByQueryRethrottle(TaskId, Func<DeleteByQueryRethrottleDescriptor, IDeleteByQueryRethrottleRequest>)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
TaskId	taskId
Func<DeleteByQueryRethrottleDescriptor, IDeleteByQueryRethrottleRequest>	selector

Returns

Type	Description
ListTasksResponse

DeleteByQueryRethrottleAsync(IDeleteByQueryRethrottleRequest, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
IDeleteByQueryRethrottleRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ListTasksResponse>

DeleteByQueryRethrottleAsync(TaskId, Func<DeleteByQueryRethrottleDescriptor, IDeleteByQueryRethrottleRequest>, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
TaskId	taskId
Func<DeleteByQueryRethrottleDescriptor, IDeleteByQueryRethrottleRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ListTasksResponse>

DeleteByQuery<TDocument>(Func<DeleteByQueryDescriptor<TDocument>, IDeleteByQueryRequest>)

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

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

Declaration

DeleteByQueryResponse DeleteByQuery<TDocument>(Func<DeleteByQueryDescriptor<TDocument>, IDeleteByQueryRequest> selector) where TDocument : class

Parameters

Type	Name	Description
Func<DeleteByQueryDescriptor<TDocument>, IDeleteByQueryRequest>	selector

Returns

Type	Description
DeleteByQueryResponse

Type Parameters

Name	Description
TDocument

DeletePit(IDeletePitRequest)

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

Declaration

DeletePitResponse DeletePit(IDeletePitRequest request)

Parameters

Type	Name	Description
IDeletePitRequest	request

Returns

Type	Description
DeletePitResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

DeletePit(Func<DeletePitDescriptor, IDeletePitRequest>)

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

Declaration

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

Parameters

Type	Name	Description
Func<DeletePitDescriptor, IDeletePitRequest>	selector

Returns

Type	Description
DeletePitResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

DeletePitAsync(IDeletePitRequest, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
IDeletePitRequest	request
CancellationToken	ct

Returns

Type	Description
Task<DeletePitResponse>

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

DeletePitAsync(Func<DeletePitDescriptor, IDeletePitRequest>, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
Func<DeletePitDescriptor, IDeletePitRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<DeletePitResponse>

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

DeleteScript(IDeleteScriptRequest)

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

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

Declaration

DeleteScriptResponse DeleteScript(IDeleteScriptRequest request)

Parameters

Type	Name	Description
IDeleteScriptRequest	request

Returns

Type	Description
DeleteScriptResponse

DeleteScript(Id, Func<DeleteScriptDescriptor, IDeleteScriptRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
Id	id
Func<DeleteScriptDescriptor, IDeleteScriptRequest>	selector

Returns

Type	Description
DeleteScriptResponse

DeleteScriptAsync(IDeleteScriptRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IDeleteScriptRequest	request
CancellationToken	ct

Returns

Type	Description
Task<DeleteScriptResponse>

DeleteScriptAsync(Id, Func<DeleteScriptDescriptor, IDeleteScriptRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Id	id
Func<DeleteScriptDescriptor, IDeleteScriptRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<DeleteScriptResponse>

Delete<TDocument>(DocumentPath<TDocument>, Func<DeleteDescriptor<TDocument>, IDeleteRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<DeleteDescriptor<TDocument>, IDeleteRequest>	selector

Returns

Type	Description
DeleteResponse

Type Parameters

Name	Description
TDocument

DocumentExists(IDocumentExistsRequest)

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

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

Declaration

ExistsResponse DocumentExists(IDocumentExistsRequest request)

Parameters

Type	Name	Description
IDocumentExistsRequest	request

Returns

Type	Description
ExistsResponse

DocumentExistsAsync(IDocumentExistsRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IDocumentExistsRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ExistsResponse>

DocumentExistsAsync<TDocument>(DocumentPath<TDocument>, Func<DocumentExistsDescriptor<TDocument>, IDocumentExistsRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<DocumentExistsDescriptor<TDocument>, IDocumentExistsRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ExistsResponse>

Type Parameters

Name	Description
TDocument

DocumentExists<TDocument>(DocumentPath<TDocument>, Func<DocumentExistsDescriptor<TDocument>, IDocumentExistsRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<DocumentExistsDescriptor<TDocument>, IDocumentExistsRequest>	selector

Returns

Type	Description
ExistsResponse

Type Parameters

Name	Description
TDocument

ExecutePainlessScriptAsync<TResult>(IExecutePainlessScriptRequest, CancellationToken)

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

https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/

Declaration

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

Parameters

Type	Name	Description
IExecutePainlessScriptRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ExecutePainlessScriptResponse<TResult>>

Type Parameters

Name	Description
TResult

ExecutePainlessScriptAsync<TResult>(Func<ExecutePainlessScriptDescriptor, IExecutePainlessScriptRequest>, CancellationToken)

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

https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/

Declaration

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

Parameters

Type	Name	Description
Func<ExecutePainlessScriptDescriptor, IExecutePainlessScriptRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ExecutePainlessScriptResponse<TResult>>

Type Parameters

Name	Description
TResult

ExecutePainlessScript<TResult>(IExecutePainlessScriptRequest)

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

https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/

Declaration

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

Parameters

Type	Name	Description
IExecutePainlessScriptRequest	request

Returns

Type	Description
ExecutePainlessScriptResponse<TResult>

Type Parameters

Name	Description
TResult

ExecutePainlessScript<TResult>(Func<ExecutePainlessScriptDescriptor, IExecutePainlessScriptRequest>)

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

https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/

Declaration

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

Parameters

Type	Name	Description
Func<ExecutePainlessScriptDescriptor, IExecutePainlessScriptRequest>	selector

Returns

Type	Description
ExecutePainlessScriptResponse<TResult>

Type Parameters

Name	Description
TResult

ExplainAsync<TDocument>(DocumentPath<TDocument>, Func<ExplainDescriptor<TDocument>, IExplainRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<ExplainDescriptor<TDocument>, IExplainRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ExplainResponse<TDocument>>

Type Parameters

Name	Description
TDocument

ExplainAsync<TDocument>(IExplainRequest, CancellationToken)

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

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

Declaration

Task<ExplainResponse<TDocument>> ExplainAsync<TDocument>(IExplainRequest request, CancellationToken ct = default) where TDocument : class

Parameters

Type	Name	Description
IExplainRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ExplainResponse<TDocument>>

Type Parameters

Name	Description
TDocument

Explain<TDocument>(DocumentPath<TDocument>, Func<ExplainDescriptor<TDocument>, IExplainRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<ExplainDescriptor<TDocument>, IExplainRequest>	selector

Returns

Type	Description
ExplainResponse<TDocument>

Type Parameters

Name	Description
TDocument

Explain<TDocument>(IExplainRequest)

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

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

Declaration

ExplainResponse<TDocument> Explain<TDocument>(IExplainRequest request) where TDocument : class

Parameters

Type	Name	Description
IExplainRequest	request

Returns

Type	Description
ExplainResponse<TDocument>

Type Parameters

Name	Description
TDocument

FieldCapabilities(IFieldCapabilitiesRequest)

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

https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations

Declaration

FieldCapabilitiesResponse FieldCapabilities(IFieldCapabilitiesRequest request)

Parameters

Type	Name	Description
IFieldCapabilitiesRequest	request

Returns

Type	Description
FieldCapabilitiesResponse

FieldCapabilities(Indices, Func<FieldCapabilitiesDescriptor, IFieldCapabilitiesRequest>)

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

https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations

Declaration

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

Parameters

Type	Name	Description
Indices	index
Func<FieldCapabilitiesDescriptor, IFieldCapabilitiesRequest>	selector

Returns

Type	Description
FieldCapabilitiesResponse

FieldCapabilitiesAsync(IFieldCapabilitiesRequest, CancellationToken)

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

https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations

Declaration

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

Parameters

Type	Name	Description
IFieldCapabilitiesRequest	request
CancellationToken	ct

Returns

Type	Description
Task<FieldCapabilitiesResponse>

FieldCapabilitiesAsync(Indices, Func<FieldCapabilitiesDescriptor, IFieldCapabilitiesRequest>, CancellationToken)

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

https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations

Declaration

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

Parameters

Type	Name	Description
Indices	index
Func<FieldCapabilitiesDescriptor, IFieldCapabilitiesRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<FieldCapabilitiesResponse>

GetAllPits(IGetAllPitsRequest)

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

Declaration

GetAllPitsResponse GetAllPits(IGetAllPitsRequest request)

Parameters

Type	Name	Description
IGetAllPitsRequest	request

Returns

Type	Description
GetAllPitsResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetAllPits(Func<GetAllPitsDescriptor, IGetAllPitsRequest>)

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

Declaration

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

Parameters

Type	Name	Description
Func<GetAllPitsDescriptor, IGetAllPitsRequest>	selector

Returns

Type	Description
GetAllPitsResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetAllPitsAsync(IGetAllPitsRequest, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
IGetAllPitsRequest	request
CancellationToken	ct

Returns

Type	Description
Task<GetAllPitsResponse>

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetAllPitsAsync(Func<GetAllPitsDescriptor, IGetAllPitsRequest>, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
Func<GetAllPitsDescriptor, IGetAllPitsRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<GetAllPitsResponse>

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetAsync<TDocument>(DocumentPath<TDocument>, Func<GetDescriptor<TDocument>, IGetRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<GetDescriptor<TDocument>, IGetRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<GetResponse<TDocument>>

Type Parameters

Name	Description
TDocument

GetAsync<TDocument>(IGetRequest, CancellationToken)

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

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

Declaration

Task<GetResponse<TDocument>> GetAsync<TDocument>(IGetRequest request, CancellationToken ct = default) where TDocument : class

Parameters

Type	Name	Description
IGetRequest	request
CancellationToken	ct

Returns

Type	Description
Task<GetResponse<TDocument>>

Type Parameters

Name	Description
TDocument

GetScript(IGetScriptRequest)

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

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

Declaration

GetScriptResponse GetScript(IGetScriptRequest request)

Parameters

Type	Name	Description
IGetScriptRequest	request

Returns

Type	Description
GetScriptResponse

GetScript(Id, Func<GetScriptDescriptor, IGetScriptRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
Id	id
Func<GetScriptDescriptor, IGetScriptRequest>	selector

Returns

Type	Description
GetScriptResponse

GetScriptAsync(IGetScriptRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IGetScriptRequest	request
CancellationToken	ct

Returns

Type	Description
Task<GetScriptResponse>

GetScriptAsync(Id, Func<GetScriptDescriptor, IGetScriptRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Id	id
Func<GetScriptDescriptor, IGetScriptRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<GetScriptResponse>

Get<TDocument>(DocumentPath<TDocument>, Func<GetDescriptor<TDocument>, IGetRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<GetDescriptor<TDocument>, IGetRequest>	selector

Returns

Type	Description
GetResponse<TDocument>

Type Parameters

Name	Description
TDocument

Get<TDocument>(IGetRequest)

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

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

Declaration

GetResponse<TDocument> Get<TDocument>(IGetRequest request) where TDocument : class

Parameters

Type	Name	Description
IGetRequest	request

Returns

Type	Description
GetResponse<TDocument>

Type Parameters

Name	Description
TDocument

IndexAsync<TDocument>(IIndexRequest<TDocument>, CancellationToken)

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

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

Declaration

Task<IndexResponse> IndexAsync<TDocument>(IIndexRequest<TDocument> request, CancellationToken ct = default) where TDocument : class

Parameters

Type	Name	Description
IIndexRequest<TDocument>	request
CancellationToken	ct

Returns

Type	Description
Task<IndexResponse>

Type Parameters

Name	Description
TDocument

IndexAsync<TDocument>(TDocument, Func<IndexDescriptor<TDocument>, IIndexRequest<TDocument>>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
TDocument	document
Func<IndexDescriptor<TDocument>, IIndexRequest<TDocument>>	selector
CancellationToken	ct

Returns

Type	Description
Task<IndexResponse>

Type Parameters

Name	Description
TDocument

IndexDocumentAsync<T>(T, CancellationToken)

Adds or updates a typed JSON document in a specific index, making it searchable.

 

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

Declaration

Task<IndexResponse> IndexDocumentAsync<T>(T document, CancellationToken ct = default) where T : class

Parameters

Type	Name	Description
T	document	The document to be indexed. Id will be inferred from (in order): 1. Id property set up on ConnectionSettings for TDocument 2. IdProperty property on OpenSearchTypeAttribute applied to TDocument 3. A property named Id on TDocument
CancellationToken	ct

Returns

Type	Description
Task<IndexResponse>

Type Parameters

Name	Description
T

IndexDocument<TDocument>(TDocument)

Adds or updates a typed JSON document in a specific index, making it searchable.

 

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

Declaration

IndexResponse IndexDocument<TDocument>(TDocument document) where TDocument : class

Parameters

Type	Name	Description
TDocument	document	The document to be indexed. Id will be inferred from (in order): 1. Id property set up on ConnectionSettings for TDocument 2. IdProperty property on OpenSearchTypeAttribute applied to TDocument 3. A property named Id on TDocument

Returns

Type	Description
IndexResponse

Type Parameters

Name	Description
TDocument	The document type used to infer the default index and id

Index<TDocument>(IIndexRequest<TDocument>)

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

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

Declaration

IndexResponse Index<TDocument>(IIndexRequest<TDocument> request) where TDocument : class

Parameters

Type	Name	Description
IIndexRequest<TDocument>	request

Returns

Type	Description
IndexResponse

Type Parameters

Name	Description
TDocument

Index<TDocument>(TDocument, Func<IndexDescriptor<TDocument>, IIndexRequest<TDocument>>)

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

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

Declaration

IndexResponse Index<TDocument>(TDocument document, Func<IndexDescriptor<TDocument>, IIndexRequest<TDocument>> selector) where TDocument : class

Parameters

Type	Name	Description
TDocument	document
Func<IndexDescriptor<TDocument>, IIndexRequest<TDocument>>	selector

Returns

Type	Description
IndexResponse

Type Parameters

Name	Description
TDocument

Map(IPutMappingRequest)

Declaration

PutMappingResponse Map(IPutMappingRequest request)

Parameters

Type	Name	Description
IPutMappingRequest	request

Returns

Type	Description
PutMappingResponse

MapAsync(IPutMappingRequest, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
IPutMappingRequest	request
CancellationToken	ct

Returns

Type	Description
Task<PutMappingResponse>

MapAsync<T>(Func<PutMappingDescriptor<T>, IPutMappingRequest>, CancellationToken)

Declaration

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

Parameters

Type	Name	Description
Func<PutMappingDescriptor<T>, IPutMappingRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<PutMappingResponse>

Type Parameters

Name	Description
T

Map<T>(Func<PutMappingDescriptor<T>, IPutMappingRequest>)

The put mapping API allows to register specific mapping definition for a specific type.

 

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

Declaration

PutMappingResponse Map<T>(Func<PutMappingDescriptor<T>, IPutMappingRequest> selector) where T : class

Parameters

Type	Name	Description
Func<PutMappingDescriptor<T>, IPutMappingRequest>	selector	A descriptor to describe the mapping of our type

Returns

Type	Description
PutMappingResponse

Type Parameters

Name	Description
T	The type we want to map in OpenSearch

MultiGet(IMultiGetRequest)

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

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

Declaration

MultiGetResponse MultiGet(IMultiGetRequest request)

Parameters

Type	Name	Description
IMultiGetRequest	request

Returns

Type	Description
MultiGetResponse

MultiGet(Func<MultiGetDescriptor, IMultiGetRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<MultiGetDescriptor, IMultiGetRequest>	selector

Returns

Type	Description
MultiGetResponse

MultiGetAsync(IMultiGetRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IMultiGetRequest	request
CancellationToken	ct

Returns

Type	Description
Task<MultiGetResponse>

MultiGetAsync(Func<MultiGetDescriptor, IMultiGetRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<MultiGetDescriptor, IMultiGetRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<MultiGetResponse>

MultiSearch(IMultiSearchRequest)

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

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

Declaration

MultiSearchResponse MultiSearch(IMultiSearchRequest request)

Parameters

Type	Name	Description
IMultiSearchRequest	request

Returns

Type	Description
MultiSearchResponse

MultiSearch(Indices, Func<MultiSearchDescriptor, IMultiSearchRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
Indices	index
Func<MultiSearchDescriptor, IMultiSearchRequest>	selector

Returns

Type	Description
MultiSearchResponse

MultiSearchAsync(IMultiSearchRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IMultiSearchRequest	request
CancellationToken	ct

Returns

Type	Description
Task<MultiSearchResponse>

MultiSearchAsync(Indices, Func<MultiSearchDescriptor, IMultiSearchRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Indices	index
Func<MultiSearchDescriptor, IMultiSearchRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<MultiSearchResponse>

MultiSearchTemplate(IMultiSearchTemplateRequest)

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

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

Declaration

MultiSearchResponse MultiSearchTemplate(IMultiSearchTemplateRequest request)

Parameters

Type	Name	Description
IMultiSearchTemplateRequest	request

Returns

Type	Description
MultiSearchResponse

MultiSearchTemplate(Indices, Func<MultiSearchTemplateDescriptor, IMultiSearchTemplateRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
Indices	index
Func<MultiSearchTemplateDescriptor, IMultiSearchTemplateRequest>	selector

Returns

Type	Description
MultiSearchResponse

MultiSearchTemplateAsync(IMultiSearchTemplateRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IMultiSearchTemplateRequest	request
CancellationToken	ct

Returns

Type	Description
Task<MultiSearchResponse>

MultiSearchTemplateAsync(Indices, Func<MultiSearchTemplateDescriptor, IMultiSearchTemplateRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Indices	index
Func<MultiSearchTemplateDescriptor, IMultiSearchTemplateRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<MultiSearchResponse>

MultiTermVectors(IMultiTermVectorsRequest)

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

https://opensearch.org/docs/latest

Declaration

MultiTermVectorsResponse MultiTermVectors(IMultiTermVectorsRequest request)

Parameters

Type	Name	Description
IMultiTermVectorsRequest	request

Returns

Type	Description
MultiTermVectorsResponse

MultiTermVectors(Func<MultiTermVectorsDescriptor, IMultiTermVectorsRequest>)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
Func<MultiTermVectorsDescriptor, IMultiTermVectorsRequest>	selector

Returns

Type	Description
MultiTermVectorsResponse

MultiTermVectorsAsync(IMultiTermVectorsRequest, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
IMultiTermVectorsRequest	request
CancellationToken	ct

Returns

Type	Description
Task<MultiTermVectorsResponse>

MultiTermVectorsAsync(Func<MultiTermVectorsDescriptor, IMultiTermVectorsRequest>, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
Func<MultiTermVectorsDescriptor, IMultiTermVectorsRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<MultiTermVectorsResponse>

Ping(IPingRequest)

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

https://opensearch.org/docs/latest

Declaration

PingResponse Ping(IPingRequest request)

Parameters

Type	Name	Description
IPingRequest	request

Returns

Type	Description
PingResponse

Ping(Func<PingDescriptor, IPingRequest>)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
Func<PingDescriptor, IPingRequest>	selector

Returns

Type	Description
PingResponse

PingAsync(IPingRequest, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
IPingRequest	request
CancellationToken	ct

Returns

Type	Description
Task<PingResponse>

PingAsync(Func<PingDescriptor, IPingRequest>, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
Func<PingDescriptor, IPingRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<PingResponse>

PutScript(IPutScriptRequest)

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

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

Declaration

PutScriptResponse PutScript(IPutScriptRequest request)

Parameters

Type	Name	Description
IPutScriptRequest	request

Returns

Type	Description
PutScriptResponse

PutScript(Id, Func<PutScriptDescriptor, IPutScriptRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
Id	id
Func<PutScriptDescriptor, IPutScriptRequest>	selector

Returns

Type	Description
PutScriptResponse

PutScriptAsync(IPutScriptRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IPutScriptRequest	request
CancellationToken	ct

Returns

Type	Description
Task<PutScriptResponse>

PutScriptAsync(Id, Func<PutScriptDescriptor, IPutScriptRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Id	id
Func<PutScriptDescriptor, IPutScriptRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<PutScriptResponse>

ReindexOnServer(IReindexOnServerRequest)

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

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

Declaration

ReindexOnServerResponse ReindexOnServer(IReindexOnServerRequest request)

Parameters

Type	Name	Description
IReindexOnServerRequest	request

Returns

Type	Description
ReindexOnServerResponse

ReindexOnServer(Func<ReindexOnServerDescriptor, IReindexOnServerRequest>)

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

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

Declaration

ReindexOnServerResponse ReindexOnServer(Func<ReindexOnServerDescriptor, IReindexOnServerRequest> selector)

Parameters

Type	Name	Description
Func<ReindexOnServerDescriptor, IReindexOnServerRequest>	selector

Returns

Type	Description
ReindexOnServerResponse

ReindexOnServerAsync(IReindexOnServerRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IReindexOnServerRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ReindexOnServerResponse>

ReindexOnServerAsync(Func<ReindexOnServerDescriptor, IReindexOnServerRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<ReindexOnServerDescriptor, IReindexOnServerRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ReindexOnServerResponse>

ReindexRethrottle(IReindexRethrottleRequest)

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

https://opensearch.org/docs/latest

Declaration

ReindexRethrottleResponse ReindexRethrottle(IReindexRethrottleRequest request)

Parameters

Type	Name	Description
IReindexRethrottleRequest	request

Returns

Type	Description
ReindexRethrottleResponse

ReindexRethrottle(TaskId, Func<ReindexRethrottleDescriptor, IReindexRethrottleRequest>)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
TaskId	taskId
Func<ReindexRethrottleDescriptor, IReindexRethrottleRequest>	selector

Returns

Type	Description
ReindexRethrottleResponse

ReindexRethrottleAsync(IReindexRethrottleRequest, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
IReindexRethrottleRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ReindexRethrottleResponse>

ReindexRethrottleAsync(TaskId, Func<ReindexRethrottleDescriptor, IReindexRethrottleRequest>, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
TaskId	taskId
Func<ReindexRethrottleDescriptor, IReindexRethrottleRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ReindexRethrottleResponse>

Reindex<TSource>(IReindexRequest<TSource>, CancellationToken)

Helper method that allows you to reindex from one index into another using ScrollAll and BulkAll.

Declaration

IObservable<BulkAllResponse> Reindex<TSource>(IReindexRequest<TSource> request, CancellationToken cancellationToken = default) where TSource : class

Parameters

Type	Name	Description
IReindexRequest<TSource>	request	a request object to describe the reindex operation
CancellationToken	cancellationToken

Returns

Type	Description
IObservable<BulkAllResponse>	An IObservable<ReindexResponse<T>$gt; you can subscribe to to listen to the progress of the reindex process

Type Parameters

Name	Description
TSource

Reindex<TSource>(IndexName, IndexName, Func<QueryContainerDescriptor<TSource>, QueryContainer>, CancellationToken)

Simplified form for reindex which will cover 80% of its use cases. Allows you to index all documents of type T from fromIndex to toIndex optionally limiting the documents found in fromIndex by using selector.

Declaration

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

Parameters

Type	Name	Description
IndexName	fromIndex	The source index, from which all types will be returned
IndexName	toIndex	The target index, if it does not exist already will be created using the same settings of fromIndex
Func<QueryContainerDescriptor<TSource>, QueryContainer>	selector	an optional query limiting the documents found in fromIndex
CancellationToken	cancellationToken

Returns

Type	Description
IObservable<BulkAllResponse>

Type Parameters

Name	Description
TSource

Reindex<TSource>(Func<ReindexDescriptor<TSource, TSource>, IReindexRequest<TSource, TSource>>, CancellationToken)

Helper method that allows you to reindex from one index into another using ScrollAll and BulkAll.

Declaration

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

Parameters

Type	Name	Description
Func<ReindexDescriptor<TSource, TSource>, IReindexRequest<TSource, TSource>>	selector
CancellationToken	cancellationToken

Returns

Type	Description
IObservable<BulkAllResponse>	An IObservable<ReindexResponse<T>$gt; you can subscribe to to listen to the progress of the reindex process

Type Parameters

Name	Description
TSource

Reindex<TSource, TTarget>(IReindexRequest<TSource, TTarget>, CancellationToken)

Helper method that allows you to reindex from one index into another using ScrollAll and BulkAll.

Declaration

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

Parameters

Type	Name	Description
IReindexRequest<TSource, TTarget>	request	a request object to describe the reindex operation
CancellationToken	cancellationToken

Returns

Type	Description
IObservable<BulkAllResponse>	An IObservable<ReindexResponse<T>$gt; you can subscribe to to listen to the progress of the reindex process

Type Parameters

Name	Description
TSource
TTarget

Reindex<TSource, TTarget>(IndexName, IndexName, Func<TSource, TTarget>, Func<QueryContainerDescriptor<TSource>, QueryContainer>, CancellationToken)

Simplified form for reindex which will cover 80% of its usecases. Allows you to index all documents of type T from fromIndex to toIndex optionally limiting the documents found in fromIndex by using selector.

Declaration

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

Parameters

Type	Name	Description
IndexName	fromIndex	The source index, from which all types will be returned
IndexName	toIndex	The target index, if it does not exist already will be created using the same settings of fromIndex
Func<TSource, TTarget>	mapper
Func<QueryContainerDescriptor<TSource>, QueryContainer>	selector	an optional query limiting the documents found in fromIndex
CancellationToken	cancellationToken

Returns

Type	Description
IObservable<BulkAllResponse>

Type Parameters

Name	Description
TSource
TTarget

Reindex<TSource, TTarget>(Func<TSource, TTarget>, Func<ReindexDescriptor<TSource, TTarget>, IReindexRequest<TSource, TTarget>>, CancellationToken)

Helper method that allows you to reindex from one index into another using ScrollAll and BulkAll.

Declaration

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

Parameters

Type	Name	Description
Func<TSource, TTarget>	mapper
Func<ReindexDescriptor<TSource, TTarget>, IReindexRequest<TSource, TTarget>>	selector
CancellationToken	cancellationToken

Returns

Type	Description
IObservable<BulkAllResponse>	An IObservable<ReindexResponse<T>$gt; you can subscribe to to listen to the progress of the reindex process

Type Parameters

Name	Description
TSource
TTarget

RenderSearchTemplate(IRenderSearchTemplateRequest)

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

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

Declaration

RenderSearchTemplateResponse RenderSearchTemplate(IRenderSearchTemplateRequest request)

Parameters

Type	Name	Description
IRenderSearchTemplateRequest	request

Returns

Type	Description
RenderSearchTemplateResponse

RenderSearchTemplate(Func<RenderSearchTemplateDescriptor, IRenderSearchTemplateRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<RenderSearchTemplateDescriptor, IRenderSearchTemplateRequest>	selector

Returns

Type	Description
RenderSearchTemplateResponse

RenderSearchTemplateAsync(IRenderSearchTemplateRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IRenderSearchTemplateRequest	request
CancellationToken	ct

Returns

Type	Description
Task<RenderSearchTemplateResponse>

RenderSearchTemplateAsync(Func<RenderSearchTemplateDescriptor, IRenderSearchTemplateRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<RenderSearchTemplateDescriptor, IRenderSearchTemplateRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<RenderSearchTemplateResponse>

RootNodeInfo(IRootNodeInfoRequest)

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

https://opensearch.org/docs/latest

Declaration

RootNodeInfoResponse RootNodeInfo(IRootNodeInfoRequest request)

Parameters

Type	Name	Description
IRootNodeInfoRequest	request

Returns

Type	Description
RootNodeInfoResponse

RootNodeInfo(Func<RootNodeInfoDescriptor, IRootNodeInfoRequest>)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
Func<RootNodeInfoDescriptor, IRootNodeInfoRequest>	selector

Returns

Type	Description
RootNodeInfoResponse

RootNodeInfoAsync(IRootNodeInfoRequest, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
IRootNodeInfoRequest	request
CancellationToken	ct

Returns

Type	Description
Task<RootNodeInfoResponse>

RootNodeInfoAsync(Func<RootNodeInfoDescriptor, IRootNodeInfoRequest>, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
Func<RootNodeInfoDescriptor, IRootNodeInfoRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<RootNodeInfoResponse>

ScrollAll<T>(IScrollAllRequest, CancellationToken)

Helper method that can parallelize a scroll using the sliced scroll feature of OpenSearch and return the results as an IObservable<T>.

Declaration

IObservable<ScrollAllResponse<T>> ScrollAll<T>(IScrollAllRequest request, CancellationToken cancellationToken = default) where T : class

Parameters

Type	Name	Description
IScrollAllRequest	request
CancellationToken	cancellationToken

Returns

Type	Description
IObservable<ScrollAllResponse<T>>

Type Parameters

Name	Description
T

ScrollAll<T>(Time, int, Func<ScrollAllDescriptor<T>, IScrollAllRequest>, CancellationToken)

Helper method that can parallelize a scroll using the sliced scroll feature of OpenSearch, and return the results as an IObservable<T>.

Declaration

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

Parameters

Type	Name	Description
Time	scrollTime	The time to keep the scroll active on the server until we send another scroll request
int	numberOfSlices	The number of slices to chop the scroll into, typically the number of shards but can be higher and using a custom routing key
Func<ScrollAllDescriptor<T>, IScrollAllRequest>	selector
CancellationToken	cancellationToken

Returns

Type	Description
IObservable<ScrollAllResponse<T>>

Type Parameters

Name	Description
T

ScrollAsync<TDocument>(IScrollRequest, CancellationToken)

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

https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods

Declaration

Task<ISearchResponse<TDocument>> ScrollAsync<TDocument>(IScrollRequest request, CancellationToken ct = default) where TDocument : class

Parameters

Type	Name	Description
IScrollRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ISearchResponse<TDocument>>

Type Parameters

Name	Description
TDocument

ScrollAsync<TDocument>(Time, string, Func<ScrollDescriptor<TDocument>, IScrollRequest>, CancellationToken)

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

https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods

Declaration

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

Parameters

Type	Name	Description
Time	scroll
string	scrollId
Func<ScrollDescriptor<TDocument>, IScrollRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ISearchResponse<TDocument>>

Type Parameters

Name	Description
TDocument

ScrollAsync<TInferDocument, TDocument>(Time, string, Func<ScrollDescriptor<TInferDocument>, IScrollRequest>, CancellationToken)

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

https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods

Declaration

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

Parameters

Type	Name	Description
Time	scroll
string	scrollId
Func<ScrollDescriptor<TInferDocument>, IScrollRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ISearchResponse<TDocument>>

Type Parameters

Name	Description
TInferDocument
TDocument

Scroll<TDocument>(IScrollRequest)

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

https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods

Declaration

ISearchResponse<TDocument> Scroll<TDocument>(IScrollRequest request) where TDocument : class

Parameters

Type	Name	Description
IScrollRequest	request

Returns

Type	Description
ISearchResponse<TDocument>

Type Parameters

Name	Description
TDocument

Scroll<TDocument>(Time, string, Func<ScrollDescriptor<TDocument>, IScrollRequest>)

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

https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods

Declaration

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

Parameters

Type	Name	Description
Time	scroll
string	scrollId
Func<ScrollDescriptor<TDocument>, IScrollRequest>	selector

Returns

Type	Description
ISearchResponse<TDocument>

Type Parameters

Name	Description
TDocument

Scroll<TInferDocument, TDocument>(Time, string, Func<ScrollDescriptor<TInferDocument>, IScrollRequest>)

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

https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods

Declaration

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

Parameters

Type	Name	Description
Time	scroll
string	scrollId
Func<ScrollDescriptor<TInferDocument>, IScrollRequest>	selector

Returns

Type	Description
ISearchResponse<TDocument>

Type Parameters

Name	Description
TInferDocument
TDocument

SearchAsync<TDocument>(ISearchRequest, CancellationToken)

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

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

Declaration

Task<ISearchResponse<TDocument>> SearchAsync<TDocument>(ISearchRequest request, CancellationToken ct = default) where TDocument : class

Parameters

Type	Name	Description
ISearchRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ISearchResponse<TDocument>>

Type Parameters

Name	Description
TDocument

SearchAsync<TDocument>(Func<SearchDescriptor<TDocument>, ISearchRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<SearchDescriptor<TDocument>, ISearchRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ISearchResponse<TDocument>>

Type Parameters

Name	Description
TDocument

SearchAsync<TInferDocument, TDocument>(Func<SearchDescriptor<TInferDocument>, ISearchRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<SearchDescriptor<TInferDocument>, ISearchRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ISearchResponse<TDocument>>

Type Parameters

Name	Description
TInferDocument
TDocument

SearchShards(ISearchShardsRequest)

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

https://opensearch.org/docs/latest

Declaration

SearchShardsResponse SearchShards(ISearchShardsRequest request)

Parameters

Type	Name	Description
ISearchShardsRequest	request

Returns

Type	Description
SearchShardsResponse

SearchShardsAsync(ISearchShardsRequest, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
ISearchShardsRequest	request
CancellationToken	ct

Returns

Type	Description
Task<SearchShardsResponse>

SearchShardsAsync<TDocument>(Func<SearchShardsDescriptor<TDocument>, ISearchShardsRequest>, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
Func<SearchShardsDescriptor<TDocument>, ISearchShardsRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<SearchShardsResponse>

Type Parameters

Name	Description
TDocument

SearchShards<TDocument>(Func<SearchShardsDescriptor<TDocument>, ISearchShardsRequest>)

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

https://opensearch.org/docs/latest

Declaration

SearchShardsResponse SearchShards<TDocument>(Func<SearchShardsDescriptor<TDocument>, ISearchShardsRequest> selector = null) where TDocument : class

Parameters

Type	Name	Description
Func<SearchShardsDescriptor<TDocument>, ISearchShardsRequest>	selector

Returns

Type	Description
SearchShardsResponse

Type Parameters

Name	Description
TDocument

SearchTemplateAsync<TDocument>(ISearchTemplateRequest, CancellationToken)

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

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

Declaration

Task<ISearchResponse<TDocument>> SearchTemplateAsync<TDocument>(ISearchTemplateRequest request, CancellationToken ct = default) where TDocument : class

Parameters

Type	Name	Description
ISearchTemplateRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ISearchResponse<TDocument>>

Type Parameters

Name	Description
TDocument

SearchTemplateAsync<TDocument>(Func<SearchTemplateDescriptor<TDocument>, ISearchTemplateRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<SearchTemplateDescriptor<TDocument>, ISearchTemplateRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ISearchResponse<TDocument>>

Type Parameters

Name	Description
TDocument

SearchTemplate<TDocument>(ISearchTemplateRequest)

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

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

Declaration

ISearchResponse<TDocument> SearchTemplate<TDocument>(ISearchTemplateRequest request) where TDocument : class

Parameters

Type	Name	Description
ISearchTemplateRequest	request

Returns

Type	Description
ISearchResponse<TDocument>

Type Parameters

Name	Description
TDocument

SearchTemplate<TDocument>(Func<SearchTemplateDescriptor<TDocument>, ISearchTemplateRequest>)

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

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

Declaration

ISearchResponse<TDocument> SearchTemplate<TDocument>(Func<SearchTemplateDescriptor<TDocument>, ISearchTemplateRequest> selector = null) where TDocument : class

Parameters

Type	Name	Description
Func<SearchTemplateDescriptor<TDocument>, ISearchTemplateRequest>	selector

Returns

Type	Description
ISearchResponse<TDocument>

Type Parameters

Name	Description
TDocument

Search<TDocument>(ISearchRequest)

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

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

Declaration

ISearchResponse<TDocument> Search<TDocument>(ISearchRequest request) where TDocument : class

Parameters

Type	Name	Description
ISearchRequest	request

Returns

Type	Description
ISearchResponse<TDocument>

Type Parameters

Name	Description
TDocument

Search<TDocument>(Func<SearchDescriptor<TDocument>, ISearchRequest>)

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

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

Declaration

ISearchResponse<TDocument> Search<TDocument>(Func<SearchDescriptor<TDocument>, ISearchRequest> selector = null) where TDocument : class

Parameters

Type	Name	Description
Func<SearchDescriptor<TDocument>, ISearchRequest>	selector

Returns

Type	Description
ISearchResponse<TDocument>

Type Parameters

Name	Description
TDocument

Search<TInferDocument, TDocument>(Func<SearchDescriptor<TInferDocument>, ISearchRequest>)

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

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

Declaration

ISearchResponse<TDocument> Search<TInferDocument, TDocument>(Func<SearchDescriptor<TInferDocument>, ISearchRequest> selector = null) where TInferDocument : class where TDocument : class

Parameters

Type	Name	Description
Func<SearchDescriptor<TInferDocument>, ISearchRequest>	selector

Returns

Type	Description
ISearchResponse<TDocument>

Type Parameters

Name	Description
TInferDocument
TDocument

SourceAsync<TDocument>(DocumentPath<TDocument>, Func<SourceDescriptor<TDocument>, ISourceRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<SourceDescriptor<TDocument>, ISourceRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<SourceResponse<TDocument>>

Type Parameters

Name	Description
TDocument

SourceAsync<TDocument>(ISourceRequest, CancellationToken)

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

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

Declaration

Task<SourceResponse<TDocument>> SourceAsync<TDocument>(ISourceRequest request, CancellationToken ct = default) where TDocument : class

Parameters

Type	Name	Description
ISourceRequest	request
CancellationToken	ct

Returns

Type	Description
Task<SourceResponse<TDocument>>

Type Parameters

Name	Description
TDocument

SourceExists(ISourceExistsRequest)

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

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

Declaration

ExistsResponse SourceExists(ISourceExistsRequest request)

Parameters

Type	Name	Description
ISourceExistsRequest	request

Returns

Type	Description
ExistsResponse

SourceExistsAsync(ISourceExistsRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
ISourceExistsRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ExistsResponse>

SourceExistsAsync<TDocument>(DocumentPath<TDocument>, Func<SourceExistsDescriptor<TDocument>, ISourceExistsRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<SourceExistsDescriptor<TDocument>, ISourceExistsRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ExistsResponse>

Type Parameters

Name	Description
TDocument

SourceExists<TDocument>(DocumentPath<TDocument>, Func<SourceExistsDescriptor<TDocument>, ISourceExistsRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<SourceExistsDescriptor<TDocument>, ISourceExistsRequest>	selector

Returns

Type	Description
ExistsResponse

Type Parameters

Name	Description
TDocument

Source<TDocument>(DocumentPath<TDocument>, Func<SourceDescriptor<TDocument>, ISourceRequest>)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<SourceDescriptor<TDocument>, ISourceRequest>	selector

Returns

Type	Description
SourceResponse<TDocument>

Type Parameters

Name	Description
TDocument

Source<TDocument>(ISourceRequest)

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

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

Declaration

SourceResponse<TDocument> Source<TDocument>(ISourceRequest request) where TDocument : class

Parameters

Type	Name	Description
ISourceRequest	request

Returns

Type	Description
SourceResponse<TDocument>

Type Parameters

Name	Description
TDocument

TermVectorsAsync<TDocument>(ITermVectorsRequest<TDocument>, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

Task<TermVectorsResponse> TermVectorsAsync<TDocument>(ITermVectorsRequest<TDocument> request, CancellationToken ct = default) where TDocument : class

Parameters

Type	Name	Description
ITermVectorsRequest<TDocument>	request
CancellationToken	ct

Returns

Type	Description
Task<TermVectorsResponse>

Type Parameters

Name	Description
TDocument

TermVectorsAsync<TDocument>(Func<TermVectorsDescriptor<TDocument>, ITermVectorsRequest<TDocument>>, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
Func<TermVectorsDescriptor<TDocument>, ITermVectorsRequest<TDocument>>	selector
CancellationToken	ct

Returns

Type	Description
Task<TermVectorsResponse>

Type Parameters

Name	Description
TDocument

TermVectors<TDocument>(ITermVectorsRequest<TDocument>)

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

https://opensearch.org/docs/latest

Declaration

TermVectorsResponse TermVectors<TDocument>(ITermVectorsRequest<TDocument> request) where TDocument : class

Parameters

Type	Name	Description
ITermVectorsRequest<TDocument>	request

Returns

Type	Description
TermVectorsResponse

Type Parameters

Name	Description
TDocument

TermVectors<TDocument>(Func<TermVectorsDescriptor<TDocument>, ITermVectorsRequest<TDocument>>)

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

https://opensearch.org/docs/latest

Declaration

TermVectorsResponse TermVectors<TDocument>(Func<TermVectorsDescriptor<TDocument>, ITermVectorsRequest<TDocument>> selector = null) where TDocument : class

Parameters

Type	Name	Description
Func<TermVectorsDescriptor<TDocument>, ITermVectorsRequest<TDocument>>	selector

Returns

Type	Description
TermVectorsResponse

Type Parameters

Name	Description
TDocument

UpdateAsync<TDocument>(DocumentPath<TDocument>, Func<UpdateDescriptor<TDocument, TDocument>, IUpdateRequest<TDocument, TDocument>>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<UpdateDescriptor<TDocument, TDocument>, IUpdateRequest<TDocument, TDocument>>	selector
CancellationToken	ct

Returns

Type	Description
Task<UpdateResponse<TDocument>>

Type Parameters

Name	Description
TDocument

UpdateAsync<TDocument, TPartialDocument>(DocumentPath<TDocument>, Func<UpdateDescriptor<TDocument, TPartialDocument>, IUpdateRequest<TDocument, TPartialDocument>>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<UpdateDescriptor<TDocument, TPartialDocument>, IUpdateRequest<TDocument, TPartialDocument>>	selector
CancellationToken	ct

Returns

Type	Description
Task<UpdateResponse<TDocument>>

Type Parameters

Name	Description
TDocument
TPartialDocument

UpdateAsync<TDocument, TPartialDocument>(IUpdateRequest<TDocument, TPartialDocument>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IUpdateRequest<TDocument, TPartialDocument>	request
CancellationToken	ct

Returns

Type	Description
Task<UpdateResponse<TDocument>>

Type Parameters

Name	Description
TDocument
TPartialDocument

UpdateByQuery(IUpdateByQueryRequest)

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

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

Declaration

UpdateByQueryResponse UpdateByQuery(IUpdateByQueryRequest request)

Parameters

Type	Name	Description
IUpdateByQueryRequest	request

Returns

Type	Description
UpdateByQueryResponse

UpdateByQueryAsync(IUpdateByQueryRequest, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
IUpdateByQueryRequest	request
CancellationToken	ct

Returns

Type	Description
Task<UpdateByQueryResponse>

UpdateByQueryAsync<TDocument>(Func<UpdateByQueryDescriptor<TDocument>, IUpdateByQueryRequest>, CancellationToken)

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

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

Declaration

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

Parameters

Type	Name	Description
Func<UpdateByQueryDescriptor<TDocument>, IUpdateByQueryRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<UpdateByQueryResponse>

Type Parameters

Name	Description
TDocument

UpdateByQueryRethrottle(IUpdateByQueryRethrottleRequest)

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

https://opensearch.org/docs/latest

Declaration

ListTasksResponse UpdateByQueryRethrottle(IUpdateByQueryRethrottleRequest request)

Parameters

Type	Name	Description
IUpdateByQueryRethrottleRequest	request

Returns

Type	Description
ListTasksResponse

UpdateByQueryRethrottle(TaskId, Func<UpdateByQueryRethrottleDescriptor, IUpdateByQueryRethrottleRequest>)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
TaskId	taskId
Func<UpdateByQueryRethrottleDescriptor, IUpdateByQueryRethrottleRequest>	selector

Returns

Type	Description
ListTasksResponse

UpdateByQueryRethrottleAsync(IUpdateByQueryRethrottleRequest, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
IUpdateByQueryRethrottleRequest	request
CancellationToken	ct

Returns

Type	Description
Task<ListTasksResponse>

UpdateByQueryRethrottleAsync(TaskId, Func<UpdateByQueryRethrottleDescriptor, IUpdateByQueryRethrottleRequest>, CancellationToken)

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

https://opensearch.org/docs/latest

Declaration

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

Parameters

Type	Name	Description
TaskId	taskId
Func<UpdateByQueryRethrottleDescriptor, IUpdateByQueryRethrottleRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<ListTasksResponse>

UpdateByQuery<TDocument>(Func<UpdateByQueryDescriptor<TDocument>, IUpdateByQueryRequest>)

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

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

Declaration

UpdateByQueryResponse UpdateByQuery<TDocument>(Func<UpdateByQueryDescriptor<TDocument>, IUpdateByQueryRequest> selector = null) where TDocument : class

Parameters

Type	Name	Description
Func<UpdateByQueryDescriptor<TDocument>, IUpdateByQueryRequest>	selector

Returns

Type	Description
UpdateByQueryResponse

Type Parameters

Name	Description
TDocument

Update<TDocument>(DocumentPath<TDocument>, Func<UpdateDescriptor<TDocument, TDocument>, IUpdateRequest<TDocument, TDocument>>)

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

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

Declaration

UpdateResponse<TDocument> Update<TDocument>(DocumentPath<TDocument> id, Func<UpdateDescriptor<TDocument, TDocument>, IUpdateRequest<TDocument, TDocument>> selector) where TDocument : class

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<UpdateDescriptor<TDocument, TDocument>, IUpdateRequest<TDocument, TDocument>>	selector

Returns

Type	Description
UpdateResponse<TDocument>

Type Parameters

Name	Description
TDocument

Update<TDocument, TPartialDocument>(DocumentPath<TDocument>, Func<UpdateDescriptor<TDocument, TPartialDocument>, IUpdateRequest<TDocument, TPartialDocument>>)

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

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

Declaration

UpdateResponse<TDocument> Update<TDocument, TPartialDocument>(DocumentPath<TDocument> id, Func<UpdateDescriptor<TDocument, TPartialDocument>, IUpdateRequest<TDocument, TPartialDocument>> selector) where TDocument : class where TPartialDocument : class

Parameters

Type	Name	Description
DocumentPath<TDocument>	id
Func<UpdateDescriptor<TDocument, TPartialDocument>, IUpdateRequest<TDocument, TPartialDocument>>	selector

Returns

Type	Description
UpdateResponse<TDocument>

Type Parameters

Name	Description
TDocument
TPartialDocument

Update<TDocument, TPartialDocument>(IUpdateRequest<TDocument, TPartialDocument>)

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

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

Declaration

UpdateResponse<TDocument> Update<TDocument, TPartialDocument>(IUpdateRequest<TDocument, TPartialDocument> request) where TDocument : class where TPartialDocument : class

Parameters

Type	Name	Description
IUpdateRequest<TDocument, TPartialDocument>	request

Returns

Type	Description
UpdateResponse<TDocument>

Type Parameters

Name	Description
TDocument
TPartialDocument

Extension Methods

AliasPointingToIndexExtensions.GetAliasesPointingToIndex(IOpenSearchClient, IndexName)

AliasPointingToIndexExtensions.GetAliasesPointingToIndexAsync(IOpenSearchClient, IndexName)

DeleteManyExtensions.DeleteManyAsync<T>(IOpenSearchClient, IEnumerable<T>, IndexName, CancellationToken)

DeleteManyExtensions.DeleteMany<T>(IOpenSearchClient, IEnumerable<T>, IndexName)

GetManyExtensions.GetManyAsync<T>(IOpenSearchClient, IEnumerable<long>, IndexName, CancellationToken)

GetManyExtensions.GetManyAsync<T>(IOpenSearchClient, IEnumerable<string>, IndexName, CancellationToken)

GetManyExtensions.GetMany<T>(IOpenSearchClient, IEnumerable<long>, IndexName)

GetManyExtensions.GetMany<T>(IOpenSearchClient, IEnumerable<string>, IndexName)

IndexManyExtensions.IndexManyAsync<T>(IOpenSearchClient, IEnumerable<T>, IndexName, CancellationToken)

IndexManyExtensions.IndexMany<T>(IOpenSearchClient, IEnumerable<T>, IndexName)

IndicesPointingToAliasExtensions.GetIndicesPointingToAlias(IOpenSearchClient, Names)

IndicesPointingToAliasExtensions.GetIndicesPointingToAliasAsync(IOpenSearchClient, Names)

SourceManyExtensions.SourceManyAsync<T>(IOpenSearchClient, IEnumerable<long>, string, CancellationToken)

SourceManyExtensions.SourceManyAsync<T>(IOpenSearchClient, IEnumerable<string>, string, CancellationToken)

SourceManyExtensions.SourceMany<T>(IOpenSearchClient, IEnumerable<long>, string)

SourceManyExtensions.SourceMany<T>(IOpenSearchClient, IEnumerable<string>, string)

SuffixExtensions.Suffix(object, string)